com.itmill.toolkit.terminal
Interface Scrollable

All Known Implementing Classes:
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:
5.3.0
Author:
IT Mill Ltd.

Method Summary
 int getScrollLeft()
          Gets scroll left offset.
 int getScrollTop()
          Gets scroll top offset.
 boolean isScrollable()
          Is the scrolling enabled.
 void setScrollable(boolean isScrollingEnabled)
          Enables or disables scrolling..
 void setScrollLeft(int pixelsScrolled)
          Sets scroll left offset.
 void setScrollTop(int pixelsScrolled)
          Sets scroll top offset.
 

Method Detail

getScrollLeft

int getScrollLeft()
Gets scroll left offset.

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

Returns:
Horizontal scrolling position in pixels.

setScrollLeft

void setScrollLeft(int pixelsScrolled)
Sets scroll left offset.

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

Parameters:
pixelsScrolled - the xOffset.

getScrollTop

int getScrollTop()
Gets scroll top offset.

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

Returns:
Vertical scrolling position in pixels.

setScrollTop

void setScrollTop(int pixelsScrolled)
Sets scroll top offset.

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

Parameters:
pixelsScrolled - 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.


Copyright © 2000-2009 IT Mill Ltd. All Rights Reserved.