com.vaadin.server

Interface Scrollable

All Superinterfaces:

Serializable

All Known Implementing Classes:

ColorPickerPopup, Panel, Window

public interface Scrollable
extends Serializable

This interface is implemented by all visual objects that can be scrolled programmatically from the server-side. The unit of scrolling is pixel.

Since:

3.0

Author:

Vaadin Ltd.

Method Summary

Modifier and Type	Method and Description
int	getScrollLeft() Gets scroll left offset.
int	getScrollTop() Gets scroll top offset.
void	setScrollLeft(int scrollLeft) Sets scroll left offset.
void	setScrollTop(int scrollTop) 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 scrollLeft)

Sets scroll left offset.

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

Parameters:

scrollLeft - 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 scrollTop)

Sets scroll top offset.

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

The scrolling position is limited by the current height of the content area. If the position is below the height, it is scrolled to the bottom. However, if the same response also adds height to the content area, scrolling to bottom only scrolls to the bottom of the previous content area.

Parameters:

scrollTop - the yOffset.