public class

StackPanel

extends ComplexPanel
implements InsertPanel.ForIsWidget

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.ComplexPanel
				↳	com.google.gwt.user.client.ui.StackPanel

Known Direct Subclasses

DecoratedStackPanel

Class Overview

A panel that stacks its children vertically, displaying only one at a time, with a header for each child which the user can click to display.

This widget will only work in quirks mode. If your application is in Standards Mode, use StackLayoutPanel instead.

CSS Style Rules

.gwt-StackPanel { the panel itself }
.gwt-StackPanel .gwt-StackPanelItem { unselected items }
.gwt-StackPanel .gwt-StackPanelItem-selected { selected items }
.gwt-StackPanel .gwt-StackPanelContent { the wrapper around the contents of the item }

Example

{@example com.google.gwt.examples.StackPanelExample}

Summary

[Expand]

Inherited Constants

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

Public Constructors
	StackPanel() Creates an empty stack panel.

Public Methods
void	add(Widget w, SafeHtml stackHtml) Adds a new child with the given widget and header, optionally interpreting the header as HTML.
void	add(Widget w, String stackText) Adds a new child with the given widget and header.
void	add(Widget w, String stackText, boolean asHTML) Adds a new child with the given widget and header, optionally interpreting the header as HTML.
void	add(Widget w) Adds a child widget.
int	getSelectedIndex() Gets the currently selected child index.
void	insert(IsWidget w, int beforeIndex)
void	insert(Widget w, int beforeIndex) Inserts a child widget before the specified index.
void	onBrowserEvent(Event event) Fired whenever a browser event is received.
boolean	remove(Widget child) Removes a child widget.
boolean	remove(int index) Removes the widget at the specified index.
void	setStackText(int index, String text, boolean asHTML) Sets the text associated with a child by its index.
void	setStackText(int index, String text) Sets the text associated with a child by its index.
void	setStackText(int index, SafeHtml html) Sets the html associated with a child by its index.
void	showStack(int index) Shows the widget at the specified child index.

Protected Methods
void	onEnsureDebugId(String baseID) Affected Elements: -text# = The element around the header at the specified index.

[Expand]

Inherited Methods

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

void	add(Widget child, Element container) Adds a new child widget to the panel, attaching its Element to the specified container Element.
int	adjustIndex(Widget child, int beforeIndex) Adjusts beforeIndex to account for the possibility that the given widget is already a child of this panel.
void	checkIndexBoundsForAccess(int index) Checks that `index` is in the range [0, getWidgetCount()), which is the valid range on accessible indexes.
void	checkIndexBoundsForInsertion(int index) Checks that `index` is in the range [0, getWidgetCount()], which is the valid range for indexes on an insertion.
WidgetCollection	getChildren() Gets the list of children contained in this panel.
Widget	getWidget(int index) Gets the child widget at the specified index.
int	getWidgetCount() Gets the number of child widgets in this panel.
int	getWidgetIndex(Widget child) Gets the index of the specified child widget.
int	getWidgetIndex(IsWidget child)
void	insert(Widget child, Element container, int beforeIndex, boolean domInsert) Insert a new child Widget into this Panel at a specified index, attaching its Element to the specified container Element.
void	insert(Widget child, Element container, int beforeIndex) This method is deprecated. Use `insert(Widget, Element, int, boolean)` instead
Iterator<Widget>	iterator()
boolean	remove(Widget w) Removes a child widget.
boolean	remove(int index) Removes the widget at the specified index.

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.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.HasWidgets

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

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

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

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

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

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

From interface java.lang.Iterable

Public Constructors

public StackPanel ()

Creates an empty stack panel.

Public Methods

public void add (Widget w, SafeHtml stackHtml)

Adds a new child with the given widget and header, optionally interpreting the header as HTML.

Parameters

w	the widget to be added
stackHtml	the header html associated with this widget

public void add (Widget w, String stackText)

Adds a new child with the given widget and header.

Parameters

w	the widget to be added
stackText	the header text associated with this widget

public void add (Widget w, String stackText, boolean asHTML)

Adds a new child with the given widget and header, optionally interpreting the header as HTML.

Parameters

w	the widget to be added
stackText	the header text associated with this widget
asHTML	`true` to treat the specified text as HTML

public void add (Widget w)

Adds a child widget.

How to Override this Method

There are several important things that must take place in the correct order to properly add or insert a Widget to a Panel. Not all of these steps will be relevant to every Panel, but all of the steps must be considered.

Validate: Perform any sanity checks to ensure the Panel can accept a new Widget. Examples: checking for a valid index on insertion; checking that the Panel is not full if there is a max capacity.
Adjust for Reinsertion: Some Panels need to handle the case where the Widget is already a child of this Panel. Example: when performing a reinsert, the index might need to be adjusted to account for the Widget's removal. See adjustIndex(Widget, int).
Detach Child: Remove the Widget from its existing parent, if any. Most Panels will simply call removeFromParent() on the Widget.
Logical Attach: Any state variables of the Panel should be updated to reflect the addition of the new Widget. Example: the Widget is added to the Panel's WidgetCollection at the appropriate index.
Physical Attach: The Widget's Element must be physically attached to the Panel's Element, either directly or indirectly.
Adopt: Call adopt(Widget) to finalize the add as the very last step.

Parameters

w	the widget to be added

public int getSelectedIndex ()

Gets the currently selected child index.

Returns

selected child

public void insert (IsWidget w, int beforeIndex)

public void insert (Widget w, int beforeIndex)

Inserts a child widget before the specified index. If the widget is already a child of this panel, it will be moved to the specified index.

Parameters

w	the child widget to be inserted
beforeIndex	the index before which it will be inserted

public void onBrowserEvent (Event event)

Fired whenever a browser event is received.

Parameters

event	the event received

public boolean remove (Widget child)

Removes a child widget.

How to Override this Method

There are several important things that must take place in the correct order to properly remove a Widget from a Panel. Not all of these steps will be relevant to every Panel, but all of the steps must be considered.

Validate: Make sure this Panel is actually the parent of the child Widget; return false if it is not.
Orphan: Call orphan(Widget) first while the child Widget is still attached.
Physical Detach: Adjust the DOM to account for the removal of the child Widget. The Widget's Element must be physically removed from the DOM.
Logical Detach: Update the Panel's state variables to reflect the removal of the child Widget. Example: the Widget is removed from the Panel's WidgetCollection.

Parameters

child	the widget to be removed

Returns

true if the child was present

public boolean remove (int index)

Removes the widget at the specified index.

Parameters

index	the index of the widget to be removed

Returns

false if the widget is not present

public void setStackText (int index, String text, boolean asHTML)

Sets the text associated with a child by its index.

Parameters

index	the index of the child whose text is to be set
text	the text to be associated with it
asHTML	`true` to treat the specified text as HTML

public void setStackText (int index, String text)

Sets the text associated with a child by its index.

Parameters

index	the index of the child whose text is to be set
text	the text to be associated with it

public void setStackText (int index, SafeHtml html)

Sets the html associated with a child by its index.

Parameters

index	the index of the child whose text is to be set
html	the html to be associated with it

public void showStack (int index)

Shows the widget at the specified child index.

Parameters

index	the index of the child to be shown

Protected Methods

protected void onEnsureDebugId (String baseID)

Affected Elements:

-text# = The element around the header at the specified index.
-text-wrapper# = The element around the header at the specified index.
-content# = The element around the body at the specified index.

Parameters

baseID	the base ID used by the main element

Interfaces

Classes

Annotations

Enums

Exceptions

StackPanel

Class Overview

CSS Style Rules

Example

See Also

Summary

Public Constructors

public StackPanel ()

Public Methods

public void add (Widget w, SafeHtml stackHtml)

Parameters

public void add (Widget w, String stackText)

Parameters

public void add (Widget w, String stackText, boolean asHTML)

Parameters

public void add (Widget w)

Parameters

public int getSelectedIndex ()

Returns

public void insert (IsWidget w, int beforeIndex)

public void insert (Widget w, int beforeIndex)

Parameters

public void onBrowserEvent (Event event)

Parameters

public boolean remove (Widget child)

Parameters

Returns

public boolean remove (int index)

Parameters

Returns

public void setStackText (int index, String text, boolean asHTML)

Parameters

public void setStackText (int index, String text)

Parameters

public void setStackText (int index, SafeHtml html)

Parameters

public void showStack (int index)

Parameters

Protected Methods

protected void onEnsureDebugId (String baseID)

Parameters

See Also