Class TabSet
- All Implemented Interfaces:
HasAttachHandlers,HasHandlers,EventListener,HasVisibility,IsWidget,LogicalStructure,HasClearHandlers,HasClickHandlers,HasDoubleClickHandlers,HasDragMoveHandlers,HasDragRepositionMoveHandlers,HasDragRepositionStartHandlers,HasDragRepositionStopHandlers,HasDragResizeMoveHandlers,HasDragResizeStartHandlers,HasDragResizeStopHandlers,HasDragStartHandlers,HasDragStopHandlers,HasDropHandlers,HasDropMoveHandlers,HasDropOutHandlers,HasDropOverHandlers,HasFocusChangedHandlers,HasHoverHandlers,HasHoverHiddenHandlers,HasKeyDownHandlers,HasKeyPressHandlers,HasMouseDownHandlers,HasMouseMoveHandlers,HasMouseOutHandlers,HasMouseOverHandlers,HasMouseStillDownHandlers,HasMouseUpHandlers,HasMouseWheelHandlers,HasMovedHandlers,HasParentMovedHandlers,HasResizedHandlers,HasRightMouseDownHandlers,HasRuleContextChangedHandlers,HasScrolledHandlers,HasShowContextMenuHandlers,HasVisibilityChangedHandlers,HasAddTabClickedHandlers,HasAddTabClickHandlers,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.
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled -
Field Summary
Fields inherited from class com.smartgwt.client.widgets.BaseWidget
config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassNameFields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.addAddTabClickHandler(AddTabClickHandler handler) Add a addTabClick handler.addCloseClickHandler(CloseClickHandler handler) Add a closeClick handler.voidAdd a tabvoidAdd a tabAdd a tabContextMenu handler.Add a tabDeselected handler.Add a tabIconClick handler.addTabSelectedHandler(TabSelectedHandler handler) Add a tabSelected handler.Add a tabsReordered handler.Add a tabTitleChanged handler.voidIf the user is currently editing a tab title (seecanEditTabTitles), dismiss the editor and discard the edit value entered by the user.static voidchangeAutoChildDefaults(String autoChildName, Canvas defaults) Changes the defaults for Canvas AutoChildren namedautoChildName.static voidchangeAutoChildDefaults(String autoChildName, FormItem defaults) Changes the defaults for FormItem AutoChildren namedautoChildName.protected JavaScriptObjectcreate()voiddisableTab(int tabIndex) If the specified tab is enabled, disable it now.voiddisableTab(Tab tab) If the specified tab is enabled, disable it now.voiddisableTab(String ID) If the specified tab is enabled, disable it now.voideditTabTitle(int tab) Places an editor in the title of the parameter tab and allows the user to edit the title.voideditTabTitle(String tab) Places an editor in the title of the parameter tab and allows the user to edit the title.voidenableTab(int tabIndex) If the specified tab is disabled, enable it now.voidIf the specified tab is disabled, enable it now.voidIf the specified tab is disabled, enable it now.Appears whencanAddTabsis enabled.Icon for theaddTabButton.IfshowTabScrolleris true, should tabs be scrolled into view via an animation when the user interacts with the scroller buttons?Whenscreen reader modeis enabled and a tab iscloseable, theariaCloseableSuffixis a string that is appended to the label of closeable tabs.Should tabs in this tabSet show an icon allowing the user to dismiss the tab by clicking on it directly.If true, users can edit the titles of tabs in this TabSet when thetitleEditEventfires.If true, tabs can be reordered by dragging on them.Default src for the close icon for tabs to display ifcanCloseTabsis true.intSize in pixels of the icon for closing tabs, displayed whencanCloseTabsis true.Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.WhenAutoTest.getElement()is used to parse locator strings generated byAutoTest.getLocator(), how should tabs within this tabset be identified? If the locator has a specifiedTab.IDorTab.name, no fallback approach will be used as those attributes (withTab.IDhaving priority) are each alone considered to definitively locate it.Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.intThis property defines the number tab buttons that should be shown before automatically adding a "more" button to handle the remaining tabs.IfshowMoreTabis enabled this property determines the image to display on the "More" tab button.Pane contents for the "more" tab based on a VLayout.Default properties for the "more" tab's pane.Navigation bar shown in themoreTabPane;Properties to apply to the "more" tab's pane created by this TabSet.TableViewused to show links to other tabs in themoreTabPane;Properties to apply to the "more" tab created by this TabSet.Title for the "More" tab.intThe number of tabsstatic TabSetgetOrCreateRef(JavaScriptObject jsObj) Container where the component specified byTab.paneis shown.CSS style used for the paneContainer.Specifies the overflow of the pane container (the component that holds the pane contents for all tabs).intSpace to leave around the panes in our paneContainerIfshowTabPickeris true, andsymmetricPickerButtonis set to true, this property governs the base URL for the picker button image, when displayed in a horizontal tab-bar [IEtabBarPositionis set to"top"or"bottom"].intIfshowTabPickeristrueandisTouchisfalse, this property governs the size of the tab picker button.IfshowTabPickeris true, this property governs the base URL for the picker button image, whensymmetricPickerButtonis set to falseIfshowTabPickeris true, andsymmetricPickerButtonis set to true, this property governs the base URL for the picker button image, when displayed in a verricaL tab-bar [IEtabBarPositionis set to"LEFT"or"right"].A component containing back and forward buttons for scrolling through all of the tabs of the TabSet.intIfshowTabScrolleris true, this property governs the size of scroller buttons.If this TabSet is showingtab scroller buttons, andsymmetricScrolleris 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 withtabBarPositionset to "top" or "bottom"].If this TabSet is showingtab scroller buttons, andsymmetricScrolleris false, this property governs the base URL for the tab bar back and forward scroller button images.If this TabSet is showingtab scroller buttons, andsymmetricScrolleris 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 withtabBarPositionset to "left" or "right"].The currently selected tab.intReturns the index of the currently selected tab object.Should tabs exceedingmoreTabCountbe shown on a "more" tab?Should the paneContainer for this tabset showedges.If the paneContainer for this tab set is showingedges, setting this attribute totruewill set the paneContainer to showcustomEdgesfor the three sides opposing the tabBarPosition.Should the tabBar be displayed or not If shrinkElementOnHide is true, the paneContainer will expand over the space occupied by TabBarIf 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?If there is not enough space to display all the tab-buttons in this tabSet, should scroll buttons be displayed to allow access to tabs that are clipped? If unset, defaults to false forhandsetsand true otherwise.IfuseSimpleTabsis true,simpleTabBaseStylewill be the base style used to determine the css style to apply to the tabs.IfuseSimpleTabsis true,simpleTabIconOnlyBaseStylewill be the base style used to determine the css style to apply to the tabs ifTab.canAdaptWidthis set and the title is not being shown.Default directory for skin images (those defined by the class), relative to the Page-wideskinDir.If this tabSet willshow edgesfor 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 TabSet is showing atab picker button, this property determines whether thepickerButtonHSrcandpickerButtonVSrcmedia will be used for vertical and horizontal tab-bar picker buttons, or whether separate media should be used for each possibletabBarPositionbased on thepickerButtonSrcproperty for this tabSet.If this TabSet is showingtab scroller buttons, this property determines whether thescrollerHSrcandscrollerVSrcmedia will be used for vertical and horizontal tab-bar scroller buttons, or whether separate media should be used for each possibletabBarPositionbased on thescrollerSrcproperty for this tabSet.getTab(int tabIndex) Retrieves a Tab definition from within this tabSet by index.Retrieves a Tab definition from within this tabSet by ID.TabBar for this TabSet, an instance ofTabBar.Alignment of the tabBar.Alignment of the tabBar.com.smartgwt.client.types.AutoChildof typeLayoutthat holds thetabBarControlsas well as the built-in controls such as thetab picker menu.Which side of the TabSet the TabBar should appear on.intThickness of tabBar, applies to either orientation (specifies height for horizontal, width for vertical orientation).getTabCanvas(int tabIndex) Get the live Canvas representing a tab by index.getTabCanvas(String ID) Get the live Canvas representing a tab by index.intgetTabNumber(String ID) Get the index of a tab from the tabID.A button control that allows tabs to be picked directly from a popup menu.Tab[]getTabs()The tabsThe event that triggers title editing on this TabSet.TextItem we use to edit tab titles in this TabSet.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.Properties for the auto-generatedtitleEditor.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.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.intThe size of the tab picker button whenisTouchistrue.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.Should we use simple button based tabs styled with CSS rather than image basedImgTabtabs?voidhideTab(int tab) Hide a tab in this tabset at runtime.voidHide a tab in this tabset at runtime.voidHide a tab in this tabset at runtime.static voidPreload primary tab skin images.voidRemoves the last tab in the TabSet, excluding themoreTabif present.voidremoveTab(int tabIndex) Remove a tab.voidRemove a tab.voidRemove a tab.voidremoveTabs(int[] tabIndexes) Remove one or more tabs.voidremoveTabs(String[] ids) Remove one or more tabs.voidreorderTab(Tab tab) Move a tab to another location in the tabset.voidreorderTab(Tab tab, int moveToPosition) Move a tab to another location in the tabset.voidrevealChild(Canvas child) Reveals the child Canvas passed in by selecting the tab containing that child if it is not already selected.voidrevealChild(String childID) Reveals the child Canvas passed in by selecting the tab containing that child if it is not already selected.voidIf the user is currently editing a tab title (seecanEditTabTitles), save the edited tab title and hide the editor.voidIf 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.voidIf 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.voidselectTab(int tabIndex) Select a tab.voidSelect a tab.voidSelect a tab.setAddTabButtonIcon(String addTabButtonIcon) Icon for theaddTabButton.setAnimateTabScrolling(Boolean animateTabScrolling) IfshowTabScrolleris true, should tabs be scrolled into view via an animation when the user interacts with the scroller buttons?setAriaCloseableSuffix(String ariaCloseableSuffix) Whenscreen reader modeis enabled and a tab iscloseable, theariaCloseableSuffixis a string that is appended to the label of closeable tabs.setCanAddTabs(Boolean canAddTabs) voidsetCanCloseTab(Tab tab, boolean canClose) Sets the given tab'scanCloseproperty to the boolean parameter canClose.setCanCloseTabs(Boolean canCloseTabs) Should tabs in this tabSet show an icon allowing the user to dismiss the tab by clicking on it directly.setCanEditTabTitles(Boolean canEditTabTitles) If true, users can edit the titles of tabs in this TabSet when thetitleEditEventfires.setCanReorderTabs(Boolean canReorderTabs) If true, tabs can be reordered by dragging on them.setCloseTabIcon(String closeTabIcon) Default src for the close icon for tabs to display ifcanCloseTabsis true.setCloseTabIconSize(int closeTabIconSize) Size in pixels of the icon for closing tabs, displayed whencanCloseTabsis true.static voidsetDefaultProperties(TabSet tabSetProperties) Class level method to set the default properties of this class.setDefaultTabHeight(Integer defaultTabHeight) setDefaultTabWidth(Integer defaultTabWidth) setDestroyPanes(Boolean destroyPanes) setEditProxyConstructor(String editProxyConstructor) Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.setLocateTabsBy(String locateTabsBy) WhenAutoTest.getElement()is used to parse locator strings generated byAutoTest.getLocator(), how should tabs within this tabset be identified? If the locator has a specifiedTab.IDorTab.name, no fallback approach will be used as those attributes (withTab.IDhaving priority) are each alone considered to definitively locate it.Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.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.setMoreTabImage(String moreTabImage) IfshowMoreTabis enabled this property determines the image to display on the "More" tab button.setMoreTabPaneDefaults(Canvas moreTabPaneDefaults) Default properties for the "more" tab's pane.setMoreTabPaneProperties(Canvas moreTabPaneProperties) Properties to apply to the "more" tab's pane created by this TabSet.setMoreTabProperties(Tab moreTabProperties) Properties to apply to the "more" tab created by this TabSet.setMoreTabTitle(String moreTabTitle) Title for the "More" tab.setPaneContainerClassName(String paneContainerClassName) CSS style used for the paneContainer.setPaneContainerOverflow(Overflow paneContainerOverflow) Specifies the overflow of the pane container (the component that holds the pane contents for all tabs).voidsetPaneContainerProperties(Canvas paneContainerProperties) Properties of the container where the component specified by Tab.pane is shown.setPaneMargin(int paneMargin) Space to leave around the panes in our paneContainersetPickerButtonHSrc(String pickerButtonHSrc) IfshowTabPickeris true, andsymmetricPickerButtonis set to true, this property governs the base URL for the picker button image, when displayed in a horizontal tab-bar [IEtabBarPositionis set to"top"or"bottom"].setPickerButtonSize(int pickerButtonSize) IfshowTabPickeristrueandisTouchisfalse, this property governs the size of the tab picker button.setPickerButtonSrc(String pickerButtonSrc) IfshowTabPickeris true, this property governs the base URL for the picker button image, whensymmetricPickerButtonis set to falsesetPickerButtonVSrc(String pickerButtonVSrc) IfshowTabPickeris true, andsymmetricPickerButtonis set to true, this property governs the base URL for the picker button image, when displayed in a verricaL tab-bar [IEtabBarPositionis set to"LEFT"or"right"].setScrollerButtonSize(int scrollerButtonSize) IfshowTabScrolleris true, this property governs the size of scroller buttons.setScrollerHSrc(String scrollerHSrc) If this TabSet is showingtab scroller buttons, andsymmetricScrolleris 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 withtabBarPositionset to "top" or "bottom"].setScrollerSrc(String scrollerSrc) If this TabSet is showingtab scroller buttons, andsymmetricScrolleris false, this property governs the base URL for the tab bar back and forward scroller button images.setScrollerVSrc(String scrollerVSrc) If this TabSet is showingtab scroller buttons, andsymmetricScrolleris 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 withtabBarPositionset to "left" or "right"].voidsetSelectedTab(int selectedTab) Specifies the index of the initially selected tab.setShowMoreTab(Boolean showMoreTab) Should tabs exceedingmoreTabCountbe shown on a "more" tab?setShowPaneContainerEdges(Boolean showPaneContainerEdges) Should the paneContainer for this tabset showedges.setShowPartialEdges(Boolean showPartialEdges) If the paneContainer for this tab set is showingedges, setting this attribute totruewill set the paneContainer to showcustomEdgesfor the three sides opposing the tabBarPosition.setShowTabBar(Boolean showTabBar) Should the tabBar be displayed or not If shrinkElementOnHide is true, the paneContainer will expand over the space occupied by TabBarsetShowTabPicker(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?setShowTabScroller(Boolean showTabScroller) If there is not enough space to display all the tab-buttons in this tabSet, should scroll buttons be displayed to allow access to tabs that are clipped? If unset, defaults to false forhandsetsand true otherwise.setSimpleTabBaseStyle(String simpleTabBaseStyle) IfuseSimpleTabsis true,simpleTabBaseStylewill be the base style used to determine the css style to apply to the tabs.setSimpleTabIconOnlyBaseStyle(String simpleTabIconOnlyBaseStyle) IfuseSimpleTabsis true,simpleTabIconOnlyBaseStylewill be the base style used to determine the css style to apply to the tabs ifTab.canAdaptWidthis set and the title is not being shown.setSkinImgDir(String skinImgDir) Default directory for skin images (those defined by the class), relative to the Page-wideskinDir.setSymmetricEdges(Boolean symmetricEdges) If this tabSet willshow edgesfor 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).setSymmetricPickerButton(Boolean symmetricPickerButton) If this TabSet is showing atab picker button, this property determines whether thepickerButtonHSrcandpickerButtonVSrcmedia will be used for vertical and horizontal tab-bar picker buttons, or whether separate media should be used for each possibletabBarPositionbased on thepickerButtonSrcproperty for this tabSet.setSymmetricScroller(Boolean symmetricScroller) If this TabSet is showingtab scroller buttons, this property determines whether thescrollerHSrcandscrollerVSrcmedia will be used for vertical and horizontal tab-bar scroller buttons, or whether separate media should be used for each possibletabBarPositionbased on thescrollerSrcproperty for this tabSet.setTabBarAlign(Alignment tabBarAlign) Alignment of the tabBar.setTabBarAlign(Side tabBarAlign) Alignment of the tabBar.voidsetTabBarControls(Object... tabBarControls) This property determines what controls should show up after the tabBar for this TabSet.setTabBarPosition(Side tabBarPosition) Which side of the TabSet the TabBar should appear on.voidsetTabBarProperties(TabBar tabBarProperties) This attribute allows developers to specify custom properties for this tabset'stabBarsetTabBarThickness(int tabBarThickness) Thickness of tabBar, applies to either orientation (specifies height for horizontal, width for vertical orientation).voidsetTabIcon(int tabIndex, String iconURL) Changes the icon of a tabvoidsetTabIcon(Tab tab, String iconURL) Changes the icon of a tabvoidsetTabIcon(String ID, String iconURL) Changes the icon of a tabvoidsetTabPane(int tabIndex, Canvas pane) Apply a newpaneto an existing tab in this tabSetvoidsetTabPane(String tabID, Canvas pane) Apply a newpaneto an existing tab in this tabSetvoidsetTabPickerTitle(Tab tab, String pickerTitle) Changes the title of the picker menu item of a tabvoidAn array ofTabobjects, specifying the title and pane contents of each tab in the TabSet.voidsetTabTitle(int tabIndex, String title) Changes the title of a tabvoidsetTabTitle(Tab tab, String title) Changes the title of a tabvoidsetTabTitle(String ID, String title) Changes the title of a tabvoidsetTitleEditEvent(TabTitleEditEvent titleEditEvent) The event that triggers title editing on this TabSet.setTitleEditorLeftOffset(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.setTitleEditorProperties(TextItem titleEditorProperties) Properties for the auto-generatedtitleEditor.setTitleEditorRightOffset(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.setTitleEditorTopOffset(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.setTouchPickerButtonSize(int touchPickerButtonSize) The size of the tab picker button whenisTouchistrue.setUseIOSTabs(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.setUseSimpleTabs(Boolean useSimpleTabs) Should we use simple button based tabs styled with CSS rather than image basedImgTabtabs?voidshowTab(int tab) Show ahidden tabat runtime.voidShow ahidden tabat runtime.voidShow ahidden tabat runtime.tabForPane(Canvas pane) Search for a tab that contains a pane.booleantabIsVisible(int tab) Is the tabhidden or visible?booleantabIsVisible(Tab tab) Is the tabhidden or visible?booleantabIsVisible(String tab) Is the tabhidden or visible?voidSet the pane for a tab.voidSet the pane for a tab.Methods inherited from class com.smartgwt.client.widgets.Canvas
addChild, addChild, addChild, addChild, addChild, addClearHandler, 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, addRuleContextChangedHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateHide, 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, animateShow, asSGWTComponent, blur, bringToFront, clear, clearExplicitTabIndex, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsEventTarget, containsFocus, containsPoint, containsPoint, dataContextChanged, deparent, depeer, disable, enable, encloses, focus, focusAfterGroup, focusAtEnd, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysManageFocusNavigation, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideEffect, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeLayoutMode, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaHandleID, getAriaRole, getAriaStateDefaults, getAutoMaskComponents, getAutoParent, getAutoPopulateData, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBorderRadius, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanAdaptHeight, getCanAdaptWidth, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getChildTabPosition, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCorrectZoomOverflow, getCursor, getDataContext, getDataPath, getDefaultHeight, getDefaultWidth, getDefiningProperty, getDefiningPropertyName, getDefiningPropertyNameOptions, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragTargetAsString, getDragType, getDropTarget, getDropTargetAsString, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFloatingScrollbars, getFormItemAutoChild, getForwardSVGeventsToObject, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupPadding, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverPersist, getHoverScreen, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlElementAsString, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeaveGroupLabelSpace, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateByIDOnly, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getLocatorName, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMatchElementHeight, getMatchElementWidth, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getName, getNativeAutoHideScrollbars, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPendingMarkerStyle, getPendingMarkerVisible, getPercentBox, getPercentSource, getPersistentMatchElement, getPointerSettings, getPointerTarget, getPointerTargetAsString, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrintStyleName, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getReceiveScrollbarEvents, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getRuleContext, getRuleContext, getRuleScope, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowColor, getShadowDepth, getShadowHOffset, getShadowImage, getShadowOffset, getShadowSoftness, getShadowSpread, getShadowVOffset, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowPointer, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSizeMayChangeOnRedraw, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapGridLineProperties, getSnapGridStyle, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStartLine, getStyleName, getTabIndex, getTestDataContext, getTestInstance, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUISummary, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseBackMask, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getWorkflows, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, initComplete, intersects, isDirty, isDisabled, isFocused, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, onInit, pageScrollDown, pageScrollUp, parentResized, placeNear, placeNear, placeNear, print, print, print, print, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, registerFontScaledPaddingStyles, removeChild, removeChild, removePeer, removePeer, removeRuleContext, removeSnapAlignCandidate, resizeAutoChildAttributes, resizeBy, resizeControls, resizeControlsTo, resizeFonts, resizeFonts, resizeFonts, resizeFontsTo, resizeIcons, resizePadding, resizePadding, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAlign, setAllowExternalFilters, setAlwaysManageFocusNavigation, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideEffect, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeLayoutMode, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoPopulateData, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorderRadius, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCorrectZoomOverflow, setCursor, setDataContext, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultShowCustomScrollbars, setDefaultWidth, setDefiningProperty, setDefiningPropertyNameOptions, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragTarget, setDragType, setDropTarget, setDropTarget, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setFloatingScrollbars, setForwardSVGeventsToObject, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupPadding, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverPersist, setHoverScreen, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeaveGroupLabelSpace, setLeavePageSpace, setLeft, setLeft, setLocateByIDOnly, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLocatorName, setLocatorParent, setLocatorParent, setLogicalStructure, setMargin, setMatchElement, setMatchElementHeight, setMatchElementWidth, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setName, setNativeAutoHideScrollbars, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPendingMarkerStyle, setPendingMarkerVisible, setPercentBox, setPercentSource, setPersistentMatchElement, setPointerSettings, setPointerTarget, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrintStyleName, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setReceiveScrollbarEvents, setRect, setRect, setRedrawOnResize, setRelativeTabPosition, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setRuleScope, setScrollbarConstructor, setScrollbarSize, setShadowColor, setShadowDepth, setShadowHOffset, setShadowImage, setShadowOffset, setShadowSoftness, setShadowSpread, setShadowVOffset, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowPointer, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSizeMayChangeOnRedraw, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapGridLineProperties, setSnapGridStyle, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStartLine, setStyleName, setTabIndex, setTestDataContext, setTitle, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseBackMask, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setWorkflows, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPendingMarker, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, startDebuggingOverflow, stopDebuggingOverflow, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDropMethods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hasDynamicProperty, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, 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, setDefaultProperties, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toStringMethods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEventsMethods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEventMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
-
Constructor Details
-
TabSet
public TabSet() -
TabSet
-
-
Method Details
-
getOrCreateRef
-
changeAutoChildDefaults
Changes the defaults for Canvas AutoChildren namedautoChildName.- Parameters:
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. For usage tips on this param, seeSGWTProperties.- See Also:
-
changeAutoChildDefaults
Changes the defaults for FormItem AutoChildren namedautoChildName.- Parameters:
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. For usage tips on this param, seeSGWTProperties.- See Also:
-
create
-
getAddTabButton
Appears whencanAddTabsis enabled.This component is an AutoChild named "addTabButton". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current addTabButton value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setAddTabButtonIcon
Icon for theaddTabButton.- Parameters:
addTabButtonIcon- New addTabButtonIcon value. Default value is "[SKIN]actions/add.png"- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getAddTabButtonIcon
Icon for theaddTabButton.- Returns:
- Current addTabButtonIcon value. Default value is "[SKIN]actions/add.png"
- See Also:
-
setAnimateTabScrolling
IfshowTabScrolleris true, should tabs be scrolled into view via an animation when the user interacts with the scroller buttons?- Parameters:
animateTabScrolling- New animateTabScrolling value. Default value is true- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getAnimateTabScrolling
IfshowTabScrolleris true, should tabs be scrolled into view via an animation when the user interacts with the scroller buttons?- Returns:
- Current animateTabScrolling value. Default value is true
-
setAriaCloseableSuffix
Whenscreen reader modeis enabled and a tab iscloseable, theariaCloseableSuffixis 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
nullto disable appending this suffix.Note : This is an advanced setting
- Parameters:
ariaCloseableSuffix- New ariaCloseableSuffix value. Default value is ", closeable"- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getAriaCloseableSuffix
Whenscreen reader modeis enabled and a tab iscloseable, theariaCloseableSuffixis 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
nullto disable appending this suffix.- Returns:
- Current ariaCloseableSuffix value. Default value is ", closeable"
-
setCanAddTabs
Causes theaddTabButtonto appear after thetabsand before thetabBarControls.There is no default behavior for what happens when the
addTabButtonis clicked. Add a handler for theTabSet.addTabClick()event to implement a behavior.- Parameters:
canAddTabs- New canAddTabs value. Default value is null- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getCanAddTabs
Causes theaddTabButtonto appear after thetabsand before thetabBarControls.There is no default behavior for what happens when the
addTabButtonis clicked. Add a handler for theTabSet.addTabClick()event to implement a behavior.- Returns:
- Current canAddTabs value. Default value is null
-
setCanCloseTabs
Should tabs in this tabSet show an icon allowing the user to dismiss the tab by clicking on it directly. May be overridden for individual tabs by settingTab.canClose.The URL for this icon's image will be derived from
closeTabIconby default, but may be overridden by explicitly specifyingTab.closeIcon.Note: Currently, tabs can only show a single icon, so a closable tab will show the close icon only even if
Tab.iconis set. To work around this, add the icon as an HTML <img> tag to theTab.titleproperty, for example:tab.setTitle("<span>" + Canvas.imgHTML("path/to/icon.png") + " Tab Title</span>");
If this method is called after the component has been drawn/initialized: Changes this TabSet'scanCloseTabsproperty.- Parameters:
canCloseTabs- the new value for canCloseTabs. Default value is null- Returns:
TabSetinstance, for chaining setter calls- See Also:
-
com.smartgwt.client.widgets.tab.TabSet#closeClick
-
getCanCloseTabs
Should tabs in this tabSet show an icon allowing the user to dismiss the tab by clicking on it directly. May be overridden for individual tabs by settingTab.canClose.The URL for this icon's image will be derived from
closeTabIconby default, but may be overridden by explicitly specifyingTab.closeIcon.Note: Currently, tabs can only show a single icon, so a closable tab will show the close icon only even if
Tab.iconis set. To work around this, add the icon as an HTML <img> tag to theTab.titleproperty, for example:tab.setTitle("<span>" + Canvas.imgHTML("path/to/icon.png") + " Tab Title</span>");- Returns:
- Current canCloseTabs value. Default value is null
- See Also:
-
com.smartgwt.client.widgets.tab.TabSet#closeClick
-
setCanEditTabTitles
If true, users can edit the titles of tabs in this TabSet when thetitleEditEventfires. You can override this behavior per tab with theTab.canEditTitleproperty.Note that this TabSet's
titleEditEventmust be set to a supportedTabTitleEditEventin order for users to be able to edit the titles of tabs.- Parameters:
canEditTabTitles- New canEditTabTitles value. Default value is false- Returns:
TabSetinstance, for chaining setter calls- See Also:
-
getCanEditTabTitles
If true, users can edit the titles of tabs in this TabSet when thetitleEditEventfires. You can override this behavior per tab with theTab.canEditTitleproperty.Note that this TabSet's
titleEditEventmust be set to a supportedTabTitleEditEventin order for users to be able to edit the titles of tabs.- Returns:
- Current canEditTabTitles value. Default value is false
- See Also:
-
setCanReorderTabs
If true, tabs can be reordered by dragging on them.To disallow drag-reorder of a specific tab, see
Tab.canReorder.- Parameters:
canReorderTabs- New canReorderTabs value. Default value is null- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getCanReorderTabs
If true, tabs can be reordered by dragging on them.To disallow drag-reorder of a specific tab, see
Tab.canReorder.- Returns:
- Current canReorderTabs value. Default value is null
- See Also:
-
setCloseTabIcon
Default src for the close icon for tabs to display ifcanCloseTabsis true.- Parameters:
closeTabIcon- New closeTabIcon value. Default value is [SKIN]/TabSet/close.png- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getCloseTabIcon
Default src for the close icon for tabs to display ifcanCloseTabsis true.- Returns:
- Current closeTabIcon value. Default value is [SKIN]/TabSet/close.png
- See Also:
-
setCloseTabIconSize
Size in pixels of the icon for closing tabs, displayed whencanCloseTabsis true.- Parameters:
closeTabIconSize- New closeTabIconSize value. Default value is 16- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getCloseTabIconSize
public int getCloseTabIconSize()Size in pixels of the icon for closing tabs, displayed whencanCloseTabsis true.- Returns:
- Current closeTabIconSize value. Default value is 16
-
setDefaultTabHeight
If set, is passed as "height" to all tabs whentabBarPositionis 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.- Parameters:
defaultTabHeight- New defaultTabHeight value. Default value is null- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getDefaultTabHeight
If set, is passed as "height" to all tabs whentabBarPositionis 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.- Returns:
- Current defaultTabHeight value. Default value is null
-
setDefaultTabWidth
If set, is passed as "width" to all tabs whentabBarPositionis 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.- Parameters:
defaultTabWidth- New defaultTabWidth value. Default value is null- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getDefaultTabWidth
If set, is passed as "width" to all tabs whentabBarPositionis 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.- Returns:
- Current defaultTabWidth value. Default value is null
-
setDestroyPanes
Whetherdestroy()should be called onTab.panewhen it a tab is removed viaremoveTab().With the default setting of
nullpanes 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.- Parameters:
destroyPanes- New destroyPanes value. Default value is null- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getDestroyPanes
Whetherdestroy()should be called onTab.panewhen it a tab is removed viaremoveTab().With the default setting of
nullpanes 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.- Returns:
- Current destroyPanes value. Default value is null
-
setEditProxyConstructor
Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.- Overrides:
setEditProxyConstructorin classCanvas- Parameters:
editProxyConstructor- New editProxyConstructor value. Default value is "TabSetEditProxy"- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getEditProxyConstructor
Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.- Overrides:
getEditProxyConstructorin classCanvas- Returns:
- Current editProxyConstructor value. Default value is "TabSetEditProxy"
- See Also:
-
setLocateTabsBy
WhenAutoTest.getElement()is used to parse locator strings generated byAutoTest.getLocator(), how should tabs within this tabset be identified? If the locator has a specifiedTab.IDorTab.name, no fallback approach will be used as those attributes (withTab.IDhaving priority) are each alone considered to definitively locate it.Otherwise, the following options are available:
"title"use the title as an identifier"index"use the index of the tab in the tabset as an identifier
If unset, and the locator has no specified ID or name, default behavior is to identify by title (if available), otherwise by index.
Note : This is an advanced setting
- Parameters:
locateTabsBy- New locateTabsBy value. Default value is null- Returns:
TabSetinstance, for chaining setter calls- See Also:
-
getLocateTabsBy
WhenAutoTest.getElement()is used to parse locator strings generated byAutoTest.getLocator(), how should tabs within this tabset be identified? If the locator has a specifiedTab.IDorTab.name, no fallback approach will be used as those attributes (withTab.IDhaving priority) are each alone considered to definitively locate it.Otherwise, the following options are available:
"title"use the title as an identifier"index"use the index of the tab in the tabset as an identifier
If unset, and the locator has no specified ID or name, default behavior is to identify by title (if available), otherwise by index.
- Returns:
- Current locateTabsBy value. Default value is null
- See Also:
-
getMoreTab
Tabto be shown whenshowMoreTabis enabled more thanmoreTabCounttabs are provided.This component is an AutoChild named "moreTab". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current moreTab value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setMoreTabCount
This property defines the number tab buttons that should be shown before automatically adding a "more" button to handle the remaining tabs. This property is only used whenshowMoreTabis enabled.- Parameters:
moreTabCount- New moreTabCount value. Default value is 5- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getMoreTabCount
public int getMoreTabCount()This property defines the number tab buttons that should be shown before automatically adding a "more" button to handle the remaining tabs. This property is only used whenshowMoreTabis enabled.- Returns:
- Current moreTabCount value. Default value is 5
-
setMoreTabImage
IfshowMoreTabis enabled this property determines the image to display on the "More" tab button.- Parameters:
moreTabImage- New moreTabImage value. Default value is "[SKINIMG]/iOS/more.png"- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getMoreTabImage
IfshowMoreTabis enabled this property determines the image to display on the "More" tab button.- Returns:
- Current moreTabImage value. Default value is "[SKINIMG]/iOS/more.png"
- See Also:
-
getMoreTabPane
Pane contents for the "more" tab based on a VLayout. Typically contains aNavigationBarandTableView.This component is an AutoChild named "moreTabPane". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current moreTabPane value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setMoreTabPaneDefaults
Default properties for the "more" tab's pane.Currently constructs a VLayout with a
NavigationBarandTableView.- Parameters:
moreTabPaneDefaults- New moreTabPaneDefaults value. Default value is null- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getMoreTabPaneDefaults
Default properties for the "more" tab's pane.Currently constructs a VLayout with a
NavigationBarandTableView.- Returns:
- Current moreTabPaneDefaults value. Default value is null
-
setMoreTabPaneProperties
Properties to apply to the "more" tab's pane created by this TabSet.- Parameters:
moreTabPaneProperties- New moreTabPaneProperties value. Default value is null- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getMoreTabPaneProperties
Properties to apply to the "more" tab's pane created by this TabSet.- Returns:
- Current moreTabPaneProperties value. Default value is null
-
getMoreTabPaneTable
TableViewused to show links to other tabs in themoreTabPane;This component is an AutoChild named "moreTabPaneTable". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current moreTabPaneTable value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setMoreTabProperties
Properties to apply to the "more" tab created by this TabSet.- Parameters:
moreTabProperties- New moreTabProperties value. Default value is null- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getMoreTabProperties
Properties to apply to the "more" tab created by this TabSet.- Returns:
- Current moreTabProperties value. Default value is null
-
setMoreTabTitle
Title for the "More" tab.- Parameters:
moreTabTitle- New moreTabTitle value. Default value is "More"- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getMoreTabTitle
Title for the "More" tab.- Returns:
- Current moreTabTitle value. Default value is "More"
-
getPaneContainer
Container where the component specified byTab.paneis shown.Note: paneContainer and showEdges:true for rounded tabsets: you can enable decorative image-based edges on the paneContainer by setting
showEdges:truevia paneContainerDefaults (to skin all tabsets) or paneContainerProperties (to use edges on one instance). In this structure, theBaseLineshould 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), bothTabBar.baseLineCapSizeandTabBar.baseLineThicknessmatch theedgeSizeset 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.This component is an AutoChild named "paneContainer". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current paneContainer value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setPaneContainerClassName
CSS style used for the paneContainer.- Parameters:
paneContainerClassName- New paneContainerClassName value. Default value is null- Returns:
TabSetinstance, for chaining setter calls- See Also:
-
getPaneContainerClassName
CSS style used for the paneContainer.- Returns:
- Current paneContainerClassName value. Default value is null
- See Also:
-
setPaneContainerOverflow
Specifies the overflow of the pane container (the component that holds the pane contents for all tabs). By default this is set to "auto", meaning the pane container will automatically introduce scrolling when the pane contents exceed the TabSet's specified size.For other values and their meaning, see
Overflow
If this method is called after the component has been drawn/initialized: UpdatepaneContainerOverflowafter creation.Note : This is an advanced setting
- Parameters:
paneContainerOverflow- new overflow setting. Default value is Canvas.AUTO- Returns:
TabSetinstance, for chaining setter calls
-
getPaneContainerOverflow
Specifies the overflow of the pane container (the component that holds the pane contents for all tabs). By default this is set to "auto", meaning the pane container will automatically introduce scrolling when the pane contents exceed the TabSet's specified size.For other values and their meaning, see
Overflow- Returns:
- Current paneContainerOverflow value. Default value is Canvas.AUTO
-
setPaneMargin
Space to leave around the panes in our paneContainerNote that this property may be specified on a per-tab basis via
Tab.paneMargin.- Parameters:
paneMargin- New paneMargin value. Default value is 0- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getPaneMargin
public int getPaneMargin()Space to leave around the panes in our paneContainerNote that this property may be specified on a per-tab basis via
Tab.paneMargin.- Returns:
- Current paneMargin value. Default value is 0
-
setPickerButtonHSrc
IfshowTabPickeris true, andsymmetricPickerButtonis set to true, this property governs the base URL for the picker button image, when displayed in a horizontal tab-bar [IEtabBarPositionis set to"top"or"bottom"].Note that if
symmetricPickerButtonis false, thepickerButtonSrcproperty 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.- Parameters:
pickerButtonHSrc- New pickerButtonHSrc value. Default value is "[SKIN]hpicker.gif"- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getPickerButtonHSrc
IfshowTabPickeris true, andsymmetricPickerButtonis set to true, this property governs the base URL for the picker button image, when displayed in a horizontal tab-bar [IEtabBarPositionis set to"top"or"bottom"].Note that if
symmetricPickerButtonis false, thepickerButtonSrcproperty 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.- Returns:
- Current pickerButtonHSrc value. Default value is "[SKIN]hpicker.gif"
- See Also:
-
setPickerButtonSize
IfshowTabPickeristrueandisTouchisfalse, this property governs the size of the tab picker button. This value is applied as the width of the tab picker button if thetabBaris horizontal, or the height if thetabBaris vertical. Note that the other dimension is determined bythis.tabBarThickness.On touch browsers (where
isTouchistrue),touchPickerButtonSizeis used instead.- Parameters:
pickerButtonSize- New pickerButtonSize value. Default value is 16- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getPickerButtonSize
public int getPickerButtonSize()IfshowTabPickeristrueandisTouchisfalse, this property governs the size of the tab picker button. This value is applied as the width of the tab picker button if thetabBaris horizontal, or the height if thetabBaris vertical. Note that the other dimension is determined bythis.tabBarThickness.On touch browsers (where
isTouchistrue),touchPickerButtonSizeis used instead.- Returns:
- Current pickerButtonSize value. Default value is 16
-
setPickerButtonSrc
IfshowTabPickeris true, this property governs the base URL for the picker button image, whensymmetricPickerButtonis set to falseNote that if
symmetricPickerButtonis true, thepickerButtonHSrcandpickerButtonVSrcproperties will be used instead.To get the path to the image to display, this base URL will be modified as follows:
- If appropriate a state suffix of
"Down"or"Disabled"will be appended. - The
tabBarPositionfor this tabSet will be appended.
- Parameters:
pickerButtonSrc- New pickerButtonSrc value. Default value is "[SKIN]/picker.gif"- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
- If appropriate a state suffix of
-
getPickerButtonSrc
IfshowTabPickeris true, this property governs the base URL for the picker button image, whensymmetricPickerButtonis set to falseNote that if
symmetricPickerButtonis true, thepickerButtonHSrcandpickerButtonVSrcproperties will be used instead.To get the path to the image to display, this base URL will be modified as follows:
- If appropriate a state suffix of
"Down"or"Disabled"will be appended. - The
tabBarPositionfor this tabSet will be appended.
- Returns:
- Current pickerButtonSrc value. Default value is "[SKIN]/picker.gif"
- See Also:
- If appropriate a state suffix of
-
setPickerButtonVSrc
IfshowTabPickeris true, andsymmetricPickerButtonis set to true, this property governs the base URL for the picker button image, when displayed in a verricaL tab-bar [IEtabBarPositionis set to"LEFT"or"right"].Note that if
symmetricPickerButtonis false, thepickerButtonSrcproperty 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.- Parameters:
pickerButtonVSrc- New pickerButtonVSrc value. Default value is "[SKIN]vpicker.gif"- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getPickerButtonVSrc
IfshowTabPickeris true, andsymmetricPickerButtonis set to true, this property governs the base URL for the picker button image, when displayed in a verricaL tab-bar [IEtabBarPositionis set to"LEFT"or"right"].Note that if
symmetricPickerButtonis false, thepickerButtonSrcproperty 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.- Returns:
- Current pickerButtonVSrc value. Default value is "[SKIN]vpicker.gif"
- See Also:
-
getScroller
A component containing back and forward buttons for scrolling through all of the tabs of the TabSet. The scroller is created automatically when needed and when"tabScroller"is specified in thetabBarControls.By default, the scroller constructor is
StretchImgButton. Note that the scrolleritemsare determined automatically, so any items set in scrollerProperties will be ignored.This component is an AutoChild named "scroller". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current scroller value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setScrollerButtonSize
IfshowTabScrolleris 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 bythis.tabBarThickness- Parameters:
scrollerButtonSize- New scrollerButtonSize value. Default value is 16- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getScrollerButtonSize
public int getScrollerButtonSize()IfshowTabScrolleris 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 bythis.tabBarThickness- Returns:
- Current scrollerButtonSize value. Default value is 16
-
setScrollerHSrc
If this TabSet is showingtab scroller buttons, andsymmetricScrolleris 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 withtabBarPositionset to "top" or "bottom"].Note that if
symmetricScrolleris false,scrollerSrcwill be used instead.To get the path to the image to display, this base URL will be modified as follows:
- If appropriate a state suffix of
"Down"or"Disabled"will be appended. - A suffix of
"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 withtabBarPositionset to "top" andsymmetricScrollerset 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
tabBarThicknessandscrollerButtonSize.- Parameters:
scrollerHSrc- New scrollerHSrc value. Default value is "[SKIN]hscroll.gif"- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
- If appropriate a state suffix of
-
getScrollerHSrc
If this TabSet is showingtab scroller buttons, andsymmetricScrolleris 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 withtabBarPositionset to "top" or "bottom"].Note that if
symmetricScrolleris false,scrollerSrcwill be used instead.To get the path to the image to display, this base URL will be modified as follows:
- If appropriate a state suffix of
"Down"or"Disabled"will be appended. - A suffix of
"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 withtabBarPositionset to "top" andsymmetricScrollerset 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
tabBarThicknessandscrollerButtonSize.- Returns:
- Current scrollerHSrc value. Default value is "[SKIN]hscroll.gif"
- See Also:
- If appropriate a state suffix of
-
setScrollerSrc
If this TabSet is showingtab scroller buttons, andsymmetricScrolleris false, this property governs the base URL for the tab bar back and forward scroller button images.Note that if
symmetricScrolleris true,scrollerHSrcandscrollerVSrcwill be used instead.To get the path to the image to display, this base URL will be modified as follows:
- If appropriate a state suffix of
"Down"or"Disabled"will be appended. - The
tabBarPositionfor this tabSet will be appended. - A
suffix of
"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 withtabBarPositionset to "top" andsymmetricScrollerset 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
tabBarThicknessandscrollerButtonSize.- Parameters:
scrollerSrc- New scrollerSrc value. Default value is "[SKIN]/scroll.gif"- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
- If appropriate a state suffix of
-
getScrollerSrc
If this TabSet is showingtab scroller buttons, andsymmetricScrolleris false, this property governs the base URL for the tab bar back and forward scroller button images.Note that if
symmetricScrolleris true,scrollerHSrcandscrollerVSrcwill be used instead.To get the path to the image to display, this base URL will be modified as follows:
- If appropriate a state suffix of
"Down"or"Disabled"will be appended. - The
tabBarPositionfor this tabSet will be appended. - A
suffix of
"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 withtabBarPositionset to "top" andsymmetricScrollerset 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
tabBarThicknessandscrollerButtonSize.- Returns:
- Current scrollerSrc value. Default value is "[SKIN]/scroll.gif"
- See Also:
- If appropriate a state suffix of
-
setScrollerVSrc
If this TabSet is showingtab scroller buttons, andsymmetricScrolleris 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 withtabBarPositionset to "left" or "right"].Note that if
symmetricScrolleris false,scrollerSrcwill be used instead.To get the path to the image to display, this base URL will be modified as follows:
- If appropriate a state suffix of
"Down"or"Disabled"will be appended. - A suffix of
"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 withtabBarPositionset to "left" andsymmetricScrollerset 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
tabBarThicknessandscrollerButtonSize.- Parameters:
scrollerVSrc- New scrollerVSrc value. Default value is "[SKIN]vscroll.gif"- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
- If appropriate a state suffix of
-
getScrollerVSrc
If this TabSet is showingtab scroller buttons, andsymmetricScrolleris 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 withtabBarPositionset to "left" or "right"].Note that if
symmetricScrolleris false,scrollerSrcwill be used instead.To get the path to the image to display, this base URL will be modified as follows:
- If appropriate a state suffix of
"Down"or"Disabled"will be appended. - A suffix of
"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 withtabBarPositionset to "left" andsymmetricScrollerset 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
tabBarThicknessandscrollerButtonSize.- Returns:
- Current scrollerVSrc value. Default value is "[SKIN]vscroll.gif"
- See Also:
- If appropriate a state suffix of
-
setShowMoreTab
Should tabs exceedingmoreTabCountbe shown on a "more" tab?This setting is used to emulate an iPhone-style tab bar "more" button.
- Parameters:
showMoreTab- New showMoreTab value. Default value is null- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowMoreTab
Should tabs exceedingmoreTabCountbe shown on a "more" tab?This setting is used to emulate an iPhone-style tab bar "more" button.
- Returns:
- Current showMoreTab value. Default value is null
-
setShowPaneContainerEdges
Should the paneContainer for this tabset showedges.Note : This is an advanced setting
- Parameters:
showPaneContainerEdges- New showPaneContainerEdges value. Default value is null- Returns:
TabSetinstance, for chaining setter calls
-
getShowPaneContainerEdges
Should the paneContainer for this tabset showedges.- Returns:
- Current showPaneContainerEdges value. Default value is null
-
setShowPartialEdges
If the paneContainer for this tab set is showingedges, setting this attribute totruewill set the paneContainer to showcustomEdgesfor the three sides opposing the tabBarPosition.Note : This is an advanced setting
- Parameters:
showPartialEdges- New showPartialEdges value. Default value is false- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowPartialEdges
If the paneContainer for this tab set is showingedges, setting this attribute totruewill set the paneContainer to showcustomEdgesfor the three sides opposing the tabBarPosition.- Returns:
- Current showPartialEdges value. Default value is false
-
setShowTabBar
Should the tabBar be displayed or not If shrinkElementOnHide is true, the paneContainer will expand over the space occupied by TabBar- Parameters:
showTabBar- New showTabBar value. Default value is true- Returns:
TabSetinstance, for chaining setter calls
-
getShowTabBar
Should the tabBar be displayed or not If shrinkElementOnHide is true, the paneContainer will expand over the space occupied by TabBar- Returns:
- Current showTabBar value. Default value is true
-
setShowTabPicker
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?- Parameters:
showTabPicker- New showTabPicker value. Default value is true- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
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?- Returns:
- Current showTabPicker value. Default value is true
-
setShowTabScroller
If there is not enough space to display all the tab-buttons in this tabSet, should scroll buttons be displayed to allow access to tabs that are clipped? If unset, defaults to false forhandsetsand true otherwise.- Parameters:
showTabScroller- New showTabScroller value. Default value is null- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowTabScroller
If there is not enough space to display all the tab-buttons in this tabSet, should scroll buttons be displayed to allow access to tabs that are clipped? If unset, defaults to false forhandsetsand true otherwise.- Returns:
- Current showTabScroller value. Default value is null
-
setSimpleTabBaseStyle
IfuseSimpleTabsis true,simpleTabBaseStylewill 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".
- Parameters:
simpleTabBaseStyle- New simpleTabBaseStyle value. Default value is "tabButton"- Returns:
TabSetinstance, for chaining setter calls- See Also:
-
getSimpleTabBaseStyle
IfuseSimpleTabsis true,simpleTabBaseStylewill 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".
- Returns:
- Current simpleTabBaseStyle value. Default value is "tabButton"
- See Also:
-
setSimpleTabIconOnlyBaseStyle
IfuseSimpleTabsis true,simpleTabIconOnlyBaseStylewill be the base style used to determine the css style to apply to the tabs ifTab.canAdaptWidthis set and the title is not being shown.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 "iconOnlyTabButtonTopOver".
Note that this property is only defined for certain skins, where it's needed. If not defined,
simpleTabBaseStylewill serve as base style whether or not the title is hidden.- Parameters:
simpleTabIconOnlyBaseStyle- New simpleTabIconOnlyBaseStyle value. Default value is varies- Returns:
TabSetinstance, for chaining setter calls- See Also:
-
getSimpleTabIconOnlyBaseStyle
IfuseSimpleTabsis true,simpleTabIconOnlyBaseStylewill be the base style used to determine the css style to apply to the tabs ifTab.canAdaptWidthis set and the title is not being shown.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 "iconOnlyTabButtonTopOver".
Note that this property is only defined for certain skins, where it's needed. If not defined,
simpleTabBaseStylewill serve as base style whether or not the title is hidden.- Returns:
- Current simpleTabIconOnlyBaseStyle value. Default value is varies
- See Also:
-
setSkinImgDir
Default directory for skin images (those defined by the class), relative to the Page-wideskinDir.- Overrides:
setSkinImgDirin classCanvas- Parameters:
skinImgDir- New skinImgDir value. Default value is "images/TabSet/"- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getSkinImgDir
Default directory for skin images (those defined by the class), relative to the Page-wideskinDir.- Overrides:
getSkinImgDirin classCanvas- Returns:
- Current skinImgDir value. Default value is "images/TabSet/"
- See Also:
-
setSymmetricEdges
If this tabSet willshow edgesfor 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
symmetricEdgesis false, custom edge sizes for the pane container may be specified viatopEdgeSizeset al, and custom edge offsets viatopEdgeOffsetset al.- Parameters:
symmetricEdges- New symmetricEdges value. Default value is true- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getSymmetricEdges
If this tabSet willshow edgesfor 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
symmetricEdgesis false, custom edge sizes for the pane container may be specified viatopEdgeSizeset al, and custom edge offsets viatopEdgeOffsetset al.- Returns:
- Current symmetricEdges value. Default value is true
- See Also:
-
setSymmetricPickerButton
If this TabSet is showing atab picker button, this property determines whether thepickerButtonHSrcandpickerButtonVSrcmedia will be used for vertical and horizontal tab-bar picker buttons, or whether separate media should be used for each possibletabBarPositionbased on thepickerButtonSrcproperty for this tabSet.- Parameters:
symmetricPickerButton- New symmetricPickerButton value. Default value is true- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getSymmetricPickerButton
If this TabSet is showing atab picker button, this property determines whether thepickerButtonHSrcandpickerButtonVSrcmedia will be used for vertical and horizontal tab-bar picker buttons, or whether separate media should be used for each possibletabBarPositionbased on thepickerButtonSrcproperty for this tabSet.- Returns:
- Current symmetricPickerButton value. Default value is true
-
setSymmetricScroller
If this TabSet is showingtab scroller buttons, this property determines whether thescrollerHSrcandscrollerVSrcmedia will be used for vertical and horizontal tab-bar scroller buttons, or whether separate media should be used for each possibletabBarPositionbased on thescrollerSrcproperty for this tabSet.- Parameters:
symmetricScroller- New symmetricScroller value. Default value is true- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getSymmetricScroller
If this TabSet is showingtab scroller buttons, this property determines whether thescrollerHSrcandscrollerVSrcmedia will be used for vertical and horizontal tab-bar scroller buttons, or whether separate media should be used for each possibletabBarPositionbased on thescrollerSrcproperty for this tabSet.- Returns:
- Current symmetricScroller value. Default value is true
-
getTabBar
TabBar for this TabSet, an instance ofTabBar.This component is an AutoChild named "tabBar". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current tabBar value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setTabBarAlign
Alignment of the tabBar.If the
tabBarPositionis "top" or "bottom", then this attribute may be set to "left", "right" or "center". The default is "left", or "right" inRTL mode.If the
tabBarPositionis "left" or "right", then this attribute may be set to "top", "bottom" or "center". The default is "top".- Parameters:
tabBarAlign- New tabBarAlign value. Default value is see below- Returns:
TabSetinstance, for chaining setter calls- See Also:
-
getTabBarAlign
Alignment of the tabBar.If the
tabBarPositionis "top" or "bottom", then this attribute may be set to "left", "right" or "center". The default is "left", or "right" inRTL mode.If the
tabBarPositionis "left" or "right", then this attribute may be set to "top", "bottom" or "center". The default is "top".- Returns:
- Current tabBarAlign value. Default value is see below
- See Also:
-
setTabBarAlign
Alignment of the tabBar.If the
tabBarPositionis "top" or "bottom", then this attribute may be set to "left", "right" or "center". The default is "left", or "right" inRTL mode.If the
tabBarPositionis "left" or "right", then this attribute may be set to "top", "bottom" or "center". The default is "top".- Parameters:
tabBarAlign- New tabBarAlign value. Default value is see below- Returns:
TabSetinstance, for chaining setter calls- See Also:
-
getTabBarAlignAsAlignment
Alignment of the tabBar.If the
tabBarPositionis "top" or "bottom", then this attribute may be set to "left", "right" or "center". The default is "left", or "right" inRTL mode.If the
tabBarPositionis "left" or "right", then this attribute may be set to "top", "bottom" or "center". The default is "top".- Returns:
- Current tabBarAlign value. Default value is see below
- See Also:
-
getTabBarControlLayout
com.smartgwt.client.types.AutoChildof typeLayoutthat holds thetabBarControlsas well as the built-in controls such as thetab picker menu.This component is an AutoChild named "tabBarControlLayout". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current tabBarControlLayout value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setTabBarPosition
Which side of the TabSet the TabBar should appear on.- Parameters:
tabBarPosition- New tabBarPosition value. Default value is Canvas.TOP- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getTabBarPosition
Which side of the TabSet the TabBar should appear on.- Returns:
- Current tabBarPosition value. Default value is Canvas.TOP
- See Also:
-
setTabBarThickness
Thickness of tabBar, applies to either orientation (specifies height for horizontal, width for vertical orientation). Note that overriding this value for TabSets that are skinned with images generally means providing new media for the borders.- Parameters:
tabBarThickness- New tabBarThickness value. Default value is 21- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getTabBarThickness
public int getTabBarThickness()Thickness of tabBar, applies to either orientation (specifies height for horizontal, width for vertical orientation). Note that overriding this value for TabSets that are skinned with images generally means providing new media for the borders.- Returns:
- Current tabBarThickness value. Default value is 21
-
getTabPicker
A button control that allows tabs to be picked directly from a popup menu. The tabPicker is created automatically when needed and when"tabPicker"is specified in thetabBarControls.This component is an AutoChild named "tabPicker". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current tabPicker value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
getTitleEditor
TextItem we use to edit tab titles in this TabSet. You can override this property using the normalcom.smartgwt.client.types.AutoChildfacilities.This component is an AutoChild named "titleEditor". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current titleEditor value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.- See Also:
-
setTitleEditorLeftOffset
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. Note that the editor is always offset to avoid overlapping the endcaps of the tab; this property is applied on top of that default offset.- Parameters:
titleEditorLeftOffset- New titleEditorLeftOffset value. Default value is null- Returns:
TabSetinstance, for chaining setter calls- See Also:
-
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. Note that the editor is always offset to avoid overlapping the endcaps of the tab; this property is applied on top of that default offset.- Returns:
- Current titleEditorLeftOffset value. Default value is null
- See Also:
-
setTitleEditorProperties
Properties for the auto-generatedtitleEditor. This is the text item we use to edit tab titles in this tabSet.- Parameters:
titleEditorProperties- New titleEditorProperties value. Default value is null- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
com.smartgwt.client.widgets.tab.TabSet#setTitleEditorsetCanEditTabTitles(java.lang.Boolean)
-
getTitleEditorProperties
Properties for the auto-generatedtitleEditor. This is the text item we use to edit tab titles in this tabSet.- Returns:
- Current titleEditorProperties value. Default value is null
- See Also:
-
setTitleEditorRightOffset
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. Note that the editor is always offset to avoid overlapping the endcaps of the tab; this property is applied on top of that default offset.- Parameters:
titleEditorRightOffset- New titleEditorRightOffset value. Default value is null- Returns:
TabSetinstance, for chaining setter calls- See Also:
-
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. Note that the editor is always offset to avoid overlapping the endcaps of the tab; this property is applied on top of that default offset.- Returns:
- Current titleEditorRightOffset value. Default value is null
- See Also:
-
setTitleEditorTopOffset
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. You can use this property, together with the left and right offset properties, to fine tune positioning of the editor within or around the tab button.Note: The height of the editor is an attribute of the editor itself, and can be set by specifying a "height" property in
titleEditorDefaults.- Parameters:
titleEditorTopOffset- New titleEditorTopOffset value. Default value is null- Returns:
TabSetinstance, for chaining setter calls- See Also:
-
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. You can use this property, together with the left and right offset properties, to fine tune positioning of the editor within or around the tab button.Note: The height of the editor is an attribute of the editor itself, and can be set by specifying a "height" property in
titleEditorDefaults.- Returns:
- Current titleEditorTopOffset value. Default value is null
- See Also:
-
setTouchPickerButtonSize
The size of the tab picker button whenisTouchistrue.- Parameters:
touchPickerButtonSize- New touchPickerButtonSize value. Default value is 16- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getTouchPickerButtonSize
public int getTouchPickerButtonSize()The size of the tab picker button whenisTouchistrue.- Returns:
- Current touchPickerButtonSize value. Default value is 16
- See Also:
-
setUseIOSTabs
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. This mode does not support a clickable icon - clicking the enlarged icon just switches tabs.This attribute only has an effect for tabs that are not
closable, and only for Mobile WebKit.- Parameters:
useIOSTabs- New useIOSTabs value. Default value is false- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
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. This mode does not support a clickable icon - clicking the enlarged icon just switches tabs.This attribute only has an effect for tabs that are not
closable, and only for Mobile WebKit.- Returns:
- Current useIOSTabs value. Default value is false
-
setUseSimpleTabs
Should we use simple button based tabs styled with CSS rather than image basedImgTabtabs?If set to true tabs will instances of
Button, styled according to thesimpleTabBaseStyle.Note : This is an advanced setting
- Parameters:
useSimpleTabs- New useSimpleTabs value. Default value is false- Returns:
TabSetinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getUseSimpleTabs
Should we use simple button based tabs styled with CSS rather than image basedImgTabtabs?If set to true tabs will instances of
Button, styled according to thesimpleTabBaseStyle.- Returns:
- Current useSimpleTabs value. Default value is false
-
addAddTabClickHandler
Add a addTabClick handler.Notification method fired when the user clicks the
TabSet.addTabButton.No default implementation.
- Specified by:
addAddTabClickHandlerin interfaceHasAddTabClickHandlers- Parameters:
handler- the addTabClick handler- Returns:
HandlerRegistrationused to remove this handler
-
addAddTabClickedHandler
Deprecated.Add a addTabClicked handler.Click handler applied to the
TabSet.addTabButton.The default implementation will invoke
TabSet.addTabClick()- Specified by:
addAddTabClickedHandlerin interfaceHasAddTabClickedHandlers- Parameters:
handler- the addTabClicked handler- Returns:
HandlerRegistrationused to remove this handler
-
cancelTabTitleEditing
public void cancelTabTitleEditing()If the user is currently editing a tab title (seecanEditTabTitles), dismiss the editor and discard the edit value entered by the user. -
getSelectedTabNumber
public int getSelectedTabNumber()Returns the index of the currently selected tab object.- Returns:
- the index of the currently selected tab object
-
hideTab
public void hideTab(int tab) Hide a tab in this tabset at runtime. If the tab is selected, it will be deselected and the tab button will be hidden from the user.Note that this does not remove a tab from the tabset entirely (see
removeTab()) The tab will no longer be visible to the user or selectable by the user, but the configuration will still existing in thetabs arrayfor this tabSet. Developers should particularly be aware of this when calling methods that refer to tabs by index - the index includes both hidden and visible tabs in the tabset.Tabs may be marked as hidden at init-time via
Tab.hidden.To test whether a tab is currently visible, use
tabIsVisible()- Parameters:
tab- Tab to hide
-
hideTab
Hide a tab in this tabset at runtime. If the tab is selected, it will be deselected and the tab button will be hidden from the user.Note that this does not remove a tab from the tabset entirely (see
removeTab()) The tab will no longer be visible to the user or selectable by the user, but the configuration will still existing in thetabs arrayfor this tabSet. Developers should particularly be aware of this when calling methods that refer to tabs by index - the index includes both hidden and visible tabs in the tabset.Tabs may be marked as hidden at init-time via
Tab.hidden.To test whether a tab is currently visible, use
tabIsVisible()- Parameters:
tab- Tab to hide
-
hideTab
Hide a tab in this tabset at runtime. If the tab is selected, it will be deselected and the tab button will be hidden from the user.Note that this does not remove a tab from the tabset entirely (see
removeTab()) The tab will no longer be visible to the user or selectable by the user, but the configuration will still existing in thetabs arrayfor this tabSet. Developers should particularly be aware of this when calling methods that refer to tabs by index - the index includes both hidden and visible tabs in the tabset.Tabs may be marked as hidden at init-time via
Tab.hidden.To test whether a tab is currently visible, use
tabIsVisible()- Parameters:
tab- Tab to hide
-
addCloseClickHandler
Add a closeClick handler.When
TabSet.canCloseTabsis set, this notification method fired when the user clicks the "close" icon for a tab. CallTabCloseClickEvent.cancel()from withinCloseClickHandler.onCloseClick(com.smartgwt.client.widgets.tab.events.TabCloseClickEvent)to cancel default behavior of removing the tab from the TabSet- Specified by:
addCloseClickHandlerin interfaceHasCloseClickHandlers- Parameters:
handler- the closeClick handler- Returns:
HandlerRegistrationused to remove this handler
-
removeLastTab
public void removeLastTab()Removes the last tab in the TabSet, excluding themoreTabif present. -
reorderTab
Move a tab to another location in the tabset.- Parameters:
tab- tab to move
-
reorderTab
Move a tab to another location in the tabset.- Parameters:
tab- tab to movemoveToPosition- the index to move the tab to - defaults to the end of the tabset if not passed
-
saveTabTitle
public void saveTabTitle()If the user is currently editing a tab title (seecanEditTabTitles), save the edited tab title and hide the editor. -
scrollBack
public 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. -
scrollForward
public 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. -
setCanCloseTab
Sets the given tab'scanCloseproperty to the boolean parameter canClose. If canClose is null, this will have the effect of causing the tab to fall back oncanCloseTabs.- Parameters:
tab- tab to changecanClose- new value for the tab's canClose property, or null to clear it
-
setTabPickerTitle
Changes the title of the picker menu item of a tab- Parameters:
tab-pickerTitle- new title. SeeHTMLString
-
showTab
public void showTab(int tab) Show ahidden tabat runtime.To test whether a tab is currently visible, use
tabIsVisible()- Parameters:
tab- Tab to hide
-
showTab
Show ahidden tabat runtime.To test whether a tab is currently visible, use
tabIsVisible()- Parameters:
tab- Tab to hide
-
showTab
Show ahidden tabat runtime.To test whether a tab is currently visible, use
tabIsVisible()- Parameters:
tab- Tab to hide
-
addTabContextMenuHandler
Add a tabContextMenu handler.Notification fired when the user right-clicks on a tab. Event may be cancelled by returning false
- Specified by:
addTabContextMenuHandlerin interfaceHasTabContextMenuHandlers- Parameters:
handler- the tabContextMenu handler- Returns:
HandlerRegistrationused to remove this handler
-
addTabDeselectedHandler
Add a tabDeselected handler.Optional handler to fire when a tab is deselected. Calling
TabDeselectedEvent.cancelwill cancel the new selection, leaving tabIDselected. As withcom.smartgwt.client.widgets.tab.events.TabSelectedEventlthis method only fires when the tabset is drawn.- Specified by:
addTabDeselectedHandlerin interfaceHasTabDeselectedHandlers- Parameters:
handler- the tabDeselected handler- Returns:
HandlerRegistrationused to remove this handler
-
tabForPane
Search for a tab that contains a pane.- Parameters:
pane- pane to show- Returns:
- tab that contains passed pane
-
addTabIconClickHandler
Add a tabIconClick handler.Method fired when the user clicks the icon for a tab, as specified via
Tab.icon.Default behavior will fire
icon.click()if specified, with two parameterstab(a pointer to the tab object andtabSeta pointer to the tabSet instance.- Specified by:
addTabIconClickHandlerin interfaceHasTabIconClickHandlers- Parameters:
handler- the tabIconClick handler- Returns:
HandlerRegistrationused to remove this handler
-
tabIsVisible
public boolean tabIsVisible(int tab) Is the tabhidden or visible?- Parameters:
tab- Tab to test- Returns:
- returns true if the tab has not been hidden.
-
tabIsVisible
Is the tabhidden or visible?- Parameters:
tab- Tab to test- Returns:
- returns true if the tab has not been hidden.
-
tabIsVisible
Is the tabhidden or visible?- Parameters:
tab- Tab to test- Returns:
- returns true if the tab has not been hidden.
-
addTabSelectedHandler
Add a tabSelected 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
draw()is called,com.smartgwt.client.widgets.tab.events.TabSelectedEventlwill fire ondraw().- Specified by:
addTabSelectedHandlerin interfaceHasTabSelectedHandlers- Parameters:
handler- the tabSelected handler- Returns:
HandlerRegistrationused to remove this handler
-
addTabsReorderedHandler
Add a tabsReordered handler.Notification method executed when one or more tabs in the TabSet are reordered.
- Specified by:
addTabsReorderedHandlerin interfaceHasTabsReorderedHandlers- Parameters:
handler- the tabsReordered handler- Returns:
HandlerRegistrationused to remove this handler
-
addTabTitleChangedHandler
Add a tabTitleChanged 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
canEditTabTitlesis set, or programmatically if application code callseditTabTitle.Call
TabTitleChangedEvent.cancel()from withinTabTitleChangedHandler.onTabTitleChanged(com.smartgwt.client.widgets.tab.events.TabTitleChangedEvent)from this method to cancel the change.- Specified by:
addTabTitleChangedHandlerin interfaceHasTabTitleChangedHandlers- Parameters:
handler- the tabTitleChanged handler- Returns:
HandlerRegistrationused to remove this handler
-
setDefaultProperties
Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties set on the SmartGWT class instance passed to this function before its underlying SmartClient JS object was created. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.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.
- Parameters:
tabSetProperties- properties that should be used as new defaults when instances of this class are created- See Also:
-
setSelectedTab
public void setSelectedTab(int selectedTab) Specifies the index of the initially selected tab.- Parameters:
selectedTab- selectedTab Default value is 0
-
setTabs
An array ofTabobjects, 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
Tabinstances tosetTabs(), the TabSet creates actual UI widgets to serve as interactive tabs. Any further modifications to tabs should be performed via TabSet APIs such assetTabTitle,setTabIconandsetTabPane.You can add and remove tabs after creating the TabSet by calling
addTabandremoveTab.- Parameters:
tabs- new tabs for the TabSet
-
setPaneContainerProperties
Properties of the container where the component specified by Tab.pane is shown.- Parameters:
paneContainerProperties- the pane container properties- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
setTabBarControls
This property determines what controls should show up after the tabBar for this TabSet. Standard controls can be included using the strings"tabScroller"and"tabPicker". These correspond to thescrollerandtabPickerAutoChildren, 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 ifshowTabScrollerorshowTabPickeris true and there is not enough space available to show all of the tabs in the tabBar.- Parameters:
tabBarControls- tabBarControls Default value is ["tabScroller", "tabPicker"]- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
- This
sample illustrates the usage of this property
Additional 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
- This
sample illustrates the usage of this property
-
selectTab
public void selectTab(int tabIndex) Select a tab.- Parameters:
tabIndex- the tab index
-
selectTab
Select a tab.- Parameters:
ID- the tab ID
-
selectTab
Select a tab.- Parameters:
tab- the tab
-
setTabTitle
Changes the title of a tab- Parameters:
tabIndex- the tab indextitle- new title
-
setTabTitle
Changes the title of a tab- Parameters:
ID- the tab IDtitle- new title
-
setTabTitle
Changes the title of a tab- Parameters:
tab- the tabtitle- new title
-
setTabIcon
Changes the icon of a tab- Parameters:
tabIndex- the tab indexiconURL- new icon
-
setTabIcon
Changes the icon of a tab- Parameters:
ID- the tab IDiconURL- new icon
-
setTabIcon
Changes the icon of a tab- Parameters:
tab- the tabiconURL- new icon
-
enableTab
public void enableTab(int tabIndex) If the specified tab is disabled, enable it now.- Parameters:
tabIndex- the tab index
-
enableTab
If the specified tab is disabled, enable it now.- Parameters:
ID- the tab id
-
enableTab
If the specified tab is disabled, enable it now.- Parameters:
tab- the tab
-
updateTab
Set the pane for a tab. NOTE: the old pane for the tab is not destroy()d- Parameters:
tabIndex- the tab indexpane- the new pane for the tab
-
updateTab
Set the pane for a tab. NOTE: the old pane for the tab is not destroy()d- Parameters:
tab- the tabpane- the new pane for the tab
-
disableTab
public void disableTab(int tabIndex) If the specified tab is enabled, disable it now.- Parameters:
tabIndex- the tab index
-
disableTab
If the specified tab is enabled, disable it now.- Parameters:
ID- the tab id
-
disableTab
If the specified tab is enabled, disable it now.- Parameters:
tab- the tab
-
removeTab
public void removeTab(int tabIndex) Remove a 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)withnullas the new pane immediately before removing the tab.- Parameters:
tabIndex- the tab index
-
removeTab
Remove a 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)withnullas the new pane immediately before removing the tab.- Parameters:
ID- the tabID
-
removeTab
Remove a 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)withnullas the new pane immediately before removing the tab.- Parameters:
tab- the tab
-
removeTabs
public void removeTabs(int[] tabIndexes) Remove one or more tabs. The pane(s) associated with the removed tab(s) is automatically destroyed when you call this method.- Parameters:
tabIndexes- the tab indexes
-
removeTabs
Remove one or more tabs. The pane(s) associated with the removed tab(s) is automatically destroyed when you call this method.- Parameters:
ids- the tabIDs
-
getSelectedTab
The currently selected tab.- Returns:
- the currently selected Tab
-
getTabCanvas
Get the live Canvas representing a tab by index. * The underlying SmartClient class of the returned canvas depends ongetUseSimpleTabs(). If this property is false, the returned canvas will be aImgTabinstance. If true the canvas will be acom.smartgwt.client.widgets.tab.Buttoninstance. Note that you can make use of ImgTab APIs by using thegetJsObj()andcreate()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.- Parameters:
tab-- Returns:
- the tab Canvas, or null if not found or TabSet not drawn yet
-
getTabCanvas
Get the live Canvas representing a tab by index. The underlying SmartClient class of the returned canvas depends ongetUseSimpleTabs(). If this property is false, the returned canvas will be aImgTabinstance. If true the canvas will be acom.smartgwt.client.widgets.tab.Buttoninstance. Note that you can make use of ImgTab APIs by using thegetJsObj()andcreate()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.- Parameters:
tab-- Returns:
- the tab Canvas, or null if not found or TabSet not drawn yet
-
getTab
Retrieves a Tab definition from within this tabSet by index.- Parameters:
index- of tab to retrieve- Returns:
- the tab definition
-
getTab
Retrieves a Tab definition from within this tabSet by ID.- Parameters:
ID- of tab to retrieve- Returns:
- the tab definition
-
getTabNumber
Get the index of a tab from the tabID.- Parameters:
ID- the tab ID- Returns:
- the index of the tab, or -1 if not found
-
addTab
Add a tab- Parameters:
tab- new tab
-
addTab
Add a tab- Parameters:
tab- new tabposition- the position where tab should be added
-
getNumTabs
public int getNumTabs()The number of tabs- Returns:
- the number of tabs
-
setTitleEditEvent
The event that triggers title editing on this TabSet.- Parameters:
titleEditEvent- titleEditEvent Default value is "doubleClick"- See Also:
-
getTitleEditEvent
The event that triggers title editing on this TabSet.- Returns:
- TabTitleEditEvent
- See Also:
-
editTabTitle
Places an editor in the title of the parameter tab and allows the user to edit the title. Note that this programmatic method will <b.always allow editing of the specified tab's title, regardless of the settings ofcanEditTabTitlesorcanEditTitle.- Parameters:
tab- The tab whose title should be edited (may be specified by ID or index)
-
editTabTitle
public void editTabTitle(int tab) Places an editor in the title of the parameter tab and allows the user to edit the title. Note that this programmatic method will <b.always allow editing of the specified tab's title, regardless of the settings ofcanEditTabTitlesorcanEditTitle.- Parameters:
tab- The tab whose title should be edited (may be specified by ID or index)
-
getTabs
The tabs- Returns:
- the tabs
-
setTabBarProperties
This attribute allows developers to specify custom properties for this tabset'stabBar- Parameters:
tabBarProperties- tabBarProperties Default value is null- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
setTabPane
Apply a newpaneto an existing tab in this tabSet- Parameters:
tabIndex- Tab to updatepane- new Pane for the tab. pass null to drop existing pane
-
setTabPane
Apply a newpaneto an existing tab in this tabSet- Parameters:
tabID- Tab to updatepane- new Pane for the tab. pass null to drop existing pane
-
preloadImages
public static void preloadImages()Preload primary tab skin images. -
revealChild
Reveals the child Canvas passed in by selecting the tab containing that child if it is not already selected. If no tab in this TabSet contains the passed-in Canvas, this method has no effectNOTE: This is an override point.
- Overrides:
revealChildin classCanvas- Parameters:
childID- the global ID of the child Canvas to reveal
-
revealChild
Reveals the child Canvas passed in by selecting the tab containing that child if it is not already selected. If no tab in this TabSet contains the passed-in Canvas, this method has no effectNOTE: This is an override point.
- Overrides:
revealChildin classCanvas- Parameters:
child- the child Canvas to reveal
-
setLogicalStructure
Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility. -
getLogicalStructure
Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.- Specified by:
getLogicalStructurein interfaceLogicalStructure- Overrides:
getLogicalStructurein classCanvas
-