Package com.jidesoft.swing
Class AutoScroll
java.lang.Object
com.jidesoft.swing.AutoScroll
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 Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
AutoScroll
(Component component) protected
AutoScroll
(Component component, boolean vertical) -
Method Summary
Modifier and TypeMethodDescriptionabstract void
autoScrolling
(int direction) void
autoScrollingEnded
(int direction) void
autoScrollingStarted
(int direction) protected MouseEvent
static AutoScroll
getAutoScroll
(Component component) Gets the AutoScroll installed on the component.int
int
boolean
boolean
boolean
Checks if the AutoScroll is enabled.void
void
void
void
void
setAutoScrollInterval
(int autoScrollInterval) void
setComponentSelfScrollable
(boolean scrollable) void
setEnabled
(boolean enabled) Enables or disables the AutoScroll feature.void
startAutoScrolling
(int direction) void
This protected method is implementation specific and should be private.abstract void
updateSelectionForEvent
(MouseEvent e, boolean shouldScroll)
-
Field Details
-
CLIENT_PROPERTY_AUTO_SCROLL
- See Also:
-
_timer
-
_autoScrolling
protected boolean _autoScrolling -
_scrollDirection
protected int _scrollDirection -
_hasEntered
protected boolean _hasEntered -
SCROLL_UP
public static final int SCROLL_UP- See Also:
-
SCROLL_DOWN
public static final int SCROLL_DOWN- See Also:
-
SCROLL_LEFT
public static final int SCROLL_LEFT- See Also:
-
SCROLL_RIGHT
public static final int SCROLL_RIGHT- See Also:
-
_component
-
_vertical
protected boolean _vertical -
_autoScrollInterval
protected int _autoScrollInterval
-
-
Constructor Details
-
AutoScroll
-
AutoScroll
-
-
Method Details
-
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
-
mouseReleased
-
mousePressed
-
mouseDragged
-
mouseMoved
-
autoScrollingStarted
public void autoScrollingStarted(int direction) -
autoScrollingEnded
public void autoScrollingEnded(int direction) -
autoScrolling
public abstract void autoScrolling(int direction) -
updateSelectionForEvent
-
getAutoScroll
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.
-