public class TabSet extends Canvas implements HasCloseClickHandlers, HasTabContextMenuHandlers, HasTabDeselectedHandlers, HasTabIconClickHandlers, HasTabSelectedHandlers, HasTabsReorderedHandlers, HasTabTitleChangedHandlers
Tabs are configured via the tabs
property, each of which has a
pane
property which will be displayed in the main pane when that tab is selected.
config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName
Constructor and Description |
---|
TabSet() |
TabSet(com.google.gwt.core.client.JavaScriptObject jsObj) |
Modifier and Type | Method and Description |
---|---|
com.google.gwt.event.shared.HandlerRegistration |
addCloseClickHandler(CloseClickHandler handler)
Add a closeClick handler.
|
void |
addTab(Tab tab)
Add a tab
|
void |
addTab(Tab tab,
int position)
Add a tab
|
com.google.gwt.event.shared.HandlerRegistration |
addTabContextMenuHandler(TabContextMenuHandler handler)
Add a tabContextMenu handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addTabDeselectedHandler(TabDeselectedHandler handler)
Add a tabDeselected handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addTabIconClickHandler(TabIconClickHandler handler)
Add a tabIconClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addTabSelectedHandler(TabSelectedHandler handler)
Add a tabSelected handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addTabsReorderedHandler(TabsReorderedHandler handler)
Add a tabsReordered handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addTabTitleChangedHandler(TabTitleChangedHandler handler)
Add a tabTitleChanged handler.
|
void |
cancelTabTitleEditing()
If the user is currently editing a tab title (see
canEditTabTitles ), dismiss the editor and discard the edit value entered by the user. |
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
Changes the defaults for Canvas AutoChildren named
autoChildName . |
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
Changes the defaults for FormItem AutoChildren named
autoChildName . |
protected com.google.gwt.core.client.JavaScriptObject |
create() |
void |
disableTab(int tabIndex)
If the specified tab is enabled, disable it now.
|
void |
disableTab(java.lang.String ID)
If the specified tab is enabled, disable it now.
|
void |
disableTab(Tab tab)
If the specified tab is enabled, disable it now.
|
void |
editTabTitle(int tab)
Places an editor in the title of the parameter tab and allows the user to edit the title.
|
void |
editTabTitle(java.lang.String tab)
Places an editor in the title of the parameter tab and allows the user to edit the title.
|
void |
enableTab(int tabIndex)
If the specified tab is disabled, enable it now.
|
void |
enableTab(java.lang.String ID)
If the specified tab is disabled, enable it now.
|
void |
enableTab(Tab tab)
If the specified tab is disabled, enable it now.
|
java.lang.Boolean |
getAnimateTabScrolling()
If
showTabScroller is true, should tabs be scrolled
into view via an animation when the user interacts with the scroller buttons? |
java.lang.String |
getAriaCloseableSuffix()
When
screen reader mode is enabled and a tab is closeable , the ariaCloseableSuffix is a string that
is appended to the label of closeable tabs. |
java.lang.Boolean |
getCanCloseTabs()
Should tabs in this tabSet show an icon allowing the user to dismiss the tab by
clicking on it directly.
|
java.lang.Boolean |
getCanEditTabTitles()
If true, users can edit the titles of tabs in this TabSet when the
titleEditEvent fires. |
java.lang.Boolean |
getCanReorderTabs()
If true, tabs can be reordered by dragging on them.
|
java.lang.String |
getCloseTabIcon()
Default src for the close icon for tabs to display if
canCloseTabs is true. |
int |
getCloseTabIconSize()
Size in pixels of the icon for closing tabs, displayed when
canCloseTabs is true. |
java.lang.Integer |
getDefaultTabHeight()
|
java.lang.Integer |
getDefaultTabWidth()
|
java.lang.Boolean |
getDestroyPanes()
|
java.lang.String |
getEditProxyConstructor()
Default class used to construct the
EditProxy for this component when the component is
first placed into edit mode . |
java.lang.String |
getLocateTabsBy()
When
AutoTest.getElement() is used to parse locator strings
generated by AutoTest.getLocator() , how should tabs within this
tabset be identified? By default if tab has a specified ID this will
always be used. |
com.smartgwt.logicalstructure.core.LogicalStructureObject |
getLogicalStructure()
Getter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
Tab |
getMoreTab()
|
int |
getMoreTabCount()
This property defines the number tab buttons that should be shown before automatically adding a "more" button to handle
the remaining tabs.
|
java.lang.String |
getMoreTabImage()
If
showMoreTab is enabled this property determines the
image to display on the "More" tab button. |
VLayout |
getMoreTabPane()
Pane contents for the "more" tab based on a VLayout.
|
Canvas |
getMoreTabPaneDefaults()
Default properties for the "more" tab's pane.
|
Canvas |
getMoreTabPaneProperties()
Properties to apply to the "more" tab's pane created by this TabSet.
|
Tab |
getMoreTabProperties()
Properties to apply to the "more" tab created by this TabSet.
|
java.lang.String |
getMoreTabTitle()
Title for the "More" tab.
|
int |
getNumTabs()
The number of tabs
|
static TabSet |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
VLayout |
getPaneContainer()
Container where the component specified by
pane is shown. |
java.lang.String |
getPaneContainerClassName()
CSS style used for the paneContainer.
|
Overflow |
getPaneContainerOverflow()
Specifies the overflow of the pane container (the component that holds the pane contents for all tabs).
|
int |
getPaneMargin()
Space to leave around the panes in our paneContainer
|
java.lang.String |
getPickerButtonHSrc()
If
showTabPicker is true, and symmetricPickerButton is set to true, this property
governs the base URL for the picker button image, when displayed in a horizontal tab-bar [IE tabBarPosition is set to "top" or
"bottom" ]. |
int |
getPickerButtonSize()
If
showTabPicker is true and isTouch is false , this property governs the size of the tab
picker button. |
java.lang.String |
getPickerButtonSrc()
If
showTabPicker is true, this property governs the base
URL for the picker button image, when symmetricPickerButton is set to false |
java.lang.String |
getPickerButtonVSrc()
If
showTabPicker is true, and symmetricPickerButton is set to true, this property
governs the base URL for the picker button image, when displayed in a verricaL tab-bar [IE tabBarPosition is set to "LEFT" or
"right" ]. |
StretchImgButton |
getScroller()
A component containing back and forward buttons for scrolling through all of the tabs of the TabSet.
|
int |
getScrollerButtonSize()
If
showTabScroller is true, this property governs the
size of scroller buttons. |
java.lang.String |
getScrollerHSrc()
If this TabSet is showing
tab scroller buttons , and
symmetricScroller is true, this property governs the
base URL for the tab bar back and forward scroller button images for horizontal tab bars [IE for tab sets with tabBarPosition set to "top" or "bottom"]. |
java.lang.String |
getScrollerSrc()
If this TabSet is showing
tab scroller buttons , and
symmetricScroller is false, this property governs
the base URL for the tab bar back and forward scroller button images. |
java.lang.String |
getScrollerVSrc()
If this TabSet is showing
tab scroller buttons , and
symmetricScroller is true, this property governs the
base URL for the tab bar back and forward scroller button images for vertical tab bars [IE for tab sets with tabBarPosition set to "left" or "right"]. |
Tab |
getSelectedTab()
The currently selected tab.
|
int |
getSelectedTabNumber()
Returns the index of the currently selected tab object.
|
java.lang.Boolean |
getShowMoreTab()
Should tabs exceeding
moreTabCount be shown on a "more"
tab? |
java.lang.Boolean |
getShowPaneContainerEdges()
Should the paneContainer for this tabset show
edges . |
java.lang.Boolean |
getShowPartialEdges()
If the paneContainer for this tab set is showing
edges , setting
this attribute to true will set the paneContainer to show customEdges for the three sides opposing the tabBarPosition. |
java.lang.Boolean |
getShowTabPicker()
If there is not enough space to display all the tab-buttons in this tabSet, should a drop-down "picker" be displayed to
allow selection of tabs that are clipped?
|
java.lang.Boolean |
getShowTabScroller()
If there is not enough space to display all the tab-buttons in this tabSet, should scroller buttons be displayed to
allow access to tabs that are clipped?
|
java.lang.String |
getSimpleTabBaseStyle()
If this.useSimpleTabs is true, simpleTabBaseClass will be the base style used to determine the css style to apply to
the tabs.
This property will be suffixed with the side on which the tab-bar will appear, followed by with the tab's state (selected, over, etc), resolving to a className like "tabButtonTopOver" |
java.lang.String |
getSkinImgDir()
Default directory for skin images (those defined by the class), relative to the Page-wide
skinDir . |
java.lang.Boolean |
getSymmetricEdges()
If this tabSet will
show edges for the
paneContainer, this property determines whether the same edge media will be used regardless of the tab bar position, or
whether different media should be used (necessary if the edge appearance is not symmetrical on all sides). |
java.lang.Boolean |
getSymmetricPickerButton()
If this TabSet is showing a
tab picker button , this
property determines whether the pickerButtonHSrc and
pickerButtonVSrc media will be used for vertical and
horizontal tab-bar picker buttons, or whether separate media should be used for each possible tabBarPosition based on the pickerButtonSrc property for this tabSet. |
java.lang.Boolean |
getSymmetricScroller()
If this TabSet is showing
tab scroller buttons , this
property determines whether the scrollerHSrc and scrollerVSrc media will be used for vertical and horizontal
tab-bar scroller buttons, or whether separate media should be used for each possible tabBarPosition based on the scrollerSrc property for this tabSet. |
Tab |
getTab(int tabIndex)
Retrieves a Tab definition from within this tabSet by index.
|
Tab |
getTab(java.lang.String ID)
Retrieves a Tab definition from within this tabSet by ID.
|
TabBar |
getTabBar()
TabBar for this TabSet, an instance of
TabBar . |
Side |
getTabBarAlign()
Alignment of the tabBar.
|
Alignment |
getTabBarAlignAsAlignment()
Alignment of the tabBar.
|
Layout |
getTabBarControlLayout()
com.smartgwt.client.types.AutoChild of type Layout that holds the
tabBarControls as well as the built-in controls such as
the tab picker menu . |
Side |
getTabBarPosition()
Which side of the TabSet the TabBar should appear on.
|
int |
getTabBarThickness()
Thickness of tabBar, applies to either orientation (specifies height for horizontal, width for vertical orientation).
|
StatefulCanvas |
getTabCanvas(int tabIndex)
Get the live Canvas representing a tab by index.
|
StatefulCanvas |
getTabCanvas(java.lang.String ID)
Get the live Canvas representing a tab by index.
|
int |
getTabNumber(java.lang.String ID)
Get the index of a tab from the tabID.
|
ImgButton |
getTabPicker()
A button control that allows tabs to be picked directly from a popup menu.
|
Tab[] |
getTabs()
The tabs
|
TabTitleEditEvent |
getTitleEditEvent()
The event that triggers title editing on this TabSet.
|
TextItem |
getTitleEditor()
TextItem we use to edit tab titles in this TabSet.
|
java.lang.Integer |
getTitleEditorLeftOffset()
If set, offsets the tab title editor further in from the left-hand edge of the tab, by the number of pixels set in this
property.
|
TextItem |
getTitleEditorProperties()
Properties for the auto-generated
titleEditor . |
java.lang.Integer |
getTitleEditorRightOffset()
If set, offsets the tab title editor further in from the right-hand edge of the tab, by the number of pixels set in this
property.
|
java.lang.Integer |
getTitleEditorTopOffset()
If set, offsets the tab title editor further down from the top edge of the tab, by the number of pixels set in this
property.
|
int |
getTouchPickerButtonSize()
The size of the tab picker button when
isTouch is true . |
java.lang.Boolean |
getUseIOSTabs()
Setting this to true turns on a different appearance for tabs, similar to iOS tabs from the "Music" app, where the
tab.icon is enlarged and shown as a black and white mask.
|
java.lang.Boolean |
getUseSimpleTabs()
Should we use simple button based tabs styled with CSS rather than image based
ImgTab tabs? |
static void |
preloadImages()
Preload primary tab skin images.
|
void |
removeTab(int tabIndex)
Remove a tab.
|
void |
removeTab(java.lang.String ID)
Remove a tab.
|
void |
removeTab(Tab tab)
Remove a tab.
|
void |
removeTabs(int[] tabIndexes)
Remove one or more tabs.
|
void |
removeTabs(java.lang.String[] ids)
Remove one or more tabs.
|
void |
reorderTab(Tab tab)
Move a tab to another location in the tabset.
|
void |
reorderTab(Tab tab,
int moveToPosition)
Move a tab to another location in the tabset.
|
void |
saveTabTitle()
If the user is currently editing a tab title (see
canEditTabTitles ), save the edited tab title and hide the editor. |
void |
scrollBack()
If there is not enough space to display all the tabs in this tabSet, this method will scroll the previous tab (that
first tab that is clipped at the beginning of the tab-bar) into view.
|
void |
scrollForward()
If there is not enough space to display all the tabs in this tabSet, this method will scroll the next tab (that first
tab that is clipped at the end of the tab-bar) into view.
|
void |
selectTab(int tabIndex)
Select a tab.
|
void |
selectTab(java.lang.String ID)
Select a tab.
|
void |
selectTab(Tab tab)
Select a tab.
|
void |
setAnimateTabScrolling(java.lang.Boolean animateTabScrolling)
If
showTabScroller is true, should tabs be scrolled
into view via an animation when the user interacts with the scroller buttons? |
void |
setAriaCloseableSuffix(java.lang.String ariaCloseableSuffix)
When
screen reader mode is enabled and a tab is closeable , the ariaCloseableSuffix is a string that
is appended to the label of closeable tabs. |
void |
setCanCloseTab(Tab tab,
boolean canClose)
Sets the given tab's
canClose property to the boolean parameter
canClose. |
void |
setCanCloseTabs(java.lang.Boolean canCloseTabs)
Should tabs in this tabSet show an icon allowing the user to dismiss the tab by
clicking on it directly.
|
void |
setCanEditTabTitles(java.lang.Boolean canEditTabTitles)
If true, users can edit the titles of tabs in this TabSet when the
titleEditEvent fires. |
void |
setCanReorderTabs(java.lang.Boolean canReorderTabs)
If true, tabs can be reordered by dragging on them.
|
void |
setCloseTabIcon(java.lang.String closeTabIcon)
Default src for the close icon for tabs to display if
canCloseTabs is true. |
void |
setCloseTabIconSize(int closeTabIconSize)
Size in pixels of the icon for closing tabs, displayed when
canCloseTabs is true. |
static void |
setDefaultProperties(TabSet tabSetProperties)
Class level method to set the default properties of this class.
|
void |
setDefaultTabHeight(java.lang.Integer defaultTabHeight)
|
void |
setDefaultTabWidth(java.lang.Integer defaultTabWidth)
|
void |
setDestroyPanes(java.lang.Boolean destroyPanes)
|
void |
setEditProxyConstructor(java.lang.String editProxyConstructor)
Default class used to construct the
EditProxy for this component when the component is
first placed into edit mode . |
void |
setLocateTabsBy(java.lang.String locateTabsBy)
When
AutoTest.getElement() is used to parse locator strings
generated by AutoTest.getLocator() , how should tabs within this
tabset be identified? By default if tab has a specified ID this will
always be used. |
com.smartgwt.logicalstructure.core.LogicalStructureObject |
setLogicalStructure(com.smartgwt.logicalstructure.widgets.tab.TabSetLogicalStructure s)
Setter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
void |
setMoreTabCount(int moreTabCount)
This property defines the number tab buttons that should be shown before automatically adding a "more" button to handle
the remaining tabs.
|
void |
setMoreTabImage(java.lang.String moreTabImage)
If
showMoreTab is enabled this property determines the
image to display on the "More" tab button. |
void |
setMoreTabPaneDefaults(Canvas moreTabPaneDefaults)
Default properties for the "more" tab's pane.
|
void |
setMoreTabPaneProperties(Canvas moreTabPaneProperties)
Properties to apply to the "more" tab's pane created by this TabSet.
|
void |
setMoreTabProperties(Tab moreTabProperties)
Properties to apply to the "more" tab created by this TabSet.
|
void |
setMoreTabTitle(java.lang.String moreTabTitle)
Title for the "More" tab.
|
void |
setPaneContainerClassName(java.lang.String paneContainerClassName)
CSS style used for the paneContainer.
|
void |
setPaneContainerOverflow(Overflow paneContainerOverflow)
Specifies the overflow of the pane container (the component that holds the pane contents for all tabs).
|
void |
setPaneContainerProperties(Canvas paneContainerProperties)
Properties of the container where the component specified by Tab.pane is shown.
|
void |
setPaneMargin(int paneMargin)
Space to leave around the panes in our paneContainer
|
void |
setPickerButtonHSrc(java.lang.String pickerButtonHSrc)
If
showTabPicker is true, and symmetricPickerButton is set to true, this property
governs the base URL for the picker button image, when displayed in a horizontal tab-bar [IE tabBarPosition is set to "top" or
"bottom" ]. |
void |
setPickerButtonSize(int pickerButtonSize)
If
showTabPicker is true and isTouch is false , this property governs the size of the tab
picker button. |
void |
setPickerButtonSrc(java.lang.String pickerButtonSrc)
If
showTabPicker is true, this property governs the base
URL for the picker button image, when symmetricPickerButton is set to false |
void |
setPickerButtonVSrc(java.lang.String pickerButtonVSrc)
If
showTabPicker is true, and symmetricPickerButton is set to true, this property
governs the base URL for the picker button image, when displayed in a verricaL tab-bar [IE tabBarPosition is set to "LEFT" or
"right" ]. |
void |
setScrollerButtonSize(int scrollerButtonSize)
If
showTabScroller is true, this property governs the
size of scroller buttons. |
void |
setScrollerHSrc(java.lang.String scrollerHSrc)
If this TabSet is showing
tab scroller buttons , and
symmetricScroller is true, this property governs the
base URL for the tab bar back and forward scroller button images for horizontal tab bars [IE for tab sets with tabBarPosition set to "top" or "bottom"]. |
void |
setScrollerSrc(java.lang.String scrollerSrc)
If this TabSet is showing
tab scroller buttons , and
symmetricScroller is false, this property governs
the base URL for the tab bar back and forward scroller button images. |
void |
setScrollerVSrc(java.lang.String scrollerVSrc)
If this TabSet is showing
tab scroller buttons , and
symmetricScroller is true, this property governs the
base URL for the tab bar back and forward scroller button images for vertical tab bars [IE for tab sets with tabBarPosition set to "left" or "right"]. |
void |
setSelectedTab(int selectedTab)
Specifies the index of the initially selected tab.
|
void |
setShowMoreTab(java.lang.Boolean showMoreTab)
Should tabs exceeding
moreTabCount be shown on a "more"
tab? |
void |
setShowPaneContainerEdges(java.lang.Boolean showPaneContainerEdges)
Should the paneContainer for this tabset show
edges . |
void |
setShowPartialEdges(java.lang.Boolean showPartialEdges)
If the paneContainer for this tab set is showing
edges , setting
this attribute to true will set the paneContainer to show customEdges for the three sides opposing the tabBarPosition. |
void |
setShowTabPicker(java.lang.Boolean showTabPicker)
If there is not enough space to display all the tab-buttons in this tabSet, should a drop-down "picker" be displayed to
allow selection of tabs that are clipped?
|
void |
setShowTabScroller(java.lang.Boolean showTabScroller)
If there is not enough space to display all the tab-buttons in this tabSet, should scroller buttons be displayed to
allow access to tabs that are clipped?
|
void |
setSimpleTabBaseStyle(java.lang.String simpleTabBaseStyle)
If this.useSimpleTabs is true, simpleTabBaseClass will be the base style used to determine the css style to apply to
the tabs.
This property will be suffixed with the side on which the tab-bar will appear, followed by with the tab's state (selected, over, etc), resolving to a className like "tabButtonTopOver" |
void |
setSkinImgDir(java.lang.String skinImgDir)
Default directory for skin images (those defined by the class), relative to the Page-wide
skinDir . |
void |
setSymmetricEdges(java.lang.Boolean symmetricEdges)
If this tabSet will
show edges for the
paneContainer, this property determines whether the same edge media will be used regardless of the tab bar position, or
whether different media should be used (necessary if the edge appearance is not symmetrical on all sides). |
void |
setSymmetricPickerButton(java.lang.Boolean symmetricPickerButton)
If this TabSet is showing a
tab picker button , this
property determines whether the pickerButtonHSrc and
pickerButtonVSrc media will be used for vertical and
horizontal tab-bar picker buttons, or whether separate media should be used for each possible tabBarPosition based on the pickerButtonSrc property for this tabSet. |
void |
setSymmetricScroller(java.lang.Boolean symmetricScroller)
If this TabSet is showing
tab scroller buttons , this
property determines whether the scrollerHSrc and scrollerVSrc media will be used for vertical and horizontal
tab-bar scroller buttons, or whether separate media should be used for each possible tabBarPosition based on the scrollerSrc property for this tabSet. |
void |
setTabBarAlign(Alignment tabBarAlign)
Alignment of the tabBar.
|
void |
setTabBarAlign(Side tabBarAlign)
Alignment of the tabBar.
|
void |
setTabBarControls(java.lang.Object... tabBarControls)
This property determines what controls should show up after the tabBar for this TabSet.
|
void |
setTabBarPosition(Side tabBarPosition)
Which side of the TabSet the TabBar should appear on.
|
void |
setTabBarProperties(TabBar tabBarProperties)
This attribute allows developers to specify custom properties for this tabset's
tabBar |
void |
setTabBarThickness(int tabBarThickness)
Thickness of tabBar, applies to either orientation (specifies height for horizontal, width for vertical orientation).
|
void |
setTabIcon(int tabIndex,
java.lang.String iconURL)
Changes the icon of a tab
|
void |
setTabIcon(java.lang.String ID,
java.lang.String iconURL)
Changes the icon of a tab
|
void |
setTabIcon(Tab tab,
java.lang.String iconURL)
Changes the icon of a tab
|
void |
setTabPane(int tabIndex,
Canvas pane)
Apply a new
pane to an existing tab in this tabSet |
void |
setTabPane(java.lang.String tabID,
Canvas pane)
Apply a new
pane to an existing tab in this tabSet |
void |
setTabs(Tab... tabs)
An array of
Tab objects, specifying the title
and pane contents of each tab in the TabSet. |
void |
setTabTitle(int tabIndex,
java.lang.String title)
Changes the title of a tab
|
void |
setTabTitle(java.lang.String ID,
java.lang.String title)
Changes the title of a tab
|
void |
setTabTitle(Tab tab,
java.lang.String title)
Changes the title of a tab
|
void |
setTitleEditEvent(TabTitleEditEvent titleEditEvent)
The event that triggers title editing on this TabSet.
|
void |
setTitleEditorLeftOffset(java.lang.Integer titleEditorLeftOffset)
If set, offsets the tab title editor further in from the left-hand edge of the tab, by the number of pixels set in this
property.
|
void |
setTitleEditorProperties(TextItem titleEditorProperties)
Properties for the auto-generated
titleEditor . |
void |
setTitleEditorRightOffset(java.lang.Integer titleEditorRightOffset)
If set, offsets the tab title editor further in from the right-hand edge of the tab, by the number of pixels set in this
property.
|
void |
setTitleEditorTopOffset(java.lang.Integer titleEditorTopOffset)
If set, offsets the tab title editor further down from the top edge of the tab, by the number of pixels set in this
property.
|
void |
setTouchPickerButtonSize(int touchPickerButtonSize)
The size of the tab picker button when
isTouch is true . |
void |
setUseIOSTabs(java.lang.Boolean useIOSTabs)
Setting this to true turns on a different appearance for tabs, similar to iOS tabs from the "Music" app, where the
tab.icon is enlarged and shown as a black and white mask.
|
void |
setUseSimpleTabs(java.lang.Boolean useSimpleTabs)
Should we use simple button based tabs styled with CSS rather than image based
ImgTab tabs? |
Tab |
tabForPane(Canvas pane)
Search for a tab that contains a pane.
|
void |
updateTab(int tabIndex,
Canvas pane)
Set the pane for a tab.
|
void |
updateTab(Tab tab,
Canvas pane)
Set the pane for a tab.
|
addChild, addChild, addChild, addChild, addChild, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, deparent, depeer, disable, enable, encloses, focus, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAutoDraw, getAutoMaskComponents, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFormItemAutoChild, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getKeepInParentRect, getLayoutAlign, getLeavePageSpace, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentCanvas, getParentElement, getPeers, getPercentBox, getPercentSource, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getStyleName, getTabIndex, getTestInstance, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUseBackMask, getUseDragMask, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isFocused, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, onInit, parentResized, printComponents, redraw, redraw, removeChild, removeChild, removePeer, removePeer, resizeBy, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAlign, setAllowExternalFilters, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoDraw, setAutoHeight, setAutoMaskComponents, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setExtraSpace, setFacetId, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeavePageSpace, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setParentCanvas, setParentElement, setPeers, setPercentBox, setPercentSource, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setScrollbarConstructor, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setStyleName, setTabIndex, setTitle, setTooltip, setTop, setTop, setUseBackMask, setUseDragMask, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateEditNode, updateHover, updateHover, updateShadow, visibleAtPoint, willAcceptDrop
addDrawHandler, applyFactoryProperties, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isFactoryCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents
public TabSet()
public TabSet(com.google.gwt.core.client.JavaScriptObject jsObj)
public static TabSet getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public static void changeAutoChildDefaults(java.lang.String autoChildName, Canvas defaults)
autoChildName
.autoChildName
- name of an AutoChild to customize the defaults for.defaults
- Canvas defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties.AutoChildUsage
public static void changeAutoChildDefaults(java.lang.String autoChildName, FormItem defaults)
autoChildName
.autoChildName
- name of an AutoChild to customize the defaults for.defaults
- FormItem defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties.AutoChildUsage
protected com.google.gwt.core.client.JavaScriptObject create()
public void setAnimateTabScrolling(java.lang.Boolean animateTabScrolling) throws java.lang.IllegalStateException
showTabScroller
is true, should tabs be scrolled
into view via an animation when the user interacts with the scroller buttons?animateTabScrolling
- Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getAnimateTabScrolling()
showTabScroller
is true, should tabs be scrolled
into view via an animation when the user interacts with the scroller buttons?public void setAriaCloseableSuffix(java.lang.String ariaCloseableSuffix) throws java.lang.IllegalStateException
screen reader mode
is enabled and a tab is closeable
, the ariaCloseableSuffix
is a string that
is appended to the label of closeable tabs. This suffix is hidden from sighted users, but is announced by screen readers
to indicate that the tab may be closed. Set to null
to disable appending this suffix.
Note : This is an advanced setting
ariaCloseableSuffix
- Default value is ", closeable"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getAriaCloseableSuffix()
screen reader mode
is enabled and a tab is closeable
, the ariaCloseableSuffix
is a string that
is appended to the label of closeable tabs. This suffix is hidden from sighted users, but is announced by screen readers
to indicate that the tab may be closed. Set to null
to disable appending this suffix.
public void setCanCloseTabs(java.lang.Boolean canCloseTabs)
canClose
.
The URL for this icon's image will be derived from closeTabIcon
by
default, but may be overridden by explicitly specifying closeIcon
.
Note: Currently, tabs can only show a single icon, so a closable tab will show
the close icon only even if icon
is set. To work around this, add
the icon
as an HTML <img> tag to the title
property, for example:
tab.setTitle("<span>" + Canvas.imgHTML("path/to/icon.png") + " Tab Title</span>");
canCloseTabs
property.canCloseTabs
- the new value for canCloseTabs.. Default value is nullcom.smartgwt.client.widgets.tab.TabSet#closeClick
public java.lang.Boolean getCanCloseTabs()
canClose
.
The URL for this icon's image will be derived from closeTabIcon
by
default, but may be overridden by explicitly specifying closeIcon
.
Note: Currently, tabs can only show a single icon, so a closable tab will show
the close icon only even if icon
is set. To work around this, add
the icon
as an HTML <img> tag to the title
property, for example:
tab.setTitle("<span>" + Canvas.imgHTML("path/to/icon.png") + " Tab Title</span>");
com.smartgwt.client.widgets.tab.TabSet#closeClick
public void setCanEditTabTitles(java.lang.Boolean canEditTabTitles)
titleEditEvent
fires. You can override this behavior per tab
with the canEditTitle
property. Note that this TabSet's
titleEditEvent
must be set to a supported TabTitleEditEvent
in order for users to be able to edit the titles of tabs.
canEditTabTitles
- Default value is falsepublic java.lang.Boolean getCanEditTabTitles()
titleEditEvent
fires. You can override this behavior per tab
with the canEditTitle
property. Note that this TabSet's
titleEditEvent
must be set to a supported TabTitleEditEvent
in order for users to be able to edit the titles of tabs.
public void setCanReorderTabs(java.lang.Boolean canReorderTabs) throws java.lang.IllegalStateException
To disallow drag-reorder of a specific tab, see canReorder
.
canReorderTabs
- Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdDragdrop overview and related methods
public java.lang.Boolean getCanReorderTabs()
To disallow drag-reorder of a specific tab, see canReorder
.
Dragdrop overview and related methods
public void setCloseTabIcon(java.lang.String closeTabIcon) throws java.lang.IllegalStateException
canCloseTabs
is true.closeTabIcon
- See SCImgURL
. Default value is [SKIN]/TabSet/close.pngjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getCloseTabIcon()
canCloseTabs
is true.SCImgURL
public void setCloseTabIconSize(int closeTabIconSize) throws java.lang.IllegalStateException
canCloseTabs
is true.closeTabIconSize
- Default value is 16java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getCloseTabIconSize()
canCloseTabs
is true.public void setDefaultTabHeight(java.lang.Integer defaultTabHeight) throws java.lang.IllegalStateException
tabBarPosition
is set to "left"
or "right"
. If unset, height will be picked up from the
Tab constructor class defaults. Note that tabs expand to fit their content so this height acts as a minimum. May be
customized by individual skins
.
defaultTabHeight
- Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getDefaultTabHeight()
tabBarPosition
is set to "left"
or "right"
. If unset, height will be picked up from the
Tab constructor class defaults. Note that tabs expand to fit their content so this height acts as a minimum. May be
customized by individual skins
.
public void setDefaultTabWidth(java.lang.Integer defaultTabWidth) throws java.lang.IllegalStateException
tabBarPosition
is set to "top"
or "bottom"
. If unset, width will be picked up from the
Tab constructor class defaults. Tabs expand to fit their content, so this width acts as a minimum. Setting width:1 will
result in tabs that are only as wide as their titles. May be customized by individual skins
.
defaultTabWidth
- Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getDefaultTabWidth()
tabBarPosition
is set to "top"
or "bottom"
. If unset, width will be picked up from the
Tab constructor class defaults. Tabs expand to fit their content, so this width acts as a minimum. Setting width:1 will
result in tabs that are only as wide as their titles. May be customized by individual skins
.
public void setDestroyPanes(java.lang.Boolean destroyPanes) throws java.lang.IllegalStateException
destroy()
should be called on pane
when it a tab is removed via TabSet.removeTab()
. With the default setting of
null
panes will be automatically destroyed. An application might set this to false in order to re-use panes
in different tabs or in different parts of the application.
destroyPanes
- Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getDestroyPanes()
destroy()
should be called on pane
when it a tab is removed via TabSet.removeTab()
. With the default setting of
null
panes will be automatically destroyed. An application might set this to false in order to re-use panes
in different tabs or in different parts of the application.
public void setEditProxyConstructor(java.lang.String editProxyConstructor) throws java.lang.IllegalStateException
EditProxy
for this component when the component is
first placed into edit mode
.setEditProxyConstructor
in class Canvas
editProxyConstructor
- See SCClassName
. Default value is "TabSetEditProxy"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getEditProxyConstructor()
EditProxy
for this component when the component is
first placed into edit mode
.getEditProxyConstructor
in class Canvas
SCClassName
public void setLocateTabsBy(java.lang.String locateTabsBy)
AutoTest.getElement()
is used to parse locator strings
generated by AutoTest.getLocator()
, how should tabs within this
tabset be identified? By default if tab has a specified ID
this will
always be used. For tabs with no ID, the following options are available: "title"
use the title as
an identifier"index"
use the index of the tab in the tabset as an identifierNote : This is an advanced setting
locateTabsBy
- Default value is nullpublic java.lang.String getLocateTabsBy()
AutoTest.getElement()
is used to parse locator strings
generated by AutoTest.getLocator()
, how should tabs within this
tabset be identified? By default if tab has a specified ID
this will
always be used. For tabs with no ID, the following options are available: "title"
use the title as
an identifier"index"
use the index of the tab in the tabset as an identifierpublic Tab getMoreTab() throws java.lang.IllegalStateException
Tab
to be shown when showMoreTab
is enabled more than moreTabCount
tabs are provided.
For an overview of how to use and configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public void setMoreTabCount(int moreTabCount) throws java.lang.IllegalStateException
showMoreTab
is enabled.moreTabCount
- Default value is 5java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getMoreTabCount()
showMoreTab
is enabled.public void setMoreTabImage(java.lang.String moreTabImage) throws java.lang.IllegalStateException
showMoreTab
is enabled this property determines the
image to display on the "More" tab button.moreTabImage
- See SCImgURL
. Default value is "[SKINIMG]/iOS/more.png"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getMoreTabImage()
showMoreTab
is enabled this property determines the
image to display on the "More" tab button.SCImgURL
public VLayout getMoreTabPane() throws java.lang.IllegalStateException
NavigationBar
and TableView
.
For an overview of how to use and configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public void setMoreTabPaneDefaults(Canvas moreTabPaneDefaults) throws java.lang.IllegalStateException
Currently constructs a VLayout with a NavigationBar
and TableView
.
moreTabPaneDefaults
- Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic Canvas getMoreTabPaneDefaults()
Currently constructs a VLayout with a NavigationBar
and TableView
.
public void setMoreTabPaneProperties(Canvas moreTabPaneProperties) throws java.lang.IllegalStateException
moreTabPaneProperties
- Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic Canvas getMoreTabPaneProperties()
public void setMoreTabProperties(Tab moreTabProperties) throws java.lang.IllegalStateException
moreTabProperties
- Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic Tab getMoreTabProperties()
public void setMoreTabTitle(java.lang.String moreTabTitle) throws java.lang.IllegalStateException
moreTabTitle
- Default value is "More"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getMoreTabTitle()
public VLayout getPaneContainer() throws java.lang.IllegalStateException
pane
is shown.
Note: paneContainer and showEdges:true for rounded tabsets: you can enable decorative
image-based edges on the paneContainer by setting showEdges:true
via paneContainerDefaults (to skin all tabsets) or paneContainerProperties (to use
edges on one instance). In this structure, the BaseLine
should use media
that matches the appearance of the decorative edges and fully overlaps the edge of the
paneContainer that it is adjacent to. In the most typical appearance (symmetric edges
on all 4 sides), both baseLineCapSize
and baseLineThickness
match the edgeSize
set on the paneContainer. See the
load_skin.js file for the "Smart GWT" skin for an example of setting all relevant
properties.
To disable edges for a particular TabSet, which you may want to do for a TabSet that is already within a clearly defined container, configure the paneContainer to show only it's top edge:
paneContainerProperties : { customEdges:["T"] },To completely flatten even the top edge of the TabSet:
paneContainerProperties : { customEdges:["T"] }, tabBarProperties :{ baseLineCapSize:0 },This "flattens" the baseLine so that only the center image is used.
For an overview of how to use and configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public void setPaneContainerClassName(java.lang.String paneContainerClassName)
paneContainerClassName
- See CSSStyleName
. Default value is nullpublic java.lang.String getPaneContainerClassName()
CSSStyleName
public void setPaneContainerOverflow(Overflow paneContainerOverflow)
For other values and their meaning, see Overflow
If this method is called after the component has been drawn/initialized:
Update paneContainerOverflow
after creation.
Note : This is an advanced setting
paneContainerOverflow
- new overflow setting. Default value is Canvas.AUTOpublic Overflow getPaneContainerOverflow()
For other values and their meaning, see Overflow
public void setPaneMargin(int paneMargin) throws java.lang.IllegalStateException
Note that this property may be specified on a per-tab basis via
paneMargin
.
paneMargin
- Default value is 0java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getPaneMargin()
Note that this property may be specified on a per-tab basis via
paneMargin
.
public void setPickerButtonHSrc(java.lang.String pickerButtonHSrc) throws java.lang.IllegalStateException
showTabPicker
is true, and symmetricPickerButton
is set to true, this property
governs the base URL for the picker button image, when displayed in a horizontal tab-bar [IE tabBarPosition
is set to "top"
or
"bottom"
]. Note that if symmetricPickerButton
is false, the pickerButtonSrc
property will be used instead.
This base
URL will have a suffix of "Down"
appended when the user holds the mouse down over the button, and
"Disabled"
if the tabset as a whole is disabled.
pickerButtonHSrc
- See SCImgURL
. Default value is "[SKIN]hpicker.gif"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetSymmetricPickerButton(java.lang.Boolean)
public java.lang.String getPickerButtonHSrc()
showTabPicker
is true, and symmetricPickerButton
is set to true, this property
governs the base URL for the picker button image, when displayed in a horizontal tab-bar [IE tabBarPosition
is set to "top"
or
"bottom"
]. Note that if symmetricPickerButton
is false, the pickerButtonSrc
property will be used instead.
This base
URL will have a suffix of "Down"
appended when the user holds the mouse down over the button, and
"Disabled"
if the tabset as a whole is disabled.
SCImgURL
getSymmetricPickerButton()
public void setPickerButtonSize(int pickerButtonSize) throws java.lang.IllegalStateException
showTabPicker
is true
and isTouch
is false
, this property governs the size of the tab
picker button. This value is applied as the width of the tab picker button if the tabBar
is horizontal, or the height if the tabBar
is
vertical. Note that the other dimension is determined by this.tabBarThickness
. On touch browsers (where isTouch
is true
), touchPickerButtonSize
is used instead.
pickerButtonSize
- Default value is 16java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getPickerButtonSize()
showTabPicker
is true
and isTouch
is false
, this property governs the size of the tab
picker button. This value is applied as the width of the tab picker button if the tabBar
is horizontal, or the height if the tabBar
is
vertical. Note that the other dimension is determined by this.tabBarThickness
. On touch browsers (where isTouch
is true
), touchPickerButtonSize
is used instead.
public void setPickerButtonSrc(java.lang.String pickerButtonSrc) throws java.lang.IllegalStateException
showTabPicker
is true, this property governs the base
URL for the picker button image, when symmetricPickerButton
is set to false Note that if symmetricPickerButton
is true, the pickerButtonHSrc
and pickerButtonVSrc
properties will be used instead.
To get the path to the image to display, this base URL will be modified as follows:
"Down"
or "Disabled"
will be appended.tabBarPosition
for this tabSet will be appended.pickerButtonSrc
- See SCImgURL
. Default value is "[SKIN]/picker.gif"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetSymmetricPickerButton(java.lang.Boolean)
public java.lang.String getPickerButtonSrc()
showTabPicker
is true, this property governs the base
URL for the picker button image, when symmetricPickerButton
is set to false Note that if symmetricPickerButton
is true, the pickerButtonHSrc
and pickerButtonVSrc
properties will be used instead.
To get the path to the image to display, this base URL will be modified as follows:
"Down"
or "Disabled"
will be appended.tabBarPosition
for this tabSet will be appended.SCImgURL
getSymmetricPickerButton()
public void setPickerButtonVSrc(java.lang.String pickerButtonVSrc) throws java.lang.IllegalStateException
showTabPicker
is true, and symmetricPickerButton
is set to true, this property
governs the base URL for the picker button image, when displayed in a verricaL tab-bar [IE tabBarPosition
is set to "LEFT"
or
"right"
]. Note that if symmetricPickerButton
is false, the pickerButtonSrc
property will be used instead.
This base
URL will have a suffix of "Down"
appended when the user holds the mouse down over the button, and
"Disabled"
if the tabset as a whole is disabled.
pickerButtonVSrc
- See SCImgURL
. Default value is "[SKIN]vpicker.gif"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetSymmetricPickerButton(java.lang.Boolean)
public java.lang.String getPickerButtonVSrc()
showTabPicker
is true, and symmetricPickerButton
is set to true, this property
governs the base URL for the picker button image, when displayed in a verricaL tab-bar [IE tabBarPosition
is set to "LEFT"
or
"right"
]. Note that if symmetricPickerButton
is false, the pickerButtonSrc
property will be used instead.
This base
URL will have a suffix of "Down"
appended when the user holds the mouse down over the button, and
"Disabled"
if the tabset as a whole is disabled.
SCImgURL
getSymmetricPickerButton()
public StretchImgButton getScroller() throws java.lang.IllegalStateException
"tabScroller"
is specified in the tabBarControls
. By default, the scroller constructor is
StretchImgButton
. Note that the scroller items
are determined automatically, so any items set in
scrollerProperties will be ignored.
For an overview of how to use and configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public void setScrollerButtonSize(int scrollerButtonSize) throws java.lang.IllegalStateException
showTabScroller
is true, this property governs the
size of scroller buttons. Applied as the width of buttons if the tabBar is horizontal, or the height if tabBar is
vertical. Note that the other dimension is determined by this.tabBarThickness
scrollerButtonSize
- Default value is 16java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getScrollerButtonSize()
showTabScroller
is true, this property governs the
size of scroller buttons. Applied as the width of buttons if the tabBar is horizontal, or the height if tabBar is
vertical. Note that the other dimension is determined by this.tabBarThickness
public void setScrollerHSrc(java.lang.String scrollerHSrc) throws java.lang.IllegalStateException
tab scroller buttons
, and
symmetricScroller
is true, this property governs the
base URL for the tab bar back and forward scroller button images for horizontal tab bars [IE for tab sets with tabBarPosition
set to "top" or "bottom"]. Note that if
symmetricScroller
is false, scrollerSrc
will be used instead.
To get the path to the image to display, this base URL will be modified as follows:
"Down"
or "Disabled"
will be appended."forward"
or
"back"
will be appended for the forward or backward scrolling button."[SKIN]hscroll.gif"
, the image displayed for the back-scroller button on a tabSet
with tabBarPosition
set to "top" and symmetricScroller
set to true would be one of
"[SKIN]hscroll_back.gif"
, "[SKIN]hscroll_Down_back.gif"
, and
"[SKIN]hscroll_Disabled_back.gif"
. Note that for best results the media should be sized to match the
scroller button sizes, determined by tabBarThickness
and scrollerButtonSize
.
scrollerHSrc
- See SCImgURL
. Default value is "[SKIN]hscroll.gif"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetSymmetricScroller(java.lang.Boolean)
public java.lang.String getScrollerHSrc()
tab scroller buttons
, and
symmetricScroller
is true, this property governs the
base URL for the tab bar back and forward scroller button images for horizontal tab bars [IE for tab sets with tabBarPosition
set to "top" or "bottom"]. Note that if
symmetricScroller
is false, scrollerSrc
will be used instead.
To get the path to the image to display, this base URL will be modified as follows:
"Down"
or "Disabled"
will be appended."forward"
or
"back"
will be appended for the forward or backward scrolling button."[SKIN]hscroll.gif"
, the image displayed for the back-scroller button on a tabSet
with tabBarPosition
set to "top" and symmetricScroller
set to true would be one of
"[SKIN]hscroll_back.gif"
, "[SKIN]hscroll_Down_back.gif"
, and
"[SKIN]hscroll_Disabled_back.gif"
. Note that for best results the media should be sized to match the
scroller button sizes, determined by tabBarThickness
and scrollerButtonSize
.
SCImgURL
getSymmetricScroller()
public void setScrollerSrc(java.lang.String scrollerSrc) throws java.lang.IllegalStateException
tab scroller buttons
, and
symmetricScroller
is false, this property governs
the base URL for the tab bar back and forward scroller button images. Note that if symmetricScroller
is true, scrollerHSrc
and scrollerVSrc
will be used instead.
To get the path to the image to display, this base URL will be modified as follows:
"Down"
or "Disabled"
will be appended.tabBarPosition
for this tabSet will be appended."forward"
or "back"
will be appended for the forward or backward scrolling
button."[SKIN]scroll.gif"
, the image displayed for
the back-scroller button on a tabSet with tabBarPosition
set to "top" and symmetricScroller
set to false would be one of "[SKIN]scroll_top_back.gif"
, "[SKIN]scroll_Down_top_back.gif"
,
and "[SKIN]scroll_Disabled_top_back.gif"
. Note that for best results the media should be sized to match
the scroller button sizes, determined by tabBarThickness
and scrollerButtonSize
.
scrollerSrc
- See SCImgURL
. Default value is "[SKIN]/scroll.gif"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetSymmetricScroller(java.lang.Boolean)
public java.lang.String getScrollerSrc()
tab scroller buttons
, and
symmetricScroller
is false, this property governs
the base URL for the tab bar back and forward scroller button images. Note that if symmetricScroller
is true, scrollerHSrc
and scrollerVSrc
will be used instead.
To get the path to the image to display, this base URL will be modified as follows:
"Down"
or "Disabled"
will be appended.tabBarPosition
for this tabSet will be appended."forward"
or "back"
will be appended for the forward or backward scrolling
button."[SKIN]scroll.gif"
, the image displayed for
the back-scroller button on a tabSet with tabBarPosition
set to "top" and symmetricScroller
set to false would be one of "[SKIN]scroll_top_back.gif"
, "[SKIN]scroll_Down_top_back.gif"
,
and "[SKIN]scroll_Disabled_top_back.gif"
. Note that for best results the media should be sized to match
the scroller button sizes, determined by tabBarThickness
and scrollerButtonSize
.
SCImgURL
getSymmetricScroller()
public void setScrollerVSrc(java.lang.String scrollerVSrc) throws java.lang.IllegalStateException
tab scroller buttons
, and
symmetricScroller
is true, this property governs the
base URL for the tab bar back and forward scroller button images for vertical tab bars [IE for tab sets with tabBarPosition
set to "left" or "right"]. Note that if
symmetricScroller
is false, scrollerSrc
will be used instead.
To get the path to the image to display, this base URL will be modified as follows:
"Down"
or "Disabled"
will be appended."forward"
or
"back"
will be appended for the forward or backward scrolling button."[SKIN]vscroll.gif"
, the image displayed for the back-scroller button on a tabSet
with tabBarPosition
set to "left" and symmetricScroller
set to true would be one of
"[SKIN]vscroll_back.gif"
, "[SKIN]vscroll_Down_back.gif"
, and
"[SKIN]vscroll_Disabled_back.gif"
. Note that for best results the media should be sized to match the
scroller button sizes, determined by tabBarThickness
and scrollerButtonSize
.
scrollerVSrc
- See SCImgURL
. Default value is "[SKIN]vscroll.gif"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetSymmetricScroller(java.lang.Boolean)
public java.lang.String getScrollerVSrc()
tab scroller buttons
, and
symmetricScroller
is true, this property governs the
base URL for the tab bar back and forward scroller button images for vertical tab bars [IE for tab sets with tabBarPosition
set to "left" or "right"]. Note that if
symmetricScroller
is false, scrollerSrc
will be used instead.
To get the path to the image to display, this base URL will be modified as follows:
"Down"
or "Disabled"
will be appended."forward"
or
"back"
will be appended for the forward or backward scrolling button."[SKIN]vscroll.gif"
, the image displayed for the back-scroller button on a tabSet
with tabBarPosition
set to "left" and symmetricScroller
set to true would be one of
"[SKIN]vscroll_back.gif"
, "[SKIN]vscroll_Down_back.gif"
, and
"[SKIN]vscroll_Disabled_back.gif"
. Note that for best results the media should be sized to match the
scroller button sizes, determined by tabBarThickness
and scrollerButtonSize
.
SCImgURL
getSymmetricScroller()
public void setShowMoreTab(java.lang.Boolean showMoreTab) throws java.lang.IllegalStateException
moreTabCount
be shown on a "more"
tab? This setting is used to emulate an iPhone-style tab bar "more" button.
showMoreTab
- Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowMoreTab()
moreTabCount
be shown on a "more"
tab? This setting is used to emulate an iPhone-style tab bar "more" button.
public void setShowPaneContainerEdges(java.lang.Boolean showPaneContainerEdges)
edges
.
Note : This is an advanced setting
showPaneContainerEdges
- Default value is nullpublic java.lang.Boolean getShowPaneContainerEdges()
edges
.public void setShowPartialEdges(java.lang.Boolean showPartialEdges) throws java.lang.IllegalStateException
edges
, setting
this attribute to true
will set the paneContainer to show customEdges
for the three sides opposing the tabBarPosition.
Note : This is an advanced setting
showPartialEdges
- Default value is falsejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowPartialEdges()
edges
, setting
this attribute to true
will set the paneContainer to show customEdges
for the three sides opposing the tabBarPosition.public void setShowTabPicker(java.lang.Boolean showTabPicker) throws java.lang.IllegalStateException
showTabPicker
- Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowTabPicker()
public void setShowTabScroller(java.lang.Boolean showTabScroller) throws java.lang.IllegalStateException
showTabScroller
- Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowTabScroller()
public void setSimpleTabBaseStyle(java.lang.String simpleTabBaseStyle)
simpleTabBaseStyle
- See CSSStyleName
. Default value is "tabButton"public java.lang.String getSimpleTabBaseStyle()
CSSStyleName
public void setSkinImgDir(java.lang.String skinImgDir) throws java.lang.IllegalStateException
skinDir
.setSkinImgDir
in class Canvas
skinImgDir
- Default value is "images/TabSet/"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdImages overview and related methods
public java.lang.String getSkinImgDir()
skinDir
.getSkinImgDir
in class Canvas
Images overview and related methods
public void setSymmetricEdges(java.lang.Boolean symmetricEdges) throws java.lang.IllegalStateException
show edges
for the
paneContainer, this property determines whether the same edge media will be used regardless of the tab bar position, or
whether different media should be used (necessary if the edge appearance is not symmetrical on all sides). If this
property is set to false the paneContainer edge image URLs will be prefixed with the tabBarPosition of the tabSet - for
example "[SKIN]edge_top_T.gif"
rather than just "[SKIN]edge_T.gif"
.
When
symmetricEdges
is false, custom edge sizes for the pane container may be specified via topEdgeSizes
et al, and custom edge offsets via topEdgeOffsets
et al.
symmetricEdges
- Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getSymmetricEdges()
show edges
for the
paneContainer, this property determines whether the same edge media will be used regardless of the tab bar position, or
whether different media should be used (necessary if the edge appearance is not symmetrical on all sides). If this
property is set to false the paneContainer edge image URLs will be prefixed with the tabBarPosition of the tabSet - for
example "[SKIN]edge_top_T.gif"
rather than just "[SKIN]edge_T.gif"
.
When
symmetricEdges
is false, custom edge sizes for the pane container may be specified via topEdgeSizes
et al, and custom edge offsets via topEdgeOffsets
et al.
public void setSymmetricPickerButton(java.lang.Boolean symmetricPickerButton) throws java.lang.IllegalStateException
tab picker button
, this
property determines whether the pickerButtonHSrc
and
pickerButtonVSrc
media will be used for vertical and
horizontal tab-bar picker buttons, or whether separate media should be used for each possible tabBarPosition
based on the pickerButtonSrc
property for this tabSet.symmetricPickerButton
- Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getSymmetricPickerButton()
tab picker button
, this
property determines whether the pickerButtonHSrc
and
pickerButtonVSrc
media will be used for vertical and
horizontal tab-bar picker buttons, or whether separate media should be used for each possible tabBarPosition
based on the pickerButtonSrc
property for this tabSet.public void setSymmetricScroller(java.lang.Boolean symmetricScroller) throws java.lang.IllegalStateException
tab scroller buttons
, this
property determines whether the scrollerHSrc
and scrollerVSrc
media will be used for vertical and horizontal
tab-bar scroller buttons, or whether separate media should be used for each possible tabBarPosition
based on the scrollerSrc
property for this tabSet.symmetricScroller
- Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getSymmetricScroller()
tab scroller buttons
, this
property determines whether the scrollerHSrc
and scrollerVSrc
media will be used for vertical and horizontal
tab-bar scroller buttons, or whether separate media should be used for each possible tabBarPosition
based on the scrollerSrc
property for this tabSet.public TabBar getTabBar() throws java.lang.IllegalStateException
TabBar
.
For an overview of how to use and configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public void setTabBarAlign(Side tabBarAlign) throws java.lang.IllegalStateException
If the tabBarPosition
is
"top" or "bottom", then this attribute may be set to "left", "right" or "center". The default is "left", or "right" in
RTL mode
.
If the tabBarPosition
is "left" or "right", then this attribute may
be set to "top", "bottom" or "center". The default is "top".
tabBarAlign
- Default value is see belowjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic Side getTabBarAlign()
If the tabBarPosition
is
"top" or "bottom", then this attribute may be set to "left", "right" or "center". The default is "left", or "right" in
RTL mode
.
If the tabBarPosition
is "left" or "right", then this attribute may
be set to "top", "bottom" or "center". The default is "top".
public void setTabBarAlign(Alignment tabBarAlign) throws java.lang.IllegalStateException
If the tabBarPosition
is
"top" or "bottom", then this attribute may be set to "left", "right" or "center". The default is "left", or "right" in
RTL mode
.
If the tabBarPosition
is "left" or "right", then this attribute may
be set to "top", "bottom" or "center". The default is "top".
tabBarAlign
- Default value is see belowjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic Alignment getTabBarAlignAsAlignment()
If the tabBarPosition
is
"top" or "bottom", then this attribute may be set to "left", "right" or "center". The default is "left", or "right" in
RTL mode
.
If the tabBarPosition
is "left" or "right", then this attribute may
be set to "top", "bottom" or "center". The default is "top".
public Layout getTabBarControlLayout() throws java.lang.IllegalStateException
com.smartgwt.client.types.AutoChild
of type Layout
that holds the
tabBarControls
as well as the built-in controls such as
the tab picker menu
.
For an overview of how to use and configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public void setTabBarPosition(Side tabBarPosition) throws java.lang.IllegalStateException
tabBarPosition
- Default value is Canvas.TOPjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic Side getTabBarPosition()
public void setTabBarThickness(int tabBarThickness)
tabBarThickness
- Default value is 21public int getTabBarThickness()
public ImgButton getTabPicker() throws java.lang.IllegalStateException
"tabPicker"
is specified in the tabBarControls
.
For an overview of how to use and configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public TextItem getTitleEditor() throws java.lang.IllegalStateException
com.smartgwt.client.types.AutoChild
facilities.
For an overview of how to use and configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.getCanEditTabTitles()
,
Tab.getCanEditTitle()
,
editTabTitle(java.lang.String)
public void setTitleEditorLeftOffset(java.lang.Integer titleEditorLeftOffset)
titleEditorLeftOffset
- Default value is nullsetTitleEditorRightOffset(java.lang.Integer)
,
setTitleEditorTopOffset(java.lang.Integer)
public java.lang.Integer getTitleEditorLeftOffset()
getTitleEditorRightOffset()
,
getTitleEditorTopOffset()
public void setTitleEditorProperties(TextItem titleEditorProperties) throws java.lang.IllegalStateException
titleEditor
. This is the
text item we use to edit tab titles in this tabSet.titleEditorProperties
- Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdcom.smartgwt.client.widgets.tab.TabSet#setTitleEditor
,
setCanEditTabTitles(java.lang.Boolean)
public TextItem getTitleEditorProperties()
titleEditor
. This is the
text item we use to edit tab titles in this tabSet.getTitleEditor()
,
getCanEditTabTitles()
public void setTitleEditorRightOffset(java.lang.Integer titleEditorRightOffset)
titleEditorRightOffset
- Default value is nullsetTitleEditorLeftOffset(java.lang.Integer)
,
setTitleEditorTopOffset(java.lang.Integer)
public java.lang.Integer getTitleEditorRightOffset()
getTitleEditorLeftOffset()
,
getTitleEditorTopOffset()
public void setTitleEditorTopOffset(java.lang.Integer titleEditorTopOffset)
Note: The height of the editor is an attribute of the editor
itself, and can be set by specifying a "height" property in titleEditorDefaults
.
titleEditorTopOffset
- Default value is nullsetTitleEditorLeftOffset(java.lang.Integer)
,
setTitleEditorRightOffset(java.lang.Integer)
public java.lang.Integer getTitleEditorTopOffset()
Note: The height of the editor is an attribute of the editor
itself, and can be set by specifying a "height" property in titleEditorDefaults
.
getTitleEditorLeftOffset()
,
getTitleEditorRightOffset()
public void setTouchPickerButtonSize(int touchPickerButtonSize) throws java.lang.IllegalStateException
isTouch
is true
.touchPickerButtonSize
- Default value is 16java.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetPickerButtonSize(int)
public int getTouchPickerButtonSize()
isTouch
is true
.getPickerButtonSize()
public void setUseIOSTabs(java.lang.Boolean useIOSTabs) throws java.lang.IllegalStateException
This attribute only has an effect for tabs that are not closable
, and only for Mobile WebKit.
useIOSTabs
- Default value is falsejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getUseIOSTabs()
This attribute only has an effect for tabs that are not closable
, and only for Mobile WebKit.
public void setUseSimpleTabs(java.lang.Boolean useSimpleTabs) throws java.lang.IllegalStateException
ImgTab
tabs? If set to true tabs will instances of Button
, styled according to the simpleTabBaseStyle
.
Note : This is an advanced setting
useSimpleTabs
- Default value is falsejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getUseSimpleTabs()
ImgTab
tabs? If set to true tabs will instances of Button
, styled according to the simpleTabBaseStyle
.
public void cancelTabTitleEditing()
canEditTabTitles
), dismiss the editor and discard the edit value entered by the user.public int getSelectedTabNumber()
public com.google.gwt.event.shared.HandlerRegistration addCloseClickHandler(CloseClickHandler handler)
When canCloseTabs
is set, this notification method fired
when the user clicks the "close" icon for a tab. Call TabCloseClickEvent.cancel()
from within CloseClickHandler.onCloseClick(com.smartgwt.client.widgets.tab.events.TabCloseClickEvent)
to cancel default behavior of removing the tab
from the TabSet
addCloseClickHandler
in interface HasCloseClickHandlers
handler
- the closeClick handlerHandlerRegistration
used to remove this handlerpublic void reorderTab(Tab tab)
tab
- tab to movepublic void reorderTab(Tab tab, int moveToPosition)
tab
- tab to movemoveToPosition
- the index to move the tab to - defaults to the end of the tabset if not passedpublic void saveTabTitle()
canEditTabTitles
), save the edited tab title and hide the editor.public void scrollBack()
public void scrollForward()
public void setCanCloseTab(Tab tab, boolean canClose)
canClose
property to the boolean parameter
canClose. If canClose is null, this will have the effect of causing the tab to fall back on canCloseTabs
.tab
- tab to changecanClose
- new value for the tab's canClose property, or null to clear itpublic com.google.gwt.event.shared.HandlerRegistration addTabContextMenuHandler(TabContextMenuHandler handler)
Notification fired when the user right-clicks on a tab. Event may be cancelled by returning false
addTabContextMenuHandler
in interface HasTabContextMenuHandlers
handler
- the tabContextMenu handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addTabDeselectedHandler(TabDeselectedHandler handler)
Notification fired when a tab is deselected.
addTabDeselectedHandler
in interface HasTabDeselectedHandlers
handler
- the tabDeselected handlerHandlerRegistration
used to remove this handlerpublic Tab tabForPane(Canvas pane)
pane
- pane to showpublic com.google.gwt.event.shared.HandlerRegistration addTabIconClickHandler(TabIconClickHandler handler)
Method fired when the user clicks the icon for a tab, as specified via icon
.
Default behavior will fire icon.click()
if
specified, with two parameters tab
(a pointer to the tab object and tabSet
a pointer to the
tabSet instance.
addTabIconClickHandler
in interface HasTabIconClickHandlers
handler
- the tabIconClick handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addTabSelectedHandler(TabSelectedHandler handler)
Notification fired when a tab is selected. Note that this will only fire if this tabSet is drawn. If a tab is selected
before TabSet.draw()
is called, the tabSelected()
notification will fire on
draw()
addTabSelectedHandler
in interface HasTabSelectedHandlers
handler
- the tabSelected handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addTabsReorderedHandler(TabsReorderedHandler handler)
Noficiation method executed when one or more tabs in the TabSet are reordered.
addTabsReorderedHandler
in interface HasTabsReorderedHandlers
handler
- the tabsReordered handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addTabTitleChangedHandler(TabTitleChangedHandler handler)
This notification method fired when the user changes the title of a tab in this TabSet. This can happen either through
user interaction with the UI if canEditTabTitles
is
set, or programmatically if application code calls editTabTitle
.
Call TabTitleChangedEvent.cancel()
from within TabTitleChangedHandler.onTabTitleChanged(com.smartgwt.client.widgets.tab.events.TabTitleChangedEvent)
from this method to cancel the change.
addTabTitleChangedHandler
in interface HasTabTitleChangedHandlers
handler
- the tabTitleChanged handlerHandlerRegistration
used to remove this handlerpublic static void setDefaultProperties(TabSet tabSetProperties)
Note: This method is intended for setting default attributes only and will affect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.
tabSetProperties
- properties that should be used as new defaults when instances of this class are createdpublic void setSelectedTab(int selectedTab)
selectedTab
- selectedTab Default value is 0public void setTabs(Tab... tabs)
Tab
objects, specifying the title
and pane contents of each tab in the TabSet.
Tab instances are not widgets, they just provide configuration such as title and icon.
After providing Tab
instances to
setTabs()
, the TabSet creates actual UI widgets to serve as interactive
tabs. Any further modifications to tabs should be performed via TabSet APIs such as
setTabTitle
,
setTabIcon
and
setTabPane
.
You can add and remove tabs after creating the TabSet by calling
addTab
and
removeTab
.
tabs
- new tabs for the TabSetpublic void setPaneContainerProperties(Canvas paneContainerProperties)
paneContainerProperties
- the pane container propertiesjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic void setTabBarControls(java.lang.Object... tabBarControls) throws java.lang.IllegalStateException
"tabScroller"
and
"tabPicker"
. These correspond to the scroller
and tabPicker
AutoChildren, respectively. The "tabScroller"
standard control shows two
buttons for scrolling through the tabs in order and the "tabPicker"
standard
control allows tabs to be picked directly from a menu. The standard controls show up only if
showTabScroller
or showTabPicker
is true and there is not
enough space available to show all of the tabs in the tabBar.
tabBarControls
- tabBarControls Default value is ["tabScroller", "tabPicker"]java.lang.IllegalStateException
- this property cannot be changed after the component has been createdAdditional controls can be included by adding any widget to this array. Controls will show up in the order in which they are specified. For example, the following code would add a button in the tabBar area, while preserving the normal behavior of the tabScroller and tabPicker:
ImgButton addButton = new ImgButton(); addButton.setSrc("[SKINIMG]/actions/add.png"); addButton.setTitle("Add"); addButton.setWidth(16); addButton.setHeight(16); addButton.setAlign(Alignment.CENTER); TabSet ts = new TabSet(); ts.setWidth(300); ts.setHeight(32); ts.setTabs(new Tab("Tab one")); ts.setTabBarControls(addButton, TabBarControls.TAB_SCROLLER, TabBarControls.TAB_PICKER); contentLayout.addMember(ts);You can also refer to the default tabPicker/tabScroll controls from Component XML:
<TabSet width="300"> <tabBarControls> <Button title="Custom Button"/> <value xsi:type="string">tabPicker</value> <value xsi:type="string">tabScroller</value> </tabBarControls> <tabs> <tab title="Foo"/> <tab title="Bar"/> </tabs> </TabSet>
Note : This is an advanced setting
public void selectTab(int tabIndex)
tabIndex
- the tab indexpublic void selectTab(java.lang.String ID)
ID
- the tab IDpublic void selectTab(Tab tab)
tab
- the tabpublic void setTabTitle(int tabIndex, java.lang.String title)
tabIndex
- the tab indextitle
- new titlepublic void setTabTitle(java.lang.String ID, java.lang.String title)
ID
- the tab IDtitle
- new titlepublic void setTabTitle(Tab tab, java.lang.String title)
tab
- the tabtitle
- new titlepublic void setTabIcon(int tabIndex, java.lang.String iconURL)
tabIndex
- the tab indexiconURL
- new iconpublic void setTabIcon(java.lang.String ID, java.lang.String iconURL)
ID
- the tab IDiconURL
- new iconpublic void setTabIcon(Tab tab, java.lang.String iconURL)
tab
- the tabiconURL
- new iconpublic void enableTab(int tabIndex)
tabIndex
- the tab indexpublic void enableTab(java.lang.String ID)
ID
- the tab idpublic void enableTab(Tab tab)
tab
- the tabpublic void updateTab(int tabIndex, Canvas pane)
tabIndex
- the tab indexpane
- the new pane for the tabpublic void updateTab(Tab tab, Canvas pane)
tab
- the tabpane
- the new pane for the tabpublic void disableTab(int tabIndex)
tabIndex
- the tab indexpublic void disableTab(java.lang.String ID)
ID
- the tab idpublic void disableTab(Tab tab)
tab
- the tabpublic void removeTab(int tabIndex)
The pane associated with the removed tab is automatically destroyed when you call this method.
To avoid this, call updateTab(int, com.smartgwt.client.widgets.Canvas)
with null
as the new
pane immediately before removing the tab.
tabIndex
- the tab indexpublic void removeTab(java.lang.String ID)
The pane associated with the removed tab is automatically destroyed when you call this method.
To avoid this, call updateTab(int, com.smartgwt.client.widgets.Canvas)
with null
as the new
pane immediately before removing the tab.
ID
- the tabIDpublic void removeTab(Tab tab)
The pane associated with the removed tab is automatically destroyed when you call this method.
To avoid this, call updateTab(int, com.smartgwt.client.widgets.Canvas)
with null
as the new
pane immediately before removing the tab.
tab
- the tabpublic void removeTabs(int[] tabIndexes)
tabIndexes
- the tab indexespublic void removeTabs(java.lang.String[] ids)
ids
- the tabIDspublic Tab getSelectedTab()
public StatefulCanvas getTabCanvas(int tabIndex)
getUseSimpleTabs()
.
If this property is false, the returned canvas will be a ImgTab
instance. If true the canvas will be a com.smartgwt.client.widgets.tab.Button
instance.
Note that you can make use of ImgTab APIs by using the getJsObj()
and create()
APIs to "cast" to the appropriate type - for example:ImgTab liveTab = ImgTab.create(myTabSet.getTabCanvas(2).getJsObj());
Note that live Tab instances are not available until BaseWidget.draw()
.
Note that this is an advanced method. The returned Tab is considered an internal component of
the TabSet. In order to maximize forward compatibility, wherever possible manipulate tabs
through TabSet APIs such as a setTabTitle(int, java.lang.String)
instead of
modifying them directly.
tab
- public StatefulCanvas getTabCanvas(java.lang.String ID)
getUseSimpleTabs()
.
If this property is false, the returned canvas will be a ImgTab
instance. If true the canvas will be a com.smartgwt.client.widgets.tab.Button
instance.
Note that you can make use of ImgTab APIs by using the getJsObj()
and create()
APIs to "cast" to the appropriate type - for example:ImgTab liveTab = ImgTab.create(myTabSet.getTabCanvas(2).getJsObj());
Note that live Tab instances are not available until BaseWidget.draw()
.
Note that this is an advanced method. The returned Tab is considered an internal component of
the TabSet. In order to maximize forward compatibility, wherever possible manipulate tabs
through TabSet APIs such as a setTabTitle(int, java.lang.String)
instead of
modifying them directly.
tab
- public Tab getTab(int tabIndex)
index
- of tab to retrievepublic Tab getTab(java.lang.String ID)
ID
- of tab to retrievepublic int getTabNumber(java.lang.String ID)
ID
- the tab IDpublic void addTab(Tab tab)
tab
- new tabpublic void addTab(Tab tab, int position)
tab
- new tabposition
- the position where tab should be addedpublic int getNumTabs()
public void setTitleEditEvent(TabTitleEditEvent titleEditEvent)
titleEditEvent
- titleEditEvent Default value is "doubleClick"setCanEditTabTitles(java.lang.Boolean)
,
Tab.setCanEditTitle(java.lang.Boolean)
public TabTitleEditEvent getTitleEditEvent()
getCanEditTabTitles()
,
Tab.getCanEditTitle()
public void editTabTitle(java.lang.String tab)
canEditTabTitles
or canEditTitle
.tab
- The tab whose title should be edited (may be specified by ID or index)public void editTabTitle(int tab)
canEditTabTitles
or canEditTitle
.tab
- The tab whose title should be edited (may be specified by ID or index)public Tab[] getTabs()
public void setTabBarProperties(TabBar tabBarProperties) throws java.lang.IllegalStateException
tabBar
tabBarProperties
- tabBarProperties Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic void setTabPane(int tabIndex, Canvas pane)
pane
to an existing tab in this tabSettabIndex
- Tab to updatepane
- new Pane for the tab. pass null to drop existing panepublic void setTabPane(java.lang.String tabID, Canvas pane)
pane
to an existing tab in this tabSettabID
- Tab to updatepane
- new Pane for the tab. pass null to drop existing panepublic static void preloadImages()
public com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.tab.TabSetLogicalStructure s)
LogicalStructure
interface,
which supports Eclipse's logical structure debugging facility.public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
LogicalStructure
interface,
which supports Eclipse's logical structure debugging facility.getLogicalStructure
in interface LogicalStructure
getLogicalStructure
in class Canvas