Summary: Inherited Constants | Ctors | Methods | Inherited Methods | [Expand All]

public class

TabLayoutPanel

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

Class Overview

A panel that represents a tabbed set of pages, each of which contains another widget. Its child widgets are shown as the user selects the various tabs associated with them. The tabs can contain arbitrary text, HTML, or widgets.

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-TabLayoutPanel: the panel itself
.gwt-TabLayoutPanel .gwt-TabLayoutPanelTabs: the tab bar element
.gwt-TabLayoutPanel .gwt-TabLayoutPanelTab: an individual tab
.gwt-TabLayoutPanel .gwt-TabLayoutPanelTabInner: an element nested in each tab (useful for styling)
.gwt-TabLayoutPanel .gwt-TabLayoutPanelContent: applied to all child content widgets

Example

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

Use in UiBinder Templates

A TabLayoutPanel element in a UiBinder template must have a barHeight attribute with a double value, and may have a barUnit attribute with a Style.Unit value. barUnit defaults to PX.

The children of a TabLayoutPanel element are laid out in <g:tab> elements. Each tab 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:TabLayoutPanel barUnit='EM' barHeight='3'>
  <g:tab>
    <g:header size='7'><b>HTML</b> header</g:header>
    <g:Label>able</g:Label>
  </g:tab>
  <g:tab>
    <g:customHeader size='7'>
      <g:Label>Custom header</g:Label>
    </g:customHeader>
    <g:Label>baker</g:Label>
  </g:tab>
 </g:TabLayoutPanel>

Summary

[Expand]

Inherited Constants

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

Public Constructors
	TabLayoutPanel(double barHeight, Style.Unit barUnit) Creates an empty tab panel.

Public Methods
void	add(IsWidget w, String text, boolean asHtml) Convenience overload to allow `IsWidget` to be used directly.
void	add(Widget child, Widget tab) Adds a widget to the panel.
void	add(Widget child, String text, boolean asHtml) Adds a widget to the panel.
void	add(IsWidget w, IsWidget tab) Convenience overload to allow `IsWidget` to be used directly.
void	add(Widget w) Adds a child widget.
void	add(Widget child, SafeHtml html) Adds a widget to the panel.
void	add(IsWidget w, String text) Convenience overload to allow `IsWidget` to be used directly.
void	add(Widget child, String text) Adds a widget to the panel.
void	add(IsWidget w) Convenience overload to allow `IsWidget` to be used directly.
HandlerRegistration	addBeforeSelectionHandler(BeforeSelectionHandler<Integer> handler)
HandlerRegistration	addSelectionHandler(SelectionHandler<Integer> handler)
void	clear() Removes all child widgets.
int	getSelectedIndex() Gets the index of the currently-selected tab.
Widget	getTabWidget(Widget child) Gets the widget in the tab associated with the given child widget.
Widget	getTabWidget(int index) Gets the widget in the tab at the given index.
Widget	getTabWidget(IsWidget child) Convenience overload to allow `IsWidget` to be used directly.
Widget	getWidget(int index) Returns the widget at the given index.
int	getWidgetCount() Returns the number of tabs and widgets.
int	getWidgetIndex(IsWidget child) Convenience overload to allow `IsWidget` to be used directly.
int	getWidgetIndex(Widget child) Returns the index of the given child, or -1 if it is not a child.
void	insert(Widget child, String text, int beforeIndex) Inserts a widget into the panel.
void	insert(IsWidget child, IsWidget tab, int beforeIndex) Convenience overload to allow `IsWidget` to be used directly.
void	insert(IsWidget child, String text, boolean asHtml, int beforeIndex) Convenience overload to allow `IsWidget` to be used directly.
void	insert(Widget child, Widget tab, int beforeIndex) Inserts a widget into the panel.
void	insert(IsWidget child, int beforeIndex) Convenience overload to allow `IsWidget` to be used directly.
void	insert(IsWidget child, String text, int beforeIndex) Convenience overload to allow `IsWidget` to be used directly.
void	insert(Widget child, SafeHtml html, int beforeIndex) Inserts a widget into the panel.
void	insert(Widget child, int beforeIndex) Inserts a widget into the panel.
void	insert(Widget child, String text, boolean asHtml, int beforeIndex) Inserts a widget into the panel.
Iterator<Widget>	iterator() Gets an iterator for the contained widgets.
boolean	remove(Widget w) Removes a child widget.
boolean	remove(int index) Removes the widget at the specified index.
void	selectTab(Widget child, boolean fireEvents) Programmatically selects the specified tab.
void	selectTab(int index) Programmatically selects the specified tab and fires events.
void	selectTab(IsWidget child) Convenience overload to allow `IsWidget` to be used directly.
void	selectTab(Widget child) Programmatically selects the specified tab and fires events.
void	selectTab(IsWidget child, boolean fireEvents) Convenience overload to allow `IsWidget` to be used directly.
void	selectTab(int index, boolean fireEvents) Programmatically selects the specified tab.
void	setTabHTML(int index, String html) Sets a tab's HTML contents.
void	setTabHTML(int index, SafeHtml html) Sets a tab's HTML contents.
void	setTabText(int index, String text) Sets a tab's text contents.

[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 TabLayoutPanel (double barHeight, Style.Unit barUnit)

Creates an empty tab panel.

Parameters

barHeight	the size of the tab bar
barUnit	the unit in which the tab bar size is specified

Public Methods

public void add (IsWidget w, String text, boolean asHtml)

Convenience overload to allow IsWidget to be used directly.

public void add (Widget child, Widget tab)

Adds a widget to the panel. If the Widget is already attached, it will be moved to the right-most index.

Parameters

child	the widget to be added
tab	the widget to be placed in the associated tab

public void add (Widget child, String text, boolean asHtml)

Adds a widget to the panel. If the Widget is already attached, it will be moved to the right-most index.

Parameters

child	the widget to be added
text	the text to be shown on its tab
asHtml	`true` to treat the specified text as HTML

public void add (IsWidget w, IsWidget tab)

Convenience overload to allow IsWidget to be used directly.

public void add (Widget w)

Adds a child widget.

Parameters

w	the widget to be added

public void add (Widget child, SafeHtml html)

Adds a widget to the panel. If the Widget is already attached, it will be moved to the right-most index.

Parameters

child	the widget to be added
html	the html to be shown on its tab

public void add (IsWidget w, String text)

Convenience overload to allow IsWidget to be used directly.

public void add (Widget child, String text)

Adds a widget to the panel. If the Widget is already attached, it will be moved to the right-most index.

Parameters

child	the widget to be added
text	the text to be shown on its tab

public void add (IsWidget w)

Convenience overload to allow IsWidget to be used directly.

public HandlerRegistration addBeforeSelectionHandler (BeforeSelectionHandler<Integer> handler)

public HandlerRegistration addSelectionHandler (SelectionHandler<Integer> handler)

public void clear ()

Removes all child widgets.

public int getSelectedIndex ()

Gets the index of the currently-selected tab.

Returns

the selected index, or -1 if none is selected.

public Widget getTabWidget (Widget child)

Gets the widget in the tab associated with the given child widget.

Parameters

child	the child whose tab is to be retrieved

Returns

the tab's widget

public Widget getTabWidget (int index)

Gets the widget in the tab at the given index.

Parameters

index	the index of the tab to be retrieved

Returns

the tab's widget

public Widget getTabWidget (IsWidget child)

Convenience overload to allow IsWidget to be used directly.

public Widget getWidget (int index)

Returns the widget at the given index.

Parameters

index	the child widget's index

Returns

the child widget

public int getWidgetCount ()

Returns the number of tabs and widgets.

Returns

the number of children

public int getWidgetIndex (IsWidget child)

Convenience overload to allow IsWidget to be used directly.

public int getWidgetIndex (Widget child)

Returns the index of the given child, or -1 if it is not a child.

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, 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 tab
beforeIndex	the index before which it will be inserted

public void insert (IsWidget child, IsWidget tab, int beforeIndex)

Convenience overload to allow IsWidget to be used directly.

public void insert (IsWidget child, String text, boolean asHtml, int beforeIndex)

Convenience overload to allow IsWidget to be used directly.

public void insert (Widget child, Widget tab, 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
tab	the widget to be placed in the associated tab
beforeIndex	the index before which it will be inserted

public void insert (IsWidget child, int beforeIndex)

Convenience overload to allow IsWidget to be used directly.

public void insert (IsWidget child, String text, int beforeIndex)

Convenience overload to allow IsWidget to be used directly.

public void insert (Widget child, SafeHtml html, 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 html to be shown on its tab
beforeIndex	the index before which it will be inserted

public void insert (Widget child, 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
beforeIndex	the index before which it will be inserted

public void insert (Widget child, String text, boolean asHtml, 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 tab
asHtml	`true` to treat the specified text as HTML
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 boolean remove (Widget w)

Removes a child widget.

Parameters

w	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 selectTab (Widget child, boolean fireEvents)

Programmatically selects the specified tab.

Parameters

child	the child whose tab is to be selected
fireEvents	true to fire events, false not to

public void selectTab (int index)

Programmatically selects the specified tab and fires events.

Parameters

index	the index of the tab to be selected

public void selectTab (IsWidget child)

Convenience overload to allow IsWidget to be used directly.

public void selectTab (Widget child)

Programmatically selects the specified tab and fires events.

Parameters

child	the child whose tab is to be selected

public void selectTab (IsWidget child, boolean fireEvents)

Convenience overload to allow IsWidget to be used directly.

public void selectTab (int index, boolean fireEvents)

Programmatically selects the specified tab.

Parameters

index	the index of the tab to be selected
fireEvents	true to fire events, false not to

public void setTabHTML (int index, String html)

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

Parameters

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

public void setTabHTML (int index, SafeHtml html)

Sets a tab's HTML contents.

Parameters

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

public void setTabText (int index, String text)

Sets a tab's text contents.

Parameters

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

Interfaces

Classes

Annotations

Enums

Exceptions

TabLayoutPanel

Class Overview

CSS Style Rules

Example

Use in UiBinder Templates

Summary

Public Constructors

public TabLayoutPanel (double barHeight, Style.Unit barUnit)

Parameters

Public Methods

public void add (IsWidget w, String text, boolean asHtml)

public void add (Widget child, Widget tab)

Parameters

public void add (Widget child, String text, boolean asHtml)

Parameters

public void add (IsWidget w, IsWidget tab)

public void add (Widget w)

Parameters

public void add (Widget child, SafeHtml html)

Parameters

public void add (IsWidget w, String text)

public void add (Widget child, String text)

Parameters

public void add (IsWidget w)

public HandlerRegistration addBeforeSelectionHandler (BeforeSelectionHandler<Integer> handler)

public HandlerRegistration addSelectionHandler (SelectionHandler<Integer> handler)

public void clear ()

public int getSelectedIndex ()

Returns

public Widget getTabWidget (Widget child)

Parameters

Returns

public Widget getTabWidget (int index)

Parameters

Returns

public Widget getTabWidget (IsWidget child)

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, int beforeIndex)

Parameters

public void insert (IsWidget child, IsWidget tab, int beforeIndex)

public void insert (IsWidget child, String text, boolean asHtml, int beforeIndex)

public void insert (Widget child, Widget tab, int beforeIndex)

Parameters

public void insert (IsWidget child, int beforeIndex)

public void insert (IsWidget child, String text, int beforeIndex)

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

Parameters

public void insert (Widget child, int beforeIndex)

Parameters

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

Parameters

public Iterator<Widget> iterator ()

public boolean remove (Widget w)

Parameters

Returns

public boolean remove (int index)

Parameters

Returns

public void selectTab (Widget child, boolean fireEvents)

Parameters

public void selectTab (int index)

Parameters

public void selectTab (IsWidget child)

public void selectTab (Widget child)

Parameters

public void selectTab (IsWidget child, boolean fireEvents)

public void selectTab (int index, boolean fireEvents)