com.sencha.gxt.widget.core.client

Class TabPanel

java.lang.Object

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

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

com.sencha.gxt.widget.core.client.Component

com.sencha.gxt.widget.core.client.TabPanel

All Implemented Interfaces:

HasAttachHandlers, HasBeforeSelectionHandlers<Widget>, HasResizeHandlers, HasSelectionHandlers<Widget>, HasHandlers, EventListener, AcceptsOneWidget, HasOneWidget, HasVisibility, HasWidgets, IndexedPanel, IndexedPanel.ForIsWidget, IsWidget, HasLayout, BeforeCloseEvent.HasBeforeCloseHandlers<Widget>, BeforeHideEvent.HasBeforeHideHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, CloseEvent.HasCloseHandlers<Widget>, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasItemId, Iterable<Widget>

Direct Known Subclasses:

PlainTabPanel

public class TabPanel
extends Component
implements IndexedPanel.ForIsWidget, HasOneWidget, HasBeforeSelectionHandlers<Widget>, HasSelectionHandlers<Widget>, BeforeCloseEvent.HasBeforeCloseHandlers<Widget>, CloseEvent.HasCloseHandlers<Widget>, HasLayout, HasWidgets

A basic tab container.

 TabPanel panel = new TabPanel();
 panel.setResizeTabs(true);
 panel.setEnableTabScroll(true);
 panel.setAnimScroll(true);

 TabItem item = new TabItem();
 item.setClosable(true);
 item.setText("Tab Item");

 item.setLayout(new FitLayout());
 item.add(new Label("Test Content"));

 panel.add(item);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TabPanel.TabPanelAppearance
static interface	TabPanel.TabPanelMessages

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.IndexedPanel

IndexedPanel.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

HasWidgets.ForIsWidget

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
TabPanel() Creates a new tab panel.
TabPanel(TabPanel.TabPanelAppearance appearance)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Widget w)
void	add(Widget widget, String text)
void	add(Widget widget, TabItemConfig config)
HandlerRegistration	addBeforeCloseHandler(BeforeCloseEvent.BeforeCloseHandler<Widget> handler) Adds a BeforeCloseEvent.BeforeCloseHandler handler for BeforeCloseEvent events.
HandlerRegistration	addBeforeSelectionHandler(BeforeSelectionHandler<Widget> handler)
HandlerRegistration	addCloseHandler(CloseEvent.CloseHandler<Widget> handler) Adds a CloseEvent.CloseHandler handler for CloseEvent events.
HandlerRegistration	addSelectionHandler(SelectionHandler<Widget> handler)
void	clear()
Widget	findItem(String id, boolean checkText) Searches for an item based on its id and optionally the item's text.
void	forceLayout()
boolean	getAnimScroll() Returns true if scrolling is animated.
boolean	getBodyBorder() Returns true if the body border is enabled.
TabItemConfig	getConfig(Widget widget) Returns the tab item config for the given widget.
CardLayoutContainer	getContainer() Returns the internal card layout container.
TabPanel.TabPanelMessages	getMessages() Returns the tab panel messages.
boolean	getResizeTabs() Returns true if tab resizing is enabled.
int	getScrollDuration() Returns the scroll duration in milliseconds.
boolean	getTabScroll() Returns true if tab scrolling is enabled.
Widget	getWidget() Returns the current selection tab item.
Widget	getWidget(int index)
int	getWidgetCount()
int	getWidgetIndex(IsWidget child)
int	getWidgetIndex(Widget widget)
void	insert(Widget widget, int index, TabItemConfig config)
boolean	isAutoSelect() Returns true if auto select is enabled.
boolean	isCloseContextMenu() Returns true if close context menu is enabled.
boolean	isLayoutRunning()
boolean	isOrWasLayoutRunning()
Iterator<Widget>	iterator()
void	onBrowserEvent(Event event)
boolean	remove(int index)
boolean	remove(Widget child)
void	scrollToTab(Widget item, boolean animate) Scrolls to a particular tab if tab scrolling is enabled.
void	setAnimScroll(boolean animScroll) True to animate tab scrolling so that hidden tabs slide smoothly into view (defaults to true).
void	setAutoSelect(boolean autoSelect) True to have the first item selected when the panel is displayed for the first time if there is not selection (defaults to true).
void	setBodyBorder(boolean bodyBorder) True to display an interior border on the body element of the panel, false to hide it (defaults to true, pre-render).
void	setCloseContextMenu(boolean closeMenu) True to show the close context menu (defaults to false).
void	setMessages(TabPanel.TabPanelMessages messages) Sets the tab panel messages.
void	setResizeTabs(boolean resizeTabs) True to automatically resize each tab so that the tabs will completely fill the tab strip (defaults to false).
void	setScrollDuration(int scrollDuration) Sets the number of milliseconds that each scroll animation should last (defaults to 150).
void	setScrollIncrement(int scrollIncrement) Sets the number of pixels to scroll each time a tab scroll button is pressed (defaults to 100, or if setResizeTabs(boolean) = true, the calculated tab width).
void	setTabScroll(boolean tabScroll) True to enable scrolling to tabs that may be invisible due to overflowing the overall TabPanel width.
void	setWidget(IsWidget item) Sets the selected tab item.
void	setWidget(Widget item)
void	update(Widget widget, TabItemConfig config)

Methods inherited from class com.sencha.gxt.widget.core.client.Component

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleOnOver, clearSizeCache, disable, disableEvents, enable, enableEvents, fireEvent, focus, getData, getElement, getFocusSupport, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getShadow, getStateId, getToolTip, hide, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isRendered, isStateful, isVisible, isVisible, mask, mask, removeHandler, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setPagePosition, setPixelSize, setPosition, setShadow, setSize, setStateful, setStateId, setTabIndex, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, getLayoutData, getParent, isAttached, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, removeStyleName, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Detail

TabPanel

public TabPanel()

Creates a new tab panel.

TabPanel

public TabPanel(TabPanel.TabPanelAppearance appearance)

Method Detail

add

public void add(Widget w)

Specified by:

add in interface HasWidgets

add

public void add(Widget widget,
       String text)

add

@UiChild(tagname="child")
public void add(Widget widget,
                      TabItemConfig config)

addBeforeCloseHandler

public HandlerRegistration addBeforeCloseHandler(BeforeCloseEvent.BeforeCloseHandler<Widget> handler)

Description copied from interface: BeforeCloseEvent.HasBeforeCloseHandlers

Adds a BeforeCloseEvent.BeforeCloseHandler handler for BeforeCloseEvent events.

Specified by:

addBeforeCloseHandler in interface BeforeCloseEvent.HasBeforeCloseHandlers<Widget>

Parameters:

handler - the handler

Returns:

the registration for the event

addBeforeSelectionHandler

public HandlerRegistration addBeforeSelectionHandler(BeforeSelectionHandler<Widget> handler)

Specified by:

addBeforeSelectionHandler in interface HasBeforeSelectionHandlers<Widget>

addCloseHandler

public HandlerRegistration addCloseHandler(CloseEvent.CloseHandler<Widget> handler)

Description copied from interface: CloseEvent.HasCloseHandlers

Adds a CloseEvent.CloseHandler handler for CloseEvent events.

Specified by:

addCloseHandler in interface CloseEvent.HasCloseHandlers<Widget>

Parameters:

handler - the handler

Returns:

the registration for the event

addSelectionHandler

public HandlerRegistration addSelectionHandler(SelectionHandler<Widget> handler)

Specified by:

addSelectionHandler in interface HasSelectionHandlers<Widget>

clear

public void clear()

Specified by:

clear in interface HasWidgets

findItem

public Widget findItem(String id,
              boolean checkText)

Searches for an item based on its id and optionally the item's text.

Parameters:

id - the item id

checkText - true to match the items id and text

Returns:

the item

forceLayout

public void forceLayout()

Specified by:

forceLayout in interface HasLayout

getAnimScroll

public boolean getAnimScroll()

Returns true if scrolling is animated.

Returns:

the animation scroll state

getBodyBorder

public boolean getBodyBorder()

Returns true if the body border is enabled.

Returns:

the body border state

getConfig

public TabItemConfig getConfig(Widget widget)

Returns the tab item config for the given widget.

Parameters:

widget - the widget

Returns:

the config or null

getContainer

public CardLayoutContainer getContainer()

Returns the internal card layout container.

Returns:

the card layout container

getMessages

public TabPanel.TabPanelMessages getMessages()

Returns the tab panel messages.

Returns:

the messages

getResizeTabs

public boolean getResizeTabs()

Returns true if tab resizing is enabled.

Returns:

the tab resizing state

getScrollDuration

public int getScrollDuration()

Returns the scroll duration in milliseconds.

Returns:

the duration

getTabScroll

public boolean getTabScroll()

Returns true if tab scrolling is enabled.

Returns:

the tab scroll state

getWidget

public Widget getWidget()

Returns the current selection tab item.

Specified by:

getWidget in interface HasOneWidget

Returns:

the selected item

getWidget

public Widget getWidget(int index)

Specified by:

getWidget in interface IndexedPanel

getWidgetCount

public int getWidgetCount()

Specified by:

getWidgetCount in interface IndexedPanel

getWidgetIndex

public int getWidgetIndex(IsWidget child)

Specified by:

getWidgetIndex in interface IndexedPanel.ForIsWidget

getWidgetIndex

public int getWidgetIndex(Widget widget)

Specified by:

getWidgetIndex in interface IndexedPanel

insert

public void insert(Widget widget,
          int index,
          TabItemConfig config)

isAutoSelect

public boolean isAutoSelect()

Returns true if auto select is enabled.

Returns:

the auto select state

isCloseContextMenu

public boolean isCloseContextMenu()

Returns true if close context menu is enabled.

Returns:

the close menu state

isLayoutRunning

public boolean isLayoutRunning()

Specified by:

isLayoutRunning in interface HasLayout

isOrWasLayoutRunning

public boolean isOrWasLayoutRunning()

Specified by:

isOrWasLayoutRunning in interface HasLayout

iterator

public Iterator<Widget> iterator()

Specified by:

iterator in interface HasWidgets

Specified by:

iterator in interface Iterable<Widget>

onBrowserEvent

public void onBrowserEvent(Event event)

Specified by:

onBrowserEvent in interface EventListener

Overrides:

onBrowserEvent in class Component

remove

public boolean remove(int index)

Specified by:

remove in interface IndexedPanel

remove

public boolean remove(Widget child)

Specified by:

remove in interface HasWidgets

scrollToTab

public void scrollToTab(Widget item,
               boolean animate)

Scrolls to a particular tab if tab scrolling is enabled.

Parameters:

item - the item to scroll to

animate - true to animate the scroll

setAnimScroll

public void setAnimScroll(boolean animScroll)

True to animate tab scrolling so that hidden tabs slide smoothly into view (defaults to true). Only applies when tabScroll = true.

Parameters:

animScroll - the animation scroll state

setAutoSelect

public void setAutoSelect(boolean autoSelect)

True to have the first item selected when the panel is displayed for the first time if there is not selection (defaults to true).

Parameters:

autoSelect - the auto select state

setBodyBorder

public void setBodyBorder(boolean bodyBorder)

True to display an interior border on the body element of the panel, false to hide it (defaults to true, pre-render).

Parameters:

bodyBorder - the body border style

setCloseContextMenu

public void setCloseContextMenu(boolean closeMenu)

True to show the close context menu (defaults to false).

Parameters:

closeMenu - true to show it

setMessages

public void setMessages(TabPanel.TabPanelMessages messages)

Sets the tab panel messages.

Parameters:

messages - the messages

setResizeTabs

public void setResizeTabs(boolean resizeTabs)

True to automatically resize each tab so that the tabs will completely fill the tab strip (defaults to false). Setting this to true may cause specific widths that might be set per tab to be overridden in order to fit them all into view.

Parameters:

resizeTabs - true to enable tab resizing

setScrollDuration

public void setScrollDuration(int scrollDuration)

Sets the number of milliseconds that each scroll animation should last (defaults to 150).

Parameters:

scrollDuration - the scroll duration

setScrollIncrement

public void setScrollIncrement(int scrollIncrement)

Sets the number of pixels to scroll each time a tab scroll button is pressed (defaults to 100, or if setResizeTabs(boolean) = true, the calculated tab width). Only applies when setTabScroll(boolean) = true.

Parameters:

scrollIncrement - the scroll increment

setTabScroll

public void setTabScroll(boolean tabScroll)

True to enable scrolling to tabs that may be invisible due to overflowing the overall TabPanel width. Only available with tabs on top. (defaults to false).

Parameters:

tabScroll - true to enable tab scrolling

setWidget

public void setWidget(IsWidget item)

Sets the selected tab item. Fires the BeforeSelect event before selecting, then fires the Select event after the widget has been selected.

Specified by:

setWidget in interface AcceptsOneWidget

Parameters:

item - the item to be selected

setWidget

public void setWidget(Widget item)

Specified by:

setWidget in interface HasOneWidget

update

public void update(Widget widget,
          TabItemConfig config)