Class ScrollPanel

public class ScrollPanel
extends SimplePanel
A simple panel that wraps its contents in a scrollable area.

Constructors

ScrollPanel()Creates an empty scroll panel.
ScrollPanel(Widget)Creates a new scroll panel with the given child widget.

Methods

ensureVisible(UIObject)Ensures that the specified item is visible, by adjusting the panel's scroll position.
getScrollPosition()Gets the vertical scroll position.
setAlwaysShowScrollBars(boolean)Sets whether this panel always shows its scroll bars, or only when necessary.
setScrollPosition(int)Sets the vertical scroll position.

Constructor Detail

ScrollPanel

public ScrollPanel()
Creates an empty scroll panel.

ScrollPanel

public ScrollPanel(Widget child)
Creates a new scroll panel with the given child widget.

Parameters

child
the widget to be wrapped by the scroll panel

Method Detail

ensureVisible

public void ensureVisible(UIObject item)
Ensures that the specified item is visible, by adjusting the panel's scroll position.

Parameters

item
the item whose visibility is to be ensured

getScrollPosition

public int getScrollPosition()
Gets the vertical scroll position.

Return Value

the vertical scroll position, in pixels

setAlwaysShowScrollBars

public void setAlwaysShowScrollBars(boolean alwaysShow)
Sets whether this panel always shows its scroll bars, or only when necessary.

Parameters

alwaysShow
true to show scroll bars at all times

setScrollPosition

public void setScrollPosition(int position)
Sets the vertical scroll position.

Parameters

position
the new vertical scroll position, in pixels