TabSetControl

TabSetControl Functions

getAllState	TabSetControl.getAllState( )	Default styling properties for all tab headers.
getContentPanel	TabSetControl.getContentPanel( )	Styling properties applied to tab content panels.
getHeight	TabSetControl.getHeight( )	Height of the Tab Set Control.
setHeight	TabSetControl.setHeight( height )	Sets the height of the Tab Set Control, and is equivalent to the CSS height property and any valid value for this CSS property can be used.
getHoverState	TabSetControl.getHoverState( )	Styling properties applied to tab headers when the mouse is hovered over a tab.
getHoverTextStyle	TabSetControl.getHoverTextStyle( )	Returns the inline CSS style applied to tab headers when the mouse is hovered over a tab..
setHoverTextStyle	TabSetControl.setHoverTextStyle( hoverTextStyle )	Sets the inline CSS style to be applied to tab headers when the mouse is hovered over a tab.
getLeftHoverTabImage	TabSetControl.getLeftHoverTabImage( )	URL of the image used for the top left corner of all tab headers when the mouse is hovered over a tab.
setLeftHoverTabImage	TabSetControl.setLeftHoverTabImage( leftHoverTabImage )	Sets the URL of the image used for the top left corner of all tab headers when the mouse is hovered over a tab.
getLeftSelectedTabImage	TabSetControl.getLeftSelectedTabImage( )	URL of the image used for the top left corner of all tab headers when selected.
setLeftSelectedTabImage	TabSetControl.setLeftSelectedTabImage( leftSelectedTabImage )	Sets the URL of the image used for the top left corner of all tab headers when selected.
getLeftTabImage	TabSetControl.getLeftTabImage( )	URL of the image used for the top left corner of all tab headers when not selected.
setLeftTabImage	TabSetControl.setLeftTabImage( leftTabImage )	Sets the URL of the image used for the top left corner of all tab headers when not selected.
getPanelClass	TabSetControl.getPanelClass( )	Returns the list of CSS classes applied to the tab content panels.
setPanelClass	TabSetControl.setPanelClass( panelClass )	Sets one or more CSS classes to be applied to the tab content panels.
getPanelStyle	TabSetControl.getPanelStyle( )	Returns the inline CSS style applied to the tab content panels.
setPanelStyle	TabSetControl.setPanelStyle( panelStyle )	Sets the inline CSS style to be applied to the tab content panels.
getRightHoverTabImage	TabSetControl.getRightHoverTabImage( )	URL of the image used for the top right corner of all tab headers when the mouse is hovered over a tab.
setRightHoverTabImage	TabSetControl.setRightHoverTabImage( rightHoverTabImage )	Sets the URL of the image used for the top right corner of all tab headers when the mouse is hovered over a tab.
getRightSelectedTabImage	TabSetControl.getRightSelectedTabImage( )	URL of the image used for the top right corner of all tab headers when selected.
setRightSelectedTabImage	TabSetControl.setRightSelectedTabImage( rightSelectedTabImage )	Sets the URL of the image used for the top right corner of all tab headers when selected.
getRightTabImage	TabSetControl.getRightTabImage( )	URL of the image used for the top right corner of all tab headers when not selected.
setRightTabImage	TabSetControl.setRightTabImage( rightTabImage )	Sets the URL of the image used for the top right corner of all tab headers when not selected.
getSelected	TabSetControl.getSelected( )	The item name of the currently selected tab or null if no tab is selected.
setSelected	TabSetControl.setSelected( tab )	Sets the currently selected tab which results in this tab being displayed.
getSelectedState	TabSetControl.getSelectedState( )	Styling properties applied to tab headers when a tab is selected.
getSelectedTextStyle	TabSetControl.getSelectedTextStyle( )	Returns the inline CSS style applied to both a tab header and its content panel when a tab has been selected.
setSelectedTextStyle	TabSetControl.setSelectedTextStyle( selectedTextStyle )	Sets the inline CSS style to be applied to both a tab header and its content panel when a tab has been selected.
isSkipValidation	TabSetControl.isSkipValidation( )	Returns the skip validation flag that indicates whether or not validation of controls higher on the page is skipped prior to executing the on tab click event (if configured).
setSkipValidation	TabSetControl.setSkipValidation( skipValidation )	Specifies whether or not validation of controls higher on the page is skipped prior to executing the on tab click event (if configured).
getSpaceBetweenTabs	TabSetControl.getSpaceBetweenTabs( )	The space between adjacent tab headers.
setSpaceBetweenTabs	TabSetControl.setSpaceBetweenTabs( spaceBetweenTabs )	Sets the space between adjacent tab headers.
getTabAllColor	TabSetControl.getTabAllColor( )	The default background color applied to both tab header and its content panel.
setTabAllColor	TabSetControl.setTabAllColor( tabAllColor )	Sets the default background color applied to both tab header and its content panel.
getTabBorderColor	TabSetControl.getTabBorderColor( )	The border color applied to both the tabs and the content panel.
setTabBorderColor	TabSetControl.setTabBorderColor( tabBorderColor )	Sets the border color applied to both the tabs and the content panel.
getTabColor	TabSetControl.getTabColor( )	The background color applied to the tab header when the tab is not selected.
setTabColor	TabSetControl.setTabColor( tabColor )	Sets the background color applied to the tab header when a tab is not selected.
getTabCornerType	TabSetControl.getTabCornerType( )	The style of corner applied to the top left and top right corners of all tab headers.
setTabCornerType	TabSetControl.setTabCornerType( tabCornerType )	Sets the style of corner applied to the top left and top right corners of all tab headers.
getTabHeaderClass	TabSetControl.getTabHeaderClass( )	Returns the list of CSS classes applied to all tab headers.
setTabHeaderClass	TabSetControl.setTabHeaderClass( tabHeaderClass )	Sets one or more CSS classes to be applied to all tab headers.
getTabHeaderStyle	TabSetControl.getTabHeaderStyle( )	Returns the inline CSS style applied to all tab headers.
setTabHeaderStyle	TabSetControl.setTabHeaderStyle( tabHeaderStyle )	Sets the inline CSS style to be applied to all tab headers.
getTabHoverColor	TabSetControl.getTabHoverColor( )	The background color applied to a tab header when the mouse is hovered over a tab.
setTabHoverColor	TabSetControl.setTabHoverColor( tabHoverColor )	Sets the background color applied to both tab header when the mouse is hovered over a tab.
getTabSelectedColor	TabSetControl.getTabSelectedColor( )	The background color applied to both tab header and its content panel when a tab is selected.
setTabSelectedColor	TabSetControl.setTabSelectedColor( tabSelectedColor )	Sets the background color applied to both tab header and its content panel when a tab is selected.
getTabWidth	TabSetControl.getTabWidth( )	The width of individual tab headers.
setTabWidth	TabSetControl.setTabWidth( tabWidth )	Sets the width of individual tab headers.
getUnselectedState	TabSetControl.getUnselectedState( )	Styling properties applied to tab headers when a tab is not selected.
getUnselectedTextStyle	TabSetControl.getUnselectedTextStyle( )	Returns the inline CSS style applied to unselected tab headers.
setUnselectedTextStyle	TabSetControl.setUnselectedTextStyle( unselectedTextStyle )	Sets the inline CSS style to be applied to unselected tab headers.
getWidth	TabSetControl.getWidth( )	Width of the Tab Set Control.
setWidth	TabSetControl.setWidth( width )	Sets the width of the Tab Set Control.

AriaControlProperties Functions

addAriaCustomAttribute	TabSetControl.addAriaCustomAttribute( name , value )	Add an ARIA custom attribute with a specified name and value.
getAriaCustomAttributes	TabSetControl.getAriaCustomAttributes( )	Returns a comma separated list of the ARIA custom attributes for the control.
setAriaCustomAttributes	TabSetControl.setAriaCustomAttributes( ariaCustomAttributes )	Sets the ARIA custom attributes as a comma separated list associated with the control property and overrides the aria custom attributes value.
getAriaDescribedBy	TabSetControl.getAriaDescribedBy( )	Returns the ARIA described-by element ID for the control.
getAriaLabelledBy	TabSetControl.getAriaLabelledBy( )	Returns the ARIA labelled-by element ID for the control.
getAriaLabelText	TabSetControl.getAriaLabelText( )	Returns the com.ebasetech.xi.api.Text object for the ARIA label text.
getAriaRole	TabSetControl.getAriaRole( )	Returns the ARIA role for the control.
setAriaRole	TabSetControl.setAriaRole( role )	Sets the ARIA role for the control.
removeAriaCustomAttribute	TabSetControl.removeAriaCustomAttribute( name )	Remove an ARIA custom attribute specified by name.

ContainerControl Functions

getChildControls

TabSetControl.getChildControls( )

Returns an array of controls that are immediate children of this control.

MarginStyleProperties Functions

getAllMargin	TabSetControl.getAllMargin( )	Single MarginStyleProperties size value used for top, bottom, left and right margin.
setAllMargin	TabSetControl.setAllMargin( allMargin )	Sets the MarginStyleProperties size value used for top, bottom, left and right margin.
getBottomMargin	TabSetControl.getBottomMargin( )	Bottom MarginStyleProperties size value.
setBottomMargin	TabSetControl.setBottomMargin( bottomMargin )	Sets the bottom MarginStyleProperties size value.
getLeftMargin	TabSetControl.getLeftMargin( )	Left MarginStyleProperties size value.
setLeftMargin	TabSetControl.setLeftMargin( leftMargin )	Sets the left MarginStyleProperties size value.
getRightMargin	TabSetControl.getRightMargin( )	Right MarginStyleProperties size value.
setRightMargin	TabSetControl.setRightMargin( rightMargin )	Sets the right MarginStyleProperties size value.
getTopMargin	TabSetControl.getTopMargin( )	Top MarginStyleProperties size value.
setTopMargin	TabSetControl.setTopMargin( topMargin )	Sets the top MarginStyleProperties size value.

MessageProperties Functions

getErrorMessageStyle	TabSetControl.getErrorMessageStyle( )	Returns the MessageStyleProperties object representing error message styling properties.
getInfoMessageStyle	TabSetControl.getInfoMessageStyle( )	Returns the MessageStyleProperties object representing info message styling properties.
getWarningMessageStyle	TabSetControl.getWarningMessageStyle( )	Returns the MessageStyleProperties object representing warning message styling properties.

TextStyleProperties Functions

getLineHeight	TabSetControl.getLineHeight( )	Line height.
setLineHeight	TabSetControl.setLineHeight( lineHeight )	Sets the line height, this is equivalent to the CSS line-height property and any valid value for this CSS property can be used.
getTextBold	TabSetControl.getTextBold( )	Text bold setting.
setTextBold	TabSetControl.setTextBold( textBold )	Sets the text bold setting.
getTextColor	TabSetControl.getTextColor( )	Text color.
setTextColor	TabSetControl.setTextColor( textColor )	Sets the text color, this is equivalent to the CSS color property and any valid value for this CSS property can be used.
getTextDecoration	TabSetControl.getTextDecoration( )	Text decoration property (shown as Lines in the designer).
setTextDecoration	TabSetControl.setTextDecoration( textDecoration )	Sets the text decoration property (shown as Lines in the designer).
getTextFont	TabSetControl.getTextFont( )	List of text fonts.
setTextFont	TabSetControl.setTextFont( textFont )	Sets the list of text fonts, this is equivalent to the CSS font-family property and any valid value for this CSS property can be used.
getTextItalic	TabSetControl.getTextItalic( )	Text italic setting.
setTextItalic	TabSetControl.setTextItalic( textItalic )	Sets the text italic setting.
getTextSize	TabSetControl.getTextSize( )	Text size.
setTextSize	TabSetControl.setTextSize( textSize )	Sets the text size, this is equivalent to the CSS font-size property and any valid value for this CSS property can be used.

Control Functions

addCssClass	TabSetControl.addCssClass( cssClass )	Adds one or more CSS classes to the list of classes applied to the control, retaining any existing classes.
getAll	TabSetControl.getAll( )	Returns a control object of the same type as the control object on which this method is invoked, that gives access to all occurrences of this control on the page.
isContainer	TabSetControl.isContainer( )	Returns true if this control is a container control i.e.
getCssClass	TabSetControl.getCssClass( )	Returns the list of CSS classes configured for the control.
setCssClass	TabSetControl.setCssClass( cssClass )	Sets one or more CSS classes to be applied to the control.
isDisplayOnly	TabSetControl.isDisplayOnly( )	Returns true if the control is marked as display only, otherwise returns false.
setDisplayOnly	TabSetControl.setDisplayOnly( displayOnly )	Marks the control and all its children as display only (when displayOnly is true) or enterable (when displayOnly is false).
isDisplayOnlyIncludingParents	TabSetControl.isDisplayOnlyIncludingParents( )	Returns true if the control or any of its parents is marked as display only, otherwise returns false.
getErrorMsgClass	TabSetControl.getErrorMsgClass( )	Returns the list of CSS classes configured for error messages when the messages are displayed locally to the control.
setErrorMsgClass	TabSetControl.setErrorMsgClass( errorMsgClass )	Sets one or more CSS classes to be applied to error messages when the messages are displayed locally to the control.
getErrorMsgStyle	TabSetControl.getErrorMsgStyle( )	Returns the inline CSS style configured for error messages when the messages are displayed locally to the control.
setErrorMsgStyle	TabSetControl.setErrorMsgStyle( errorMsgStyle )	Sets inline CSS style to be applied to error messages when the messages are displayed locally to the control.
isEventField	TabSetControl.isEventField( )	Returns true if the control is an event field i.e.
hasModifier	TabSetControl.hasModifier( modifier )	Returns true if the control has the specified modifier, otherwise returns false.
isHidden	TabSetControl.isHidden( )	Returns true if the control is marked as hidden, otherwise returns false.
setHidden	TabSetControl.setHidden( hidden )	Hides or shows the control and all its children.
hide	TabSetControl.hide( )	Hides the control, this is equivalent to setting property hidden to true.
getInfoMsgClass	TabSetControl.getInfoMsgClass( )	Returns the list of CSS classes configured for info messages when the messages are displayed locally to the control.
setInfoMsgClass	TabSetControl.setInfoMsgClass( infoMsgClass )	Sets one or more CSS classes to be applied to info messages when the messages are displayed locally to the control.
getInfoMsgStyle	TabSetControl.getInfoMsgStyle( )	Returns the inline CSS style configured for info messages when the messages are displayed locally to the control.
setInfoMsgStyle	TabSetControl.setInfoMsgStyle( infoMsgStyle )	Sets inline CSS style to be applied to info messages when the messages are displayed locally to the control.
isInheritMsg	TabSetControl.isInheritMsg( )	Returns true if Use parent control setting is checked in the Message Options properties for the control, otherwise returns false.
getLayoutCell	TabSetControl.getLayoutCell( )	Returns the LayoutCell object which can be used to override properties of the parent control's layout as applied to this control.
isLocalMsg	TabSetControl.isLocalMsg( )	Returns true if Local Message is checked in the Message Options properties for the control, otherwise returns false.
isNewLine	TabSetControl.isNewLine( )	Returns the new line property.
setNewLine	TabSetControl.setNewLine( newLine )	Sets or unsets the control's new line property.
getNextSiblingControl	TabSetControl.getNextSiblingControl( )	Returns the control that appears after this control within the same parent, or null if no such control exists.
getPage	TabSetControl.getPage( )	Returns the com.ebasetech.xi.api.Page where this control is located.
getParentControl	TabSetControl.getParentControl( )	Returns this control's parent control or null if no such parent exists.
getPreviousSiblingControl	TabSetControl.getPreviousSiblingControl( )	Returns the control that appears before this control within the same parent, or null if no such control exists.
refresh	TabSetControl.refresh( )	Refreshes this control in the user's browser when the page is next displayed.
removeCssClass	TabSetControl.removeCssClass( cssClass )	Removes one or more CSS classes from the control.
requestFocus	TabSetControl.requestFocus( )	Sets the browser focus to the control.
getRootHtmlElementProperties	TabSetControl.getRootHtmlElementProperties( )	Return the root com.ebasetech.xi.api.controls.HtmlElementProperties for the Control
show	TabSetControl.show( )	Shows the control, this is equivalent to setting property hidden to false.
isShowing	TabSetControl.isShowing( )	Returns true if the control will be included in the web page when it's next displayed to the user, otherwise returns false.
getStyle	TabSetControl.getStyle( )	Returns the inline CSS style configured for the control.
setStyle	TabSetControl.setStyle( style )	Sets inline CSS style to be applied to the control.
getWarningMsgClass	TabSetControl.getWarningMsgClass( )	Returns the list of CSS classes configured for warning messages when the messages are displayed locally to the control.
setWarningMsgClass	TabSetControl.setWarningMsgClass( warningMsgClass )	Sets one or more CSS classes to be applied to warning messages when the messages are displayed locally to the control.
getWarningMsgStyle	TabSetControl.getWarningMsgStyle( )	Returns the inline CSS style configured for warning messages when the messages are displayed locally to the control.
setWarningMsgStyle	TabSetControl.setWarningMsgStyle( warningMsgStyle )	Sets inline CSS style to be applied to warning messages when the messages are displayed locally to the control.

MessageContainer Functions

addErrorMessage	TabSetControl.addErrorMessage( message [, stopProcessing ] )	Adds an error message that will be displayed to the user.
addErrorMessage	TabSetControl.addErrorMessage( messageNo [, replaceParameters ] [, stopProcessing ] )	Adds an error message that will be displayed to the user.
addErrorMessageText	TabSetControl.addErrorMessageText( text [, replaceParameters ] [, stopProcessing ] )	Adds an error message that will be displayed to the user, sourced from an existing text.
addInfoMessage	TabSetControl.addInfoMessage( message [, stopProcessing ] )	Adds an information message that will be displayed to the user.
addInfoMessageText	TabSetControl.addInfoMessageText( text [, replaceParameters ] [, stopProcessing ] )	Adds an info message that will be displayed to the user, sourced from an existing text.
addWarningMessage	TabSetControl.addWarningMessage( message [, stopProcessing ] )	Adds a warning message that will be displayed to the user.
addWarningMessage	TabSetControl.addWarningMessage( messageNo [, replaceParameters ] [, stopProcessing ] )	Adds a warning message that will be displayed to the user.
addWarningMessageText	TabSetControl.addWarningMessageText( text [, replaceParameters ] [, stopProcessing ] )	Adds a warning message that will be displayed to the user, sourced from an existing text.
existErrorMessages	TabSetControl.existErrorMessages( )	Returns true if undisplayed error messages exist for this element, otherwise returns false.
existInfoMessages	TabSetControl.existInfoMessages( )	Returns true if undisplayed info messages exist for this element, otherwise returns false.
existMessages	TabSetControl.existMessages( )	Returns true if undisplayed info, warning or error messages exist for this element, otherwise returns false.
existWarningMessages	TabSetControl.existWarningMessages( )	Returns true if undisplayed warning messages exist for this element, otherwise returns false.

Element Functions

getElementName	TabSetControl.getElementName( )	Returns the element name
getElementType	TabSetControl.getElementType( )	Returns the element type