public class

ScrollPanel

extends SimplePanel
implements HasScrollHandlers ProvidesResize RequiresResize SourcesScrollEvents

java.lang.Object
↳	com.google.gwt.user.client.ui.UIObject
	↳	com.google.gwt.user.client.ui.Widget
		↳	com.google.gwt.user.client.ui.Panel
			↳	com.google.gwt.user.client.ui.SimplePanel
				↳	com.google.gwt.user.client.ui.ScrollPanel

Class Overview

A simple panel that wraps its contents in a scrollable area.

Summary

[Expand]

Inherited Constants

From class com.google.gwt.user.client.ui.UIObject

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

Public Methods
HandlerRegistration	addScrollHandler(ScrollHandler handler) Adds a `ScrollEvent` handler.
void	addScrollListener(ScrollListener listener) This method is deprecated. Use `addScrollHandler(ScrollHandler)` instead
void	ensureVisible(UIObject item) Ensures that the specified item is visible, by adjusting the panel's scroll position.
int	getHorizontalScrollPosition() Gets the horizontal scroll position.
int	getScrollPosition() Gets the vertical scroll position.
void	onResize() This method must be called whenever the implementor's size has been modified.
void	removeScrollListener(ScrollListener listener) This method is deprecated. Use the `removeHandler()` method on the object returned by `addScrollHandler(ScrollHandler)` instead
void	scrollToBottom() Scroll to the bottom of this panel.
void	scrollToLeft() Scroll to the far left of this panel.
void	scrollToRight() Scroll to the far right of this panel.
void	scrollToTop() Scroll to the top of this panel.
void	setAlwaysShowScrollBars(boolean alwaysShow) Sets whether this panel always shows its scroll bars, or only when necessary.
void	setHeight(String height) Sets the object's height.
void	setHorizontalScrollPosition(int position) Sets the horizontal scroll position.
void	setScrollPosition(int position) Sets the vertical scroll position.
void	setSize(String width, String height) Sets the object's size.
void	setWidth(String width) Sets the object's width.

Protected Methods
Element	getContainerElement() Override this method to specify that an element other than the root element be the container for the panel's child widget.

[Expand]

Inherited Methods

From class com.google.gwt.user.client.ui.SimplePanel

From class com.google.gwt.user.client.ui.Panel

void	add(IsWidget child)
void	add(Widget child) Adds a child widget.
final void	adopt(Widget child) Finalize the attachment of a Widget to this Panel.
void	adopt(Widget w, Element container) This method is deprecated. Use `adopt(Widget)`.
void	clear() Removes all child widgets.
void	disown(Widget w) This method is deprecated. Use `orphan(Widget)`.
void	doAttachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onAttach()` for each of its child widgets.
void	doDetachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onDetach()` for each of its child widgets.
final void	orphan(Widget child) This method must be called as part of the remove method of any Panel.
abstract boolean	remove(Widget child) Removes a child widget.
boolean	remove(IsWidget child)

From class com.google.gwt.user.client.ui.Widget

HandlerRegistration	addAttachHandler(AttachEvent.Handler handler) Adds an `AttachEvent` handler.
final <H extends EventHandler> HandlerRegistration	addDomHandler(H handler, Type<H> type) Adds a native event handler to the widget and sinks the corresponding native event.
final <H extends EventHandler> HandlerRegistration	addHandler(H handler, Type<H> type) Adds this handler to the widget.
Widget	asWidget() Returns the `Widget` aspect of the receiver.
static Widget	asWidgetOrNull(IsWidget w) This convenience method makes a null-safe call to `asWidget()`.
HandlerManager	createHandlerManager() Creates the `HandlerManager` used by this Widget.
void	delegateEvent(Widget target, GwtEvent<?> event) Fires an event on a child widget.
void	doAttachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onAttach()` for each of its child widgets.
void	doDetachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onDetach()` for each of its child widgets.
void	fireEvent(GwtEvent<?> event) Fires the given event to the handlers listening to the event's type.
int	getHandlerCount(Type<?> type) Gets the number of handlers listening to the event type.
Object	getLayoutData() Gets the panel-defined layout data associated with this widget.
Widget	getParent() Gets this widget's parent panel.
boolean	isAttached() Determines whether this widget is currently attached to the browser's document (i.e., there is an unbroken chain of widgets between this widget and the underlying browser document).
final boolean	isOrWasAttached() Has this widget ever been attached?
void	onAttach() This method is called when a widget is attached to the browser's document.
void	onBrowserEvent(Event event) Fired whenever a browser event is received.
void	onDetach() This method is called when a widget is detached from the browser's document.
void	onLoad() This method is called immediately after a widget becomes attached to the browser's document.
void	onUnload() This method is called immediately before a widget will be detached from the browser's document.
void	removeFromParent() Removes this widget from its parent widget, if one exists.
void	setLayoutData(Object layoutData) Sets the panel-defined layout data associated with this widget.
void	sinkEvents(int eventBitsToAdd) Overridden to defer the call to super.sinkEvents until the first time this widget is attached to the dom, as a performance enhancement.

From class com.google.gwt.user.client.ui.UIObject

void	addStyleDependentName(String styleSuffix) Adds a dependent style name by specifying the style name's suffix.
void	addStyleName(String style) Adds a secondary or dependent style name to this object.
static void	ensureDebugId(Element elem, String baseID, String id) Set the debug id of a specific element.
final void	ensureDebugId(String id) Ensure that the main `Element` for this `UIObject` has an ID property set, which allows it to integrate with third-party libraries and test tools.
static void	ensureDebugId(Element elem, String id) Ensure that elem has an ID property set, which allows it to integrate with third-party libraries and test tools.
int	getAbsoluteLeft() Gets the object's absolute left position in pixels, as measured from the browser window's client area.
int	getAbsoluteTop() Gets the object's absolute top position in pixels, as measured from the browser window's client area.
Element	getElement() Gets a handle to the object's underlying DOM element.
int	getOffsetHeight() Gets the object's offset height in pixels.
int	getOffsetWidth() Gets the object's offset width in pixels.
Element	getStyleElement() Template method that returns the element to which style names will be applied.
String	getStyleName() Gets all of the object's style names, as a space-separated list.
static String	getStyleName(Element elem) Gets all of the element's style names, as a space-separated list.
String	getStylePrimaryName() Gets the primary style name associated with the object.
static String	getStylePrimaryName(Element elem) Gets the element's primary style name.
String	getTitle() Gets the title associated with this object.
boolean	isVisible() Determines whether or not this object is visible.
static boolean	isVisible(Element elem)
void	onEnsureDebugId(String baseID) Called when the user sets the id using the `ensureDebugId(String)` method.
void	removeStyleDependentName(String styleSuffix) Removes a dependent style name by specifying the style name's suffix.
void	removeStyleName(String style) Removes a style name.
final void	setElement(Element elem) Sets this object's browser element.
void	setElement(Element elem) Sets this object's browser element.
void	setHeight(String height) Sets the object's height.
void	setPixelSize(int width, int height) Sets the object's size, in pixels, not including decorations such as border, margin, and padding.
void	setSize(String width, String height) Sets the object's size.
void	setStyleDependentName(String styleSuffix, boolean add) Adds or removes a dependent style name by specifying the style name's suffix.
static void	setStyleName(Element elem, String styleName) Clears all of the element's style names and sets it to the given style.
static void	setStyleName(Element elem, String style, boolean add) This convenience method adds or removes a style name for a given element.
void	setStyleName(String style) Clears all of the object's style names and sets it to the given style.
void	setStyleName(String style, boolean add) Adds or removes a style name.
void	setStylePrimaryName(String style) Sets the object's primary style name and updates all dependent style names.
static void	setStylePrimaryName(Element elem, String style) Sets the element's primary style name and updates all dependent style names.
void	setTitle(String title) Sets the title associated with this object.
void	setVisible(boolean visible) Sets whether this object is visible.
static void	setVisible(Element elem, boolean visible)
void	setWidth(String width) Sets the object's width.
void	sinkEvents(int eventBitsToAdd) Adds a set of events to be sunk by this object.
String	toString() This method is overridden so that any object can be viewed in the debugger as an HTML snippet.
void	unsinkEvents(int eventBitsToRemove) Removes a set of events from this object's event list.

From class java.lang.Object

From interface com.google.gwt.event.dom.client.HasScrollHandlers

From interface com.google.gwt.event.logical.shared.HasAttachHandlers

From interface com.google.gwt.event.shared.HasHandlers

From interface com.google.gwt.user.client.EventListener

From interface com.google.gwt.user.client.ui.AcceptsOneWidget

From interface com.google.gwt.user.client.ui.HasOneWidget

From interface com.google.gwt.user.client.ui.HasWidgets

From interface com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

From interface com.google.gwt.user.client.ui.IsWidget

From interface com.google.gwt.user.client.ui.RequiresResize

From interface com.google.gwt.user.client.ui.SourcesScrollEvents

From interface java.lang.Iterable

Public Constructors

public ScrollPanel ()

Creates an empty scroll panel.

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

Public Methods

public HandlerRegistration addScrollHandler (ScrollHandler handler)

Adds a ScrollEvent handler.

Parameters

handler	the scroll handler

Returns

HandlerRegistration used to remove this handler

public void addScrollListener (ScrollListener listener)

This method is deprecated.
Use addScrollHandler(ScrollHandler) instead

Adds a listener interface to receive scroll events.

Parameters

listener	the listener interface to add

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

public int getHorizontalScrollPosition ()

Gets the horizontal scroll position.

Returns

the horizontal scroll position, in pixels

public int getScrollPosition ()

Gets the vertical scroll position.

Returns

the vertical scroll position, in pixels

public void onResize ()

This method must be called whenever the implementor's size has been modified.

public void removeScrollListener (ScrollListener listener)

This method is deprecated.
Use the removeHandler() method on the object returned by addScrollHandler(ScrollHandler) instead

Removes a previously added scroll listener.

Parameters

listener	the listener interface to remove

public void scrollToBottom ()

Scroll to the bottom of this panel.

public void scrollToLeft ()

Scroll to the far left of this panel.

public void scrollToRight ()

Scroll to the far right of this panel.

public void scrollToTop ()

Scroll to the top of this panel.

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

public void setHeight (String height)

Sets the object's height. This height does not include decorations such as border, margin, and padding.

Parameters

height	the object's new height, in absolute CSS units (e.g. "10px", "1em" but not "50%")

public void setHorizontalScrollPosition (int position)

Sets the horizontal scroll position.

Parameters

position	the new horizontal scroll position, in pixels

public void setScrollPosition (int position)

Sets the vertical scroll position.

Parameters

position	the new vertical scroll position, in pixels

public void setSize (String width, String height)

Sets the object's size. This size does not include decorations such as border, margin, and padding.

Parameters

width	the object's new width, in absolute CSS units (e.g. "10px", "1em", but not "50%")
height	the object's new height, in absolute CSS units (e.g. "10px", "1em", but not "50%")

public void setWidth (String width)

Sets the object's width. This width does not include decorations such as border, margin, and padding.

Parameters

width	the object's new width, in absolute CSS units (e.g. "10px", "1em", but not "50%")

Protected Methods

protected Element getContainerElement ()

Override this method to specify that an element other than the root element be the container for the panel's child widget. This can be useful when you want to create a simple panel that decorates its contents. Note that this method continues to return the Element class defined in the User module to maintain backwards compatibility.

Returns

the element to be used as the panel's container

Interfaces

Classes

Annotations

Enums

Exceptions

ScrollPanel

Class Overview

Summary

Public Constructors

public ScrollPanel ()

public ScrollPanel (Widget child)

Parameters

Public Methods

public HandlerRegistration addScrollHandler (ScrollHandler handler)

Parameters

Returns

public void addScrollListener (ScrollListener listener)

Parameters

public void ensureVisible (UIObject item)

Parameters

public int getHorizontalScrollPosition ()

Returns

public int getScrollPosition ()

Returns

public void onResize ()

public void removeScrollListener (ScrollListener listener)

Parameters

public void scrollToBottom ()

public void scrollToLeft ()

public void scrollToRight ()

public void scrollToTop ()

public void setAlwaysShowScrollBars (boolean alwaysShow)

Parameters

public void setHeight (String height)

Parameters

public void setHorizontalScrollPosition (int position)

Parameters

public void setScrollPosition (int position)

Parameters

public void setSize (String width, String height)

Parameters

public void setWidth (String width)

Parameters

Protected Methods

protected Element getContainerElement ()

Returns