org.millstone.base.terminal
Interface Scrollable

All Known Implementing Classes:

Panel

public interface Scrollable

Scrollable interface.

This interface is implemented by all visual objects that can be scrolled. The unit of scrolling is pixel.

Since:

3.0

Version:

3.0.3

Author:

IT Mill Ltd.

Method Summary

int	getScrollOffsetX() Get scroll X offset.
int	getScrollOffsetY() Get scroll Y offset.
boolean	isScrollable() Is the scrolling enabled.
void	setScrollable(boolean isScrollingEnabled) Enable or disable scrolling..
void	setScrollOffsetX(int pixelsScrolledLeft) Set scroll X offset.
void	setScrollOffsetY(int pixelsScrolledDown) Set scroll Y offset.

Method Detail

getScrollOffsetX

public int getScrollOffsetX()

Get scroll X offset.

Scrolling offset is the number of pixels this scrollable has been scrolled to left.

Returns:

Horizontal scrolling position in pixels.

setScrollOffsetX

public void setScrollOffsetX(int pixelsScrolledLeft)

Set scroll X offset.

Scrolling offset is the number of pixels this scrollable has been scrolled to left.

getScrollOffsetY

public int getScrollOffsetY()

Get scroll Y offset.

Scrolling offset is the number of pixels this scrollable has been scrolled to down.

Returns:

Vertical scrolling position in pixels.

setScrollOffsetY

public void setScrollOffsetY(int pixelsScrolledDown)

Set scroll Y offset.

Scrolling offset is the number of pixels this scrollable has been scrolled to down.

isScrollable

public boolean isScrollable()

Is the scrolling enabled.

Enabling scrolling allows the user to scroll the scrollable view interactively

Returns:

True iff the scrolling is allowed.

setScrollable

public void setScrollable(boolean isScrollingEnabled)

Enable or disable scrolling..

Enabling scrolling allows the user to scroll the scrollable view interactively

Parameters:

isScrollingEnabled - True iff the scrolling is allowed.