Package com.ebasetech.xi.api.controls
Interface TabControl
- All Superinterfaces:
ContainerControl
,Control
,Element
,EventOwner
,LayoutControl
,MessageContainer
,MessageProperties
,java.io.Serializable
,WebFormEventOwner
public interface TabControl extends LayoutControl
A Tab Control represents a single tab within a
Tab Set Control
.
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.
-
Method Summary
Modifier and Type Method Description IndividualTabStateProperties
getAllState()
Default styling properties for the tab header.IndividualTabStateProperties
getHoverState()
Styling properties applied to the tab header when the mouse is hovered over a tab.Text
getImageAltText()
Returns theText
object for the tab header image alternate text.java.lang.String
getImageClass()
Returns the list of CSS classes applied to the tab header image.Text
getImageMouseOverText()
Returns theText
object for the tab header image mouse over text.java.lang.String
getImagePosition()
The position of the optional image relative to the tab header text.ImageStyleProperties
getImageProperties()
Styling properties applied to optional tab header image.java.lang.String
getImageStyle()
Returns the inline CSS style applied to the tab header image.java.lang.String
getImageURL()
Returns the URL of the optional image to be displayed on the tab header.java.lang.String
getItemName()
The name that uniquely identifies each tab item within a tab set.IndividualTabStateProperties
getSelectedState()
Styling properties applied to the tab header when selected.Text
getText()
Returns theText
object for the tab header text.java.lang.String
getTextImageGap()
The gap between the tab header text and any configured image.IndividualTabStateProperties
getUnselectedState()
Styling properties applied to the tab header when not selected.void
setImageClass(java.lang.String imageClass)
Sets one or more CSS classes to be applied to the tab header image.void
setImagePosition(java.lang.String imagePosition)
Sets the position of the optional image relative to the tab header text.void
setImageStyle(java.lang.String imageStyle)
Sets the inline CSS style to be applied to the tab header image.void
setImageURL(java.lang.String imageURL)
Sets the URL of the optional image to be displayed on the tab header.void
setTextImageGap(java.lang.String textImageGap)
Sets the gap between the tab header text and any configured image.Methods inherited from interface com.ebasetech.xi.api.controls.ContainerControl
getChildControls
Methods inherited from interface com.ebasetech.xi.api.controls.Control
addCssClass, getAll, getCssClass, getErrorMsgClass, getErrorMsgStyle, getInfoMsgClass, getInfoMsgStyle, getLayoutCell, getNextSiblingControl, getPage, getParentControl, getPreviousSiblingControl, getRootHtmlElementProperties, getStyle, getWarningMsgClass, getWarningMsgStyle, hasModifier, hide, isContainer, isDisplayOnly, isDisplayOnlyIncludingParents, isEventField, isHidden, isInheritMsg, isLocalMsg, isNewLine, isShowing, refresh, removeCssClass, requestFocus, setCssClass, setDisplayOnly, setErrorMsgClass, setErrorMsgStyle, setHidden, setInfoMsgClass, setInfoMsgStyle, setNewLine, setStyle, setWarningMsgClass, setWarningMsgStyle, show
Methods inherited from interface com.ebasetech.xi.api.Element
getElementName, getElementType
Methods inherited from interface com.ebasetech.xi.api.controls.LayoutControl
getLayout, getLayoutType
Methods inherited from interface com.ebasetech.xi.api.MessageContainer
addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessageText, addErrorMessageText, addErrorMessageText, addInfoMessage, addInfoMessage, addInfoMessageText, addInfoMessageText, addInfoMessageText, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessageText, addWarningMessageText, addWarningMessageText, existErrorMessages, existInfoMessages, existMessages, existWarningMessages
Methods inherited from interface com.ebasetech.xi.api.controls.MessageProperties
getErrorMessageStyle, getInfoMessageStyle, getWarningMessageStyle
-
Method Details
-
getText
Text getText()Returns theText
object for the tab header text.- Since:
- V4.4
-
getImageURL
java.lang.String getImageURL()Returns the URL of the optional image to be displayed on the tab header. The URL can be either relative or absolute.- Since:
- V4.4
-
setImageURL
void setImageURL(java.lang.String imageURL)Sets the URL of the optional image to be displayed on the tab header. The URL can be either relative or absolute. When absolute, is should start with the protocol e.g.http://www.google.com
.- Since:
- V4.4
-
getImageMouseOverText
Text getImageMouseOverText()Returns theText
object for the tab header image mouse over text.- Since:
- V4.4
-
getImageAltText
Text getImageAltText()Returns theText
object for the tab header image alternate text.- Since:
- V4.4
-
getImageStyle
java.lang.String getImageStyle()Returns the inline CSS style applied to the tab header image.This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.
- Since:
- V4.4
- See Also:
setImageStyle(String)
-
setImageStyle
void setImageStyle(java.lang.String imageStyle)Sets the inline CSS style to be applied to the tab header image. Style is entered as for the HTML style parameter.This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.
- Since:
- V4.4
-
getImageClass
java.lang.String getImageClass()Returns the list of CSS classes applied to the tab header image.These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.
- Since:
- V4.4
- See Also:
setImageClass(String)
-
setImageClass
void setImageClass(java.lang.String imageClass)Sets one or more CSS classes to be applied to the tab header image. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.
- Since:
- V4.4
-
getItemName
java.lang.String getItemName()The name that uniquely identifies each tab item within a tab set. This name can be used to set the item as selected - seeTabSetControl.setSelected(String)
. This is a read only property.- Since:
- V4.4
-
getTextImageGap
java.lang.String getTextImageGap()The gap between the tab header text and any configured image.- Since:
- V4.4
- See Also:
setTextImageGap(String)
-
setTextImageGap
void setTextImageGap(java.lang.String textImageGap)Sets the gap between the tab header text and any configured image. Any valid value for the CSS font-size property can be used.Examples:
controls.TAB1.textImageGap = "30px";
- Since:
- V4.4
-
getImagePosition
java.lang.String getImagePosition()The position of the optional image relative to the tab header text. SeesetImagePosition(String)
for details of supported values when setting this property.- Since:
- V4.4
-
setImagePosition
void setImagePosition(java.lang.String imagePosition)Sets the position of the optional image relative to the tab header text.Supported values:
Value Description Left Image is positioned to the left of the text Right Image is positioned to the right of the text None No image will be displayed Examples:
controls.TAB1.imagePosition = "Left";
- Since:
- V4.4
-
getAllState
IndividualTabStateProperties getAllState()Default styling properties for the tab header. These properties can be overridden by setting properties to be applied when a tab has an explicit state.- Since:
- V4.4
- See Also:
getUnselectedState()
,getSelectedState()
,getHoverState()
-
getUnselectedState
IndividualTabStateProperties getUnselectedState()Styling properties applied to the tab header when not selected. These properties override any properties set using theallState
property.- Since:
- V4.4
-
getSelectedState
IndividualTabStateProperties getSelectedState()Styling properties applied to the tab header when selected. These properties override any properties set using theallState
property.- Since:
- V4.4
-
getHoverState
IndividualTabStateProperties getHoverState()Styling properties applied to the tab header when the mouse is hovered over a tab. These properties override any properties set using theallState
property.- Since:
- V4.4
-
getImageProperties
ImageStyleProperties getImageProperties()Styling properties applied to optional tab header image.- Since:
- V4.4
-