public class

StackLayoutPanel

extends ResizeComposite
implements HasBeforeSelectionHandlers<T> HasSelectionHandlers<T> HasWidgets IndexedPanel.ForIsWidget ProvidesResize

java.lang.Object
↳	com.google.gwt.user.client.ui.UIObject
	↳	com.google.gwt.user.client.ui.Widget
		↳	com.google.gwt.user.client.ui.Composite
			↳	com.google.gwt.user.client.ui.ResizeComposite
				↳	com.google.gwt.user.client.ui.StackLayoutPanel

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 standards mode, which requires that the HTML page in which it is run have an explicit <!DOCTYPE> declaration.

CSS Style Rules

.gwt-StackLayoutPanel: the panel itself
.gwt-StackLayoutPanel .gwt-StackLayoutPanelHeader: applied to each header widget
.gwt-StackLayoutPanel .gwt-StackLayoutPanelHeader-hovering: applied to each header widget on mouse hover
.gwt-StackLayoutPanel .gwt-StackLayoutPanelContent: applied to each child widget

Example

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

Use in UiBinder Templates

A StackLayoutPanel element in a UiBinder template may have a unit attribute with a Style.Unit value (it defaults to PX).

The children of a StackLayoutPanel element are laid out in <g:stack> elements. Each stack can have one widget child and one of two types of header elements. A <g:header> element can hold html, or a <g:customHeader> element can hold a widget. (Note that the tags of the header elements are not capitalized. This is meant to signal that the head is not a runtime object, and so cannot have a ui:field attribute.)

For example:

 <g:StackLayoutPanel unit='PX'>
  <g:stack>
    <g:header size='3'><b>HTML</b> header</g:header>
    <g:Label>able</g:Label>
  </g:stack>
  <g:stack>
    <g:customHeader size='3'>
      <g:Label>Custom header</g:Label>
    </g:customHeader>
    <g:Label>baker</g:Label>
  </g:stack>
 </g:StackLayoutPanel>

Summary

[Expand]

Inherited Constants

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

Public Constructors
	StackLayoutPanel(Style.Unit unit) Creates an empty stack panel.

Public Methods
void	add(Widget widget, SafeHtml header, double headerSize) Adds a child widget to this stack, along with a widget representing the stack header.
void	add(Widget widget, Widget header, double headerSize) Adds a child widget to this stack, along with a widget representing the stack header.
void	add(Widget w) Adds a child widget.
void	add(Widget widget, String header, double headerSize) Adds a child widget to this stack, along with a widget representing the stack header.
void	add(Widget widget, String header, boolean asHtml, double headerSize) Adds a child widget to this stack, along with a widget representing the stack header.
HandlerRegistration	addBeforeSelectionHandler(BeforeSelectionHandler<Integer> handler)
HandlerRegistration	addSelectionHandler(SelectionHandler<Integer> handler)
void	clear() Removes all child widgets.
Widget	getHeaderWidget(int index) Gets the widget in the stack header at the given index.
Widget	getHeaderWidget(Widget child) Gets the widget in the stack header associated with the given child widget.
int	getVisibleIndex() Gets the currently-selected index.
Widget	getVisibleWidget() Gets the currently-selected widget.
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(IsWidget child)
int	getWidgetIndex(Widget child) Gets the index of the specified child widget.
void	insert(Widget child, String text, boolean asHtml, double headerSize, int beforeIndex) Inserts a widget into the panel.
void	insert(Widget child, SafeHtml html, double headerSize, int beforeIndex) Inserts a widget into the panel.
void	insert(Widget child, Widget header, double headerSize, int beforeIndex) Inserts a widget into the panel.
void	insert(Widget child, String text, double headerSize, int beforeIndex) Inserts a widget into the panel.
Iterator<Widget>	iterator() Gets an iterator for the contained widgets.
void	onResize() This method must be called whenever the implementor's size has been modified.
boolean	remove(Widget child) Removes a child widget.
boolean	remove(int index) Removes the widget at the specified index.
void	setHeaderHTML(int index, SafeHtml html) Sets a stack header's HTML contents.
void	setHeaderHTML(int index, String html) Sets a stack header's HTML contents.
void	setHeaderText(int index, String text) Sets a stack header's text contents.
void	showWidget(int index) Shows the widget at the specified index and fires events.
void	showWidget(Widget child, boolean fireEvents) Shows the specified widget.
void	showWidget(Widget child) Shows the specified widget and fires events.
void	showWidget(int index, boolean fireEvents) Shows the widget at the specified index.

Protected Methods
void	onLoad() This method is called immediately after a widget becomes attached to the browser's document.

[Expand]

Inherited Methods

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

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

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.logical.shared.HasBeforeSelectionHandlers

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

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

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

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

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

From interface java.lang.Iterable

Public Constructors

public StackLayoutPanel (Style.Unit unit)

Creates an empty stack panel.

Parameters

unit	the unit to be used for layout

Public Methods

public void add (Widget widget, SafeHtml header, double headerSize)

Adds a child widget to this stack, along with a widget representing the stack header.

Parameters

widget	the child widget to be added
header	the html to be shown on its header
headerSize	the size of the header widget

public void add (Widget widget, Widget header, double headerSize)

Adds a child widget to this stack, along with a widget representing the stack header.

Parameters

widget	the child widget to be added
header	the header widget
headerSize	the size of the header widget

public void add (Widget w)

Adds a child widget.

Parameters

w	the widget to be added

public void add (Widget widget, String header, double headerSize)

Adds a child widget to this stack, along with a widget representing the stack header.

Parameters

widget	the child widget to be added
header	the text to be shown on its header
headerSize	the size of the header widget

public void add (Widget widget, String header, boolean asHtml, double headerSize)

Adds a child widget to this stack, along with a widget representing the stack header.

Parameters

widget	the child widget to be added
header	the text to be shown on its header
asHtml	`true` to treat the specified text as HTML
headerSize	the size of the header widget

public HandlerRegistration addBeforeSelectionHandler (BeforeSelectionHandler<Integer> handler)

public HandlerRegistration addSelectionHandler (SelectionHandler<Integer> handler)

public void clear ()

Removes all child widgets.

public Widget getHeaderWidget (int index)

Gets the widget in the stack header at the given index.

Parameters

index	the index of the stack header to be retrieved

Returns

the header widget

public Widget getHeaderWidget (Widget child)

Gets the widget in the stack header associated with the given child widget.

Parameters

child	the child whose stack header is to be retrieved

Returns

the header widget

public int getVisibleIndex ()

Gets the currently-selected index.

Returns

the selected index, or -1 if none is selected

public Widget getVisibleWidget ()

Gets the currently-selected widget.

Returns

the selected widget, or null if none exist

public Widget getWidget (int index)

Gets the child widget at the specified index.

Parameters

index	the child widget's index

Returns

the child widget

public int getWidgetCount ()

Gets the number of child widgets in this panel.

Returns

the number of children

public int getWidgetIndex (IsWidget child)

public int getWidgetIndex (Widget child)

Gets the index of the specified child widget.

Parameters

child	the widget to be found

Returns

the widget's index, or -1 if it is not a child of this panel

public void insert (Widget child, String text, boolean asHtml, double headerSize, int beforeIndex)

Inserts a widget into the panel. If the Widget is already attached, it will be moved to the requested index.

Parameters

child	the widget to be added
text	the text to be shown on its header
asHtml	`true` to treat the specified text as HTML
headerSize	the size of the header widget
beforeIndex	the index before which it will be inserted

public void insert (Widget child, SafeHtml html, double headerSize, int beforeIndex)

Inserts a widget into the panel. If the Widget is already attached, it will be moved to the requested index.

Parameters

child	the widget to be added
html	the safe html to be shown on its header
headerSize	the size of the header widget
beforeIndex	the index before which it will be inserted

public void insert (Widget child, Widget header, double headerSize, int beforeIndex)

Inserts a widget into the panel. If the Widget is already attached, it will be moved to the requested index.

Parameters

child	the widget to be added
header	the widget to be placed in the associated header
headerSize	the size of the header widget
beforeIndex	the index before which it will be inserted

public void insert (Widget child, String text, double headerSize, int beforeIndex)

Inserts a widget into the panel. If the Widget is already attached, it will be moved to the requested index.

Parameters

child	the widget to be added
text	the text to be shown on its header
headerSize	the size of the header widget
beforeIndex	the index before which it will be inserted

public Iterator<Widget> iterator ()

Gets an iterator for the contained widgets. This iterator is required to implement remove().

public void onResize ()

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

public boolean remove (Widget child)

Removes a child widget.

Parameters

child	the widget to be removed

Returns

true if the widget 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 setHeaderHTML (int index, SafeHtml html)

Sets a stack header's HTML contents.

Parameters

index	the index of the header whose HTML is to be set
html	the header's new HTML contents

public void setHeaderHTML (int index, String html)

Sets a stack header's HTML contents. Use care when setting an object's HTML; it is an easy way to expose script-based security problems. Consider using setHeaderHTML(int, SafeHtml) or setHeaderText(int, String) whenever possible.

Parameters

index	the index of the header whose HTML is to be set
html	the header's new HTML contents

public void setHeaderText (int index, String text)

Sets a stack header's text contents.

Parameters

index	the index of the header whose text is to be set
text	the object's new text

public void showWidget (int index)

Shows the widget at the specified index and fires events.

Parameters

index	the index of the child widget to be shown.

public void showWidget (Widget child, boolean fireEvents)

Shows the specified widget.

Parameters

child	the child widget to be shown.
fireEvents	true to fire events, false not to

public void showWidget (Widget child)

Shows the specified widget and fires events.

Parameters

child	the child widget to be shown.

public void showWidget (int index, boolean fireEvents)

Shows the widget at the specified index.

Parameters

index	the index of the child widget to be shown.
fireEvents	true to fire events, false not to

Protected Methods

protected void onLoad ()

This method is called immediately after a widget becomes attached to the browser's document.

Interfaces

Classes

Annotations

Enums

Exceptions

StackLayoutPanel

Class Overview

CSS Style Rules

Example

Use in UiBinder Templates

Summary

Public Constructors

public StackLayoutPanel (Style.Unit unit)

Parameters

Public Methods

public void add (Widget widget, SafeHtml header, double headerSize)

Parameters

public void add (Widget widget, Widget header, double headerSize)

Parameters

public void add (Widget w)

Parameters

public void add (Widget widget, String header, double headerSize)

Parameters

public void add (Widget widget, String header, boolean asHtml, double headerSize)

Parameters

public HandlerRegistration addBeforeSelectionHandler (BeforeSelectionHandler<Integer> handler)

public HandlerRegistration addSelectionHandler (SelectionHandler<Integer> handler)

public void clear ()

public Widget getHeaderWidget (int index)

Parameters

Returns

public Widget getHeaderWidget (Widget child)

Parameters

Returns

public int getVisibleIndex ()

Returns

public Widget getVisibleWidget ()

Returns

public Widget getWidget (int index)

Parameters

Returns

public int getWidgetCount ()

Returns

public int getWidgetIndex (IsWidget child)

public int getWidgetIndex (Widget child)

Parameters

Returns

public void insert (Widget child, String text, boolean asHtml, double headerSize, int beforeIndex)

Parameters

public void insert (Widget child, SafeHtml html, double headerSize, int beforeIndex)

Parameters

public void insert (Widget child, Widget header, double headerSize, int beforeIndex)

Parameters

public void insert (Widget child, String text, double headerSize, int beforeIndex)

Parameters

public Iterator<Widget> iterator ()

public void onResize ()

public boolean remove (Widget child)

Parameters

Returns

public boolean remove (int index)

Parameters

Returns

public void setHeaderHTML (int index, SafeHtml html)

Parameters

public void setHeaderHTML (int index, String html)

Parameters

public void setHeaderText (int index, String text)

Parameters

public void showWidget (int index)

Parameters

public void showWidget (Widget child, boolean fireEvents)

Parameters

public void showWidget (Widget child)

Parameters

public void showWidget (int index, boolean fireEvents)

Parameters

Protected Methods

protected void onLoad ()