com.sas.visuals
Interface ScrollingInterface

All Known Implementing Classes:

TableView, TreeView, TreeView

public interface ScrollingInterface

ScrollingInterface defines a set of methods and constants for objects that support scrolling. This way all participating scrollable objects can be scrolled in a consistent manner.

Field Summary

static int	SCROLL_BLOCK
static int	SCROLL_COLUMN
static int	SCROLL_ELEMENT
static int	SCROLL_HALF_PAGE
static int	SCROLL_MAXIMUM
static int	SCROLL_PAGE
static int	SCROLL_PIXEL
static int	SCROLL_ROW

Method Summary

void	scrollHorizontally(int numUnits, int unit) Scrolls horizontally.
void	scrollVertically(int numUnits, int unit) Scrolls vertically.

Field Detail

SCROLL_PAGE

static final int SCROLL_PAGE

See Also:

Constant Field Values

SCROLL_BLOCK

static final int SCROLL_BLOCK

See Also:

Constant Field Values

SCROLL_HALF_PAGE

static final int SCROLL_HALF_PAGE

See Also:

Constant Field Values

SCROLL_MAXIMUM

static final int SCROLL_MAXIMUM

See Also:

Constant Field Values

SCROLL_ELEMENT

static final int SCROLL_ELEMENT

See Also:

Constant Field Values

SCROLL_COLUMN

static final int SCROLL_COLUMN

See Also:

Constant Field Values

SCROLL_ROW

static final int SCROLL_ROW

See Also:

Constant Field Values

SCROLL_PIXEL

static final int SCROLL_PIXEL

See Also:

Constant Field Values

Method Detail

scrollHorizontally

void scrollHorizontally(int numUnits,
                        int unit)

Scrolls horizontally.

Parameters:

numUnits - Indicates the direction and amount to scroll. A positive number scrolls forward (right). A negative number scrolls backward (left). It is recommended that over-scrolls (e.g. scroll (5, PAGE) when there are only 2 pages) be quietly handled.

unit - Indicates how to interpret numUnits. Must be one of the predefined scroll amount constants. Every implementation will not support every unique unit value, throw an IllegalArgumentException for those that aren't supported.

scrollVertically

void scrollVertically(int numUnits,
                      int unit)

Scrolls vertically.

Parameters:

numUnits - Indicates the direction and amount to scroll. A positive number scrolls forward (down). A negative number scrolls backward (up). It is recommended that over-scrolls (e.g. scroll (5, PAGE) when there are only 2 pages) be quietly handled.

unit - Indicates how to interpret numUnits. Must be one of the predefined scroll amount constants. Every implementation will not support every unique unit value, throw an IllegalArgumentException for those that aren't supported.