com.itmill.toolkit.terminal
Interface Scrollable

All Known Implementing Classes:

DebugWindow, FrameWindow, Panel, Window

public interface Scrollable

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

Since:

3.0

Version:

4.1.4

Author:

IT Mill Ltd.

Method Summary

int	getScrollOffsetX() Gets scroll X offset.
int	getScrollOffsetY() Gets scroll Y offset.
boolean	isScrollable() Is the scrolling enabled.
void	setScrollable(boolean isScrollingEnabled) Enables or disables scrolling..
void	setScrollOffsetX(int pixelsScrolledLeft) Sets scroll X offset.
void	setScrollOffsetY(int pixelsScrolledDown) Sets scroll Y offset.

Method Detail

getScrollOffsetX

int getScrollOffsetX()

Gets scroll X offset.

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

Returns:

Horizontal scrolling position in pixels.

setScrollOffsetX

void setScrollOffsetX(int pixelsScrolledLeft)

Sets scroll X offset.

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

Parameters:

pixelsScrolledLeft - the xOffset.

getScrollOffsetY

int getScrollOffsetY()

Gets scroll Y offset.

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

Returns:

Vertical scrolling position in pixels.

setScrollOffsetY

void setScrollOffsetY(int pixelsScrolledDown)

Sets scroll Y offset.

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

Parameters:

pixelsScrolledDown - the yOffset.

isScrollable

boolean isScrollable()

Is the scrolling enabled.

Enabling scrolling allows the user to scroll the scrollable view interactively

Returns:

true if the scrolling is allowed, otherwise false.

setScrollable

void setScrollable(boolean isScrollingEnabled)

Enables or disables scrolling..

Enabling scrolling allows the user to scroll the scrollable view interactively

Parameters:

isScrollingEnabled - true if the scrolling is allowed.