Verj.io JavaScript API

TabControl

A Tab Control represents a single tab within a TabSetControl. Each tab header can contain a text and/or a single image; if an image is displayed as part of the tab, its location can be to the right or left of the text. Each Tab Control acts as a container for any content added to the tab.

Further documentation.

TabControl Functions

getAllState TabControl.getAllState( ) Default styling properties for the tab header.
getHoverState TabControl.getHoverState( ) Styling properties applied to the tab header when the mouse is hovered over a tab.
getImageAltText TabControl.getImageAltText( ) Returns the com.ebasetech.xi.api.Text object for the tab header image alternate text.
getImageClass TabControl.getImageClass( ) Returns the list of CSS classes applied to the tab header image.
setImageClass TabControl.setImageClass( imageClass ) Sets one or more CSS classes to be applied to the tab header image.
getImageMouseOverText TabControl.getImageMouseOverText( ) Returns the com.ebasetech.xi.api.Text object for the tab header image mouse over text.
getImagePosition TabControl.getImagePosition( ) The position of the optional image relative to the tab header text.
setImagePosition TabControl.setImagePosition( imagePosition ) Sets the position of the optional image relative to the tab header text.
getImageProperties TabControl.getImageProperties( ) Styling properties applied to optional tab header image.
getImageStyle TabControl.getImageStyle( ) Returns the inline CSS style applied to the tab header image.
setImageStyle TabControl.setImageStyle( imageStyle ) Sets the inline CSS style to be applied to the tab header image.
getImageURL TabControl.getImageURL( ) Returns the URL of the optional image to be displayed on the tab header.
setImageURL TabControl.setImageURL( imageURL ) Sets the URL of the optional image to be displayed on the tab header.
getItemName TabControl.getItemName( ) The name that uniquely identifies each tab item within a tab set.
getSelectedState TabControl.getSelectedState( ) Styling properties applied to the tab header when selected.
getText TabControl.getText( ) Returns the com.ebasetech.xi.api.Text object for the tab header text.
getTextImageGap TabControl.getTextImageGap( ) The gap between the tab header text and any configured image.
setTextImageGap TabControl.setTextImageGap( textImageGap ) Sets the gap between the tab header text and any configured image.
getUnselectedState TabControl.getUnselectedState( ) Styling properties applied to the tab header when not selected.

LayoutControl Functions

getLayout TabControl.getLayout( ) Returns the Layout object configured for the container control or null if no layout is configured.
getLayoutType TabControl.getLayoutType( ) Returns a String representing the layout type for the container.

ContainerControl Functions

getChildControls TabControl.getChildControls( ) Returns an array of controls that are immediate children of this control.

MessageProperties Functions

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

Control Functions

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

MessageContainer Functions

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

Element Functions

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