Package com.jidesoft.swing

Class AutoScroll

  • public abstract class AutoScroll
extends java.lang.Object
    Please note: we are still polishing this class and may change the public interface in the future. Please do not use it for now until we remove this notice. You may choose to use it as long as you don't complain when you find your code won't compile after upgrading to a new JIDE release.

    • Field Detail

      • CLIENT_PROPERTY_AUTO_SCROLL

        public static final java.lang.String CLIENT_PROPERTY_AUTO_SCROLL
        See Also:
        Constant Field Values

      • _timer

        protected javax.swing.Timer _timer

      • _autoScrolling

        protected boolean _autoScrolling

      • _scrollDirection

        protected int _scrollDirection

      • _hasEntered

        protected boolean _hasEntered

      • _component

        protected java.awt.Component _component

      • _vertical

        protected boolean _vertical

      • _autoScrollInterval

        protected int _autoScrollInterval

    • Constructor Detail

      • AutoScroll

        protected AutoScroll​(java.awt.Component component)

      • AutoScroll

        protected AutoScroll​(java.awt.Component component,
                     boolean vertical)

    • Method Detail

      • getAutoScrollInterval

        public int getAutoScrollInterval()

      • setAutoScrollInterval

        public void setAutoScrollInterval​(int autoScrollInterval)

      • isEnabled

        public boolean isEnabled()
        Checks if the AutoScroll is enabled.
        Returns:
        true if enabled. Otherwise false.

      • setEnabled

        public void setEnabled​(boolean enabled)
        Enables or disables the AutoScroll feature.
        Parameters:
        enabled - true or false.

      • startAutoScrolling

        public void startAutoScrolling​(int direction)

      • stopAutoScrolling

        public void stopAutoScrolling()
        This protected method is implementation specific and should be private. do not call or override.

      • isAutoScrolling

        public boolean isAutoScrolling()

      • getScrollDirection

        public int getScrollDirection()

      • isComponentSelfScrollable

        public boolean isComponentSelfScrollable()

      • setComponentSelfScrollable

        public void setComponentSelfScrollable​(boolean scrollable)

      • convertMouseEvent

        protected java.awt.event.MouseEvent convertMouseEvent​(java.awt.event.MouseEvent e)

      • mouseReleased

        public void mouseReleased​(java.awt.event.MouseEvent e)

      • mousePressed

        public void mousePressed​(java.awt.event.MouseEvent e)

      • mouseDragged

        public void mouseDragged​(java.awt.event.MouseEvent e)

      • mouseMoved

        public void mouseMoved​(java.awt.event.MouseEvent e)

      • autoScrollingStarted

        public void autoScrollingStarted​(int direction)

      • autoScrollingEnded

        public void autoScrollingEnded​(int direction)

      • autoScrolling

        public abstract void autoScrolling​(int direction)

      • updateSelectionForEvent

        public abstract void updateSelectionForEvent​(java.awt.event.MouseEvent e,
                                             boolean shouldScroll)

      • getAutoScroll

        public static AutoScroll getAutoScroll​(java.awt.Component component)
        Gets the AutoScroll installed on the component. Null is no AutoScroll was installed.
        Parameters:
        component - the component
        Returns:
        the AutoScroll installed. Null is no AutoScroll was installed.