com.smartgwt.mobile.client.widgets.tab

Class TabSet

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.smartgwt.mobile.client.widgets.Canvas

com.smartgwt.mobile.client.widgets.layout.Layout

com.smartgwt.mobile.client.widgets.tab.TabSet

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, com.smartgwt.mobile.client.internal.test.AutoTestLocatable, HasClickHandlers, HasDragMoveHandlers, HasDropHandlers, HasPanelHideHandlers, HasPanelShowHandlers, HasShowContextMenuHandlers, PanelContainer, HasTabDeselectedHandlers, HasTabSelectedHandlers, java.lang.Iterable<com.google.gwt.user.client.ui.Widget>

public class TabSet
extends Layout
implements PanelContainer, HasTabSelectedHandlers, HasTabDeselectedHandlers, HasPanelShowHandlers, HasPanelHideHandlers, HasDropHandlers

Nested Class Summary

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

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

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

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

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static com.smartgwt.mobile.client.internal.theme.TabSetCssResourceBase	_CSS

Fields inherited from class com.smartgwt.mobile.client.widgets.layout.Layout

alignment, enforcePolicy, hPolicy, members, membersMargin, minMemberSize, momentumScroll, overflow, paddingAsLayoutMargin, reverseOrder, valign, vertical

Fields inherited from class com.smartgwt.mobile.client.widgets.Canvas

_CONTENT_CHANGED_EVENT_TYPE, _HISTORY_ENABLED, _REQUEST_SCROLL_TO_EVENT_TYPE, id, touched

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
TabSet()

Method Summary

Modifier and Type	Method and Description
Tab	_getMoreTab()
void	_onTabDrop(com.smartgwt.mobile.client.internal.widgets.tab.TabSetItem tabSetItem, DropEvent event) Add/Remove tabs
void	_selectMoreTab()
com.google.gwt.event.shared.HandlerRegistration	addDropHandler(DropHandler handler) Notification method fired when the user drops another canvas onto this one.
Tab	addPanel(Panel panel) Creates a Tab and adds it to the end.
com.google.gwt.event.shared.HandlerRegistration	addPanelHideHandler(PanelHideHandler handler) Executed when the left mouse is clicked (pressed and then released) on this widget.
com.google.gwt.event.shared.HandlerRegistration	addPanelShowHandler(PanelShowHandler handler) Executed when the left mouse is clicked (pressed and then released) on this widget.
void	addTab(Tab tab) Add a tab to the end.
void	addTab(Tab tab, int position) Add a tab at the given position.
com.google.gwt.event.shared.HandlerRegistration	addTabDeselectedHandler(TabDeselectedHandler handler) Add a tabDeselected handler.
com.google.gwt.event.shared.HandlerRegistration	addTabSelectedHandler(TabSelectedHandler handler) Add a tabSelected handler.
void	disableTab(int index) Disable a tab if it is currently enabled.
void	enableTab(int index) Enable a tab if it is currently disabled.
void	enableTab(java.lang.String id) Enable/disable tabs
void	enableTab(Tab tab)
ContainerFeatures	getContainerFeatures() **************************************************** Helper methods ****************************************************
int	getMoreTabCount()
int	getNumTabs() State and tab query methods
Tab	getSelectedTab() Returns the currently selected tab.
int	getSelectedTabNumber() Returns the index of the currently selected tab.
Tab	getTab(int tabIndex) Returns the canvas representing a tab.
Tab	getTab(java.lang.String id)
int	getTabCount()
Tab[]	getTabs()
void	onBrowserEvent(com.google.gwt.user.client.Event event)
void	onLoad()
void	removeTab(int position) Remove a tab at the specified index.
void	removeTab(Tab tab) Remove a tab.
void	removeTabs(int[] tabIndexes) Remove one or more tabs at the specified indexes.
void	selectTab(int index) Select a tab by index
void	selectTab(Tab tab) Select a tab.
void	setMoreTabCount(int moreTabCount)
void	setShowMoreTab(boolean showMoreTab)
void	updateTab(int index, Canvas pane)
void	updateTab(Tab tab, Canvas pane) Sets the pane of the given tab.

Methods inherited from class com.smartgwt.mobile.client.widgets.layout.Layout

addDragMoveHandler, addMember, addMember, addMember, addMember, addMembers, addMembers, addMembers, clear, getEnforcePolicy, getHPolicy, getLayoutBottomMargin, getLayoutLeftMargin, getLayoutMargin, getLayoutRightMargin, getLayoutTopMargin, getManagePercentBreadth, getMember, getMember, getMemberNumber, getMemberNumber, getMembers, getMembersMargin, getMinMemberSize, getMomentumScroll, getOverflow, getPaddingAsLayoutMargin, getReverseOrder, getVertical, getVPolicy, hasMember, hideMember, hideMember, reflow, removeMember, removeMember, removeMembers, removeMembers, reorderMember, reorderMembers, setAlign, setAlign, setDefaultLayoutAlign, setDefaultLayoutAlign, setEnforcePolicy, setHPolicy, setLayoutBottomMargin, setLayoutLeftMargin, setLayoutMargin, setLayoutRightMargin, setLayoutTopMargin, setManagePercentBreadth, setMembers, setMembersMargin, setMinMemberSize, setMomentumScroll, setOverflow, setPaddingAsLayoutMargin, setReverseOrder, setVertical, setVisibleMember, setVPolicy, showMember, showMember

Methods inherited from class com.smartgwt.mobile.client.widgets.Canvas

_add, _booleanValue, _fireContentChangedEvent, _fireContentChangedEvent, _fireRequestScrollToEvent, _getAndroidWindowSoftInputMode, _getAttributeFromSplitLocator, _getChildFromLocatorSubstring, _getFixNavigationBarPositionDuringKeyboardFocus, _getHideTabBarDuringKeyboardFocus, _getInnerAttributeFromSplitLocator, _getInnerElement, _hideAddressBar, _hideAddressBarNow, _insert, _isDifferent, _isHDPIDisplay, _isIOS4OrOlder, _isIOS5, _isIOSMin6_0, _isStandaloneMode, _nativeParseFloat, _removeClassName, _setClassName, _setHandleDisabled, _sinkAnimationEndEvent, _sinkContentChangedEvent, _sinkFocusInEvent, _sinkFocusOutEvent, _sinkInputEvent, _sinkRequestScrollToEvent, _sinkTransitionEndEvent, _triggerDebugger, addChild, addChild, addChild, addClickHandler, addShowContextMenuHandler, destroy, disable, enable, getContextMenu, getID, getInnerHTML, getMargin, hasChild, hasChild, isAndroid, isDisabled, isEnabled, isIPad, isIPhone, isSafari, isStandAlone, isUIWebView, parseDimension, removeChild, removeChild, setContents, setContextMenu, setDisabled, setElement, setID, setMargin, setStyleName, split, useIOSNativeScrolling

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

add, add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove, remove

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

add, add, adopt, doAttachChildren, doDetachChildren, orphan, remove

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onDetach, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

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

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

fireEvent

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

_CSS

@SGWTInternal
public static final com.smartgwt.mobile.client.internal.theme.TabSetCssResourceBase _CSS

Constructor Detail

TabSet

public TabSet()

Method Detail

_getMoreTab

@SGWTInternal
public final Tab _getMoreTab()

getTabs

public final Tab[] getTabs()

updateTab

public void updateTab(Tab tab,
                      Canvas pane)

Sets the pane of the given tab.

Parameters:

tab -

pane -

updateTab

public void updateTab(int index,
                      Canvas pane)
               throws java.lang.IndexOutOfBoundsException

Throws:

java.lang.IndexOutOfBoundsException

addTabSelectedHandler

public com.google.gwt.event.shared.HandlerRegistration addTabSelectedHandler(TabSelectedHandler handler)

Add a tabSelected handler.

Notification fired when a tab is selected.

Specified by:

addTabSelectedHandler in interface HasTabSelectedHandlers

Parameters:

handler - the tabSelectedHandler

Returns:

HandlerRegistration used to remove this handler

addDropHandler

public com.google.gwt.event.shared.HandlerRegistration addDropHandler(DropHandler handler)

Description copied from interface: HasDropHandlers

Notification method fired when the user drops another canvas onto this one. Returning false from this method will prevent any default drop behavior from occurring

Specified by:

addDropHandler in interface HasDropHandlers

Parameters:

handler - the onDrop handler

Returns:

HandlerRegistration used to remove this handler

addTabDeselectedHandler

public com.google.gwt.event.shared.HandlerRegistration addTabDeselectedHandler(TabDeselectedHandler handler)

Add a tabDeselected handler.

Notification fired when a tab is unselected.

Specified by:

addTabDeselectedHandler in interface HasTabDeselectedHandlers

Parameters:

handler - the tabDeselectedHandler

Returns:

HandlerRegistration used to remove this handler

onBrowserEvent

public void onBrowserEvent(com.google.gwt.user.client.Event event)

Specified by:

onBrowserEvent in interface com.google.gwt.user.client.EventListener

Overrides:

onBrowserEvent in class Canvas

onLoad

public void onLoad()

Overrides:

onLoad in class com.google.gwt.user.client.ui.Widget

_onTabDrop

@SGWTInternal
public void _onTabDrop(com.smartgwt.mobile.client.internal.widgets.tab.TabSetItem tabSetItem,
                                     DropEvent event)

Add/Remove tabs

addPanel

public Tab addPanel(Panel panel)

Creates a Tab and adds it to the end.

This is equivalent to:

 final Tab tab = new Tab(panel.getTitle(), panel.getIcon());
 tabSet.addTab(tab);
 

Parameters:

panel - the panel to add.

Returns:

the automatically created Tab.

addTab

public void addTab(Tab tab)

Add a tab to the end.

Parameters:

tab - the tab to add.

addTab

public void addTab(Tab tab,
                   int position)

Add a tab at the given position.

Parameters:

tab - the tab to add.

position - the index where the tab should be added. It is clamped within range (0 through getNumTabs(), inclusive) if out of bounds.

removeTab

public void removeTab(Tab tab)

Remove a tab.

Parameters:

tab - to remove

removeTab

public void removeTab(int position)

Remove a tab at the specified index.

Parameters:

position - the index of the tab to remove

removeTabs

public void removeTabs(int[] tabIndexes)

Remove one or more tabs at the specified indexes.

Parameters:

tabIndexes - array of tab indexes

getSelectedTabNumber

public final int getSelectedTabNumber()

Returns the index of the currently selected tab.

Returns:

-2 if the More tab is selected; otherwise, the index of the currently selected tab, or -1 if no tab is selected.

getSelectedTab

public final Tab getSelectedTab()

Returns the currently selected tab.

Returns:

the currently selected tab, or null if the More tab is selected or no tab is selected.

_selectMoreTab

@SGWTInternal
public void _selectMoreTab()

selectTab

public void selectTab(int index)
               throws java.lang.IndexOutOfBoundsException

Select a tab by index

Parameters:

index - the tab index

Throws:

java.lang.IndexOutOfBoundsException

selectTab

public void selectTab(Tab tab)

Select a tab.

Parameters:

tab - the canvas representing the tab

enableTab

public void enableTab(java.lang.String id)

Enable/disable tabs

enableTab

public void enableTab(Tab tab)

enableTab

public void enableTab(int index)
               throws java.lang.IndexOutOfBoundsException

Enable a tab if it is currently disabled.

Parameters:

index - the tab index

Throws:

java.lang.IndexOutOfBoundsException

disableTab

public void disableTab(int index)
                throws java.lang.IndexOutOfBoundsException

Disable a tab if it is currently enabled. If the tab is selected, it is deselected.

Parameters:

index - the tab index

Throws:

java.lang.IndexOutOfBoundsException

getNumTabs

public final int getNumTabs()

State and tab query methods

getTabCount

public final int getTabCount()

getTab

public final Tab getTab(int tabIndex)

Returns the canvas representing a tab.

Parameters:

tabIndex - index of tab

Returns:

the tab widget or null if not found

getTab

public final Tab getTab(java.lang.String id)

getContainerFeatures

public ContainerFeatures getContainerFeatures()

**************************************************** Helper methods ****************************************************

Specified by:

getContainerFeatures in interface PanelContainer

addPanelHideHandler

public com.google.gwt.event.shared.HandlerRegistration addPanelHideHandler(PanelHideHandler handler)

Description copied from interface: HasPanelHideHandlers

Executed when the left mouse is clicked (pressed and then released) on this widget. No default implementation.

Specified by:

addPanelHideHandler in interface HasPanelHideHandlers

Parameters:

handler - the click handler

Returns:

HandlerRegistration used to remove this handler

addPanelShowHandler

public com.google.gwt.event.shared.HandlerRegistration addPanelShowHandler(PanelShowHandler handler)

Description copied from interface: HasPanelShowHandlers

Executed when the left mouse is clicked (pressed and then released) on this widget. No default implementation.

Specified by:

addPanelShowHandler in interface HasPanelShowHandlers

Parameters:

handler - the click handler

Returns:

HandlerRegistration used to remove this handler

setMoreTabCount

public void setMoreTabCount(int moreTabCount)

getMoreTabCount

public final int getMoreTabCount()

setShowMoreTab

public void setShowMoreTab(boolean showMoreTab)