Interface Scrollable

All Superinterfaces:

Serializable

All Known Implementing Classes:

Panel, Window

public interface Scrollable
extends Serializable

This interface is implemented by all visual objects that can be scrolled programmatically from the server-side, or for which it is possible to know the scroll position on the server-side. The unit of scrolling is pixel.

Since:

3.0

Version:

6.8.18

Author:

Vaadin Ltd.

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.

The method only has effect if programmatic scrolling is enabled for the scrollable. Some implementations may require enabling programmatic before this method can be used. See setScrollable(boolean) for more information.

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.

The method only has effect if programmatic scrolling is enabled for the scrollable. Some implementations may require enabling programmatic before this method can be used. See setScrollable(boolean) for more information.

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:

pixelsScrolled - the yOffset.

isScrollable

boolean isScrollable()

Is programmatic scrolling enabled.

Whether programmatic scrolling with setScrollLeft(int) and setScrollTop(int) is enabled.

Returns:

true if the scrolling is enabled, otherwise false.

setScrollable

void setScrollable(boolean isScrollingEnabled)

Enables or disables programmatic scrolling.

Enables setting the scroll position with setScrollLeft(int) and setScrollTop(int). Implementations of the interface may have programmatic scrolling disabled by default, in which case you need to enable it to use the mentioned methods.

Notice that this does not control whether scroll bars are shown for a scrollable component. That normally happens automatically when the content grows too big for the component, relying on the "overflow: auto" property in CSS.

Parameters:

isScrollingEnabled - true if the scrolling is allowed.