Package com.jidesoft.swing
Class AutoScroll
- java.lang.Object
-
- com.jidesoft.swing.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 Summary
Fields Modifier and Type Field Description protected boolean
_autoScrolling
protected int
_autoScrollInterval
protected java.awt.Component
_component
protected boolean
_hasEntered
protected int
_scrollDirection
protected javax.swing.Timer
_timer
protected boolean
_vertical
static java.lang.String
CLIENT_PROPERTY_AUTO_SCROLL
static int
SCROLL_DOWN
static int
SCROLL_LEFT
static int
SCROLL_RIGHT
static int
SCROLL_UP
-
Constructor Summary
Constructors Modifier Constructor Description protected
AutoScroll(java.awt.Component component)
protected
AutoScroll(java.awt.Component component, boolean vertical)
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract void
autoScrolling(int direction)
void
autoScrollingEnded(int direction)
void
autoScrollingStarted(int direction)
protected java.awt.event.MouseEvent
convertMouseEvent(java.awt.event.MouseEvent e)
static AutoScroll
getAutoScroll(java.awt.Component component)
Gets the AutoScroll installed on the component.int
getAutoScrollInterval()
int
getScrollDirection()
boolean
isAutoScrolling()
boolean
isComponentSelfScrollable()
boolean
isEnabled()
Checks if the AutoScroll is enabled.void
mouseDragged(java.awt.event.MouseEvent e)
void
mouseMoved(java.awt.event.MouseEvent e)
void
mousePressed(java.awt.event.MouseEvent e)
void
mouseReleased(java.awt.event.MouseEvent e)
void
setAutoScrollInterval(int autoScrollInterval)
void
setComponentSelfScrollable(boolean scrollable)
void
setEnabled(boolean enabled)
Enables or disables the AutoScroll feature.void
startAutoScrolling(int direction)
void
stopAutoScrolling()
This protected method is implementation specific and should be private.abstract void
updateSelectionForEvent(java.awt.event.MouseEvent e, boolean shouldScroll)
-
-
-
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
-
SCROLL_UP
public static final int SCROLL_UP
- See Also:
- Constant Field Values
-
SCROLL_DOWN
public static final int SCROLL_DOWN
- See Also:
- Constant Field Values
-
SCROLL_LEFT
public static final int SCROLL_LEFT
- See Also:
- Constant Field Values
-
SCROLL_RIGHT
public static final int SCROLL_RIGHT
- See Also:
- Constant Field Values
-
_component
protected java.awt.Component _component
-
_vertical
protected boolean _vertical
-
_autoScrollInterval
protected int _autoScrollInterval
-
-
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.
-
-