com.jidesoft.swing
Class AutoScroll

java.lang.Object
  com.jidesoft.swing.AutoScroll

public abstract class AutoScroll
extends 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

protected boolean	_autoScrolling
protected int	_autoScrollInterval
protected Component	_component
protected boolean	_hasEntered
protected int	_scrollDirection
protected Timer	_timer
protected boolean	_vertical
static String	CLIENT_PROPERTY_AUTO_SCROLL
static int	SCROLL_DOWN
static int	SCROLL_LEFT
static int	SCROLL_RIGHT
static int	SCROLL_UP

Constructor Summary

protected	AutoScroll(Component component)
protected	AutoScroll(Component component, boolean vertical)

Method Summary

abstract void	autoScrolling(int direction)
void	autoScrollingEnded(int direction)
void	autoScrollingStarted(int direction)
protected MouseEvent	convertMouseEvent(MouseEvent e)
static AutoScroll	getAutoScroll(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(MouseEvent e)
void	mouseMoved(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(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(MouseEvent e, boolean shouldScroll)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLIENT_PROPERTY_AUTO_SCROLL

public static final String CLIENT_PROPERTY_AUTO_SCROLL

See Also:

Constant Field Values

_timer

protected 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 Component _component

_vertical

protected boolean _vertical

_autoScrollInterval

protected int _autoScrollInterval

Constructor Detail

AutoScroll

protected AutoScroll(Component component)

AutoScroll

protected AutoScroll(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 MouseEvent convertMouseEvent(MouseEvent e)

mouseReleased

public void mouseReleased(MouseEvent e)

mousePressed

public void mousePressed(MouseEvent e)

mouseDragged

public void mouseDragged(MouseEvent e)

mouseMoved

public void mouseMoved(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(MouseEvent e,
                                             boolean shouldScroll)

getAutoScroll

public static AutoScroll getAutoScroll(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.