Package com.ebasetech.xi.api.controls

Interface TabSetControl

All Superinterfaces:
AriaControlProperties, ContainerControl, Control, Element, EventOwner, MarginStyleProperties, MessageContainer, MessageProperties, java.io.Serializable, TextStyleProperties, WebFormEventOwner
public interface TabSetControl
extends ContainerControl, MessageProperties, MarginStyleProperties, TextStyleProperties, AriaControlProperties
A Tab Set Control is a container containing a number of individual tabs.

Further documentation.

  • Method Details

    • getSelected

      java.lang.String getSelected()
      The item name of the currently selected tab or null if no tab is selected.

      Further documentation.

      Since:
      V4.4
      See Also:
      setSelected(String)

    • setSelected

      void setSelected​(java.lang.String tab)
      Sets the currently selected tab which results in this tab being displayed.

      Further documentation.

      Example: 

       controls.TABSET1.selectedTab = "Tab2";
      Since:
      V4.4
      See Also:
      getSelected()

    • getWidth

      java.lang.String getWidth()
      Width of the Tab Set Control. See setWidth(String) for details of supported values when setting this property.
      Since:
      V4.4

    • setWidth

      void setWidth​(java.lang.String width)
      Sets the width of the Tab Set Control.

      Supported values:

      ValueDescription
      A specific valueAs per the CSS width property e.g. 300px
      ChildThe minimum value: this results in the Tab Set Control being just as wide as it needs to be to accommodate its children.
      nullThe maximum value: the width is taken from the parent container control. This width will then include the Tab Set Control plus any configured padding, border or margins.

      The width setting will be ignored if the parent container layout specifies a horizontal cell alignment of fill (this applies to Horizontal Box, Vertical Box and Column layouts). This is equivalent to specifying maximum above.

      Warning: when a specific value is set, any padding, border or margins will be in addition to the specified value and can cause the Tab Set Control to "break out" of its parent space. In particular, try and avoid specifying a width of 100%; use maximum (null) instead.

      Examples: 

       controls.TABSET1.width = "300px";
 controls.TABSET1.width = "50%";
 controls.TABSET1.setWidth("Child");
 controls.TABSET1.setWidth(null);
      Since:
      V4.4

    • getHeight

      java.lang.String getHeight()
      Height of the Tab Set Control. This is equivalent to the CSS height property, and any valid value for this CSS property can be used when setting a value.
      Since:
      V4.4
      See Also:
      setHeight(String)

    • setHeight

      void setHeight​(java.lang.String 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. Setting this property to null removes any existing value.

      Examples: 

       controls.TABSET1.height = "50px";
 controls.TABSET1.setHeight("100px");
      Since:
      V4.4

    • getTabWidth

      java.lang.String getTabWidth()
      The width of individual tab headers. If not specified, the width is determined by the tab header content.

      Further documentation.

      Since:
      V4.4
      See Also:
      setTabWidth(String)

    • setTabWidth

      void setTabWidth​(java.lang.String tabWidth)
      Sets the width of individual tab headers. If not specified, the width is determined by the tab header content. Any valid value for this CSS width property can be used.

      Further documentation.

      Since:
      V4.4

    • getSpaceBetweenTabs

      java.lang.String getSpaceBetweenTabs()
      The space between adjacent tab headers.

      Further documentation.

      Since:
      V4.4
      See Also:
      setSpaceBetweenTabs(String)

    • setSpaceBetweenTabs

      void setSpaceBetweenTabs​(java.lang.String spaceBetweenTabs)
      Sets the space between adjacent tab headers. Any valid value for this CSS font-size property can be used.

      Further documentation.

      Since:
      V4.4

    • getTabBorderColor

      java.lang.String getTabBorderColor()
      The border color applied to both the tabs and the content panel.

      Further documentation.

      Since:
      V4.4

    • setTabBorderColor

      void setTabBorderColor​(java.lang.String tabBorderColor)
      Sets the border color applied to both the tabs and the content panel. Any valid value for this CSS color property can be used.

      Further documentation.

      Since:
      V4.4

    • getTabCornerType

      java.lang.String getTabCornerType()
      The style of corner applied to the top left and top right corners of all tab headers. See setTabCornerType(String) for details of supported values when setting this property.

      Further documentation.

      Since:
      V4.4

    • setTabCornerType

      void setTabCornerType​(java.lang.String tabCornerType)
      Sets the style of corner applied to the top left and top right corners of all tab headers.

      Supported values:

      ValueDescription
      RoundedCorners are drawn with a rounded image
      SquareCorners are square
      SlashCorners are a straight diagonal line

      Further documentation.

      Examples: 

       controls.TABSET1.tabCornerType = "Rounded";
 controls.TITLEPANEL1.tabCornerType("Square");
      Since:
      V4.4

    • getTabAllColor

      java.lang.String getTabAllColor()
      The default background color applied to both tab header and its content panel. Note that the background color is only applied to the content panel in the selected state.

      This value can be overridden by setting background colors to be applied when the tab has an explicit state.

      Further documentation.

      Since:
      V4.4
      See Also:
      getTabColor(), getTabSelectedColor(), getTabHoverColor()

    • setTabAllColor

      void setTabAllColor​(java.lang.String tabAllColor)
      Sets the default background color applied to both tab header and its content panel. Note that the background color is only applied to the content panel in the selected state.

      This value can be overridden by setting background colors to be applied when the tab has an explicit state.

      Further documentation.

      Since:
      V4.4
      See Also:
      setTabColor(String), setTabSelectedColor(String), setTabHoverColor(String)

    • getTabColor

      java.lang.String getTabColor()
      The background color applied to the tab header when the tab is not selected. This overrides any value set for the tabAllColor property.

      Further documentation.

      Since:
      V4.4

    • setTabColor

      void setTabColor​(java.lang.String tabColor)
      Sets the background color applied to the tab header when a tab is not selected. This overrides any value set for the tabAllColor property. Any valid value for this CSS color property can be used.

      Further documentation.

      Since:
      V4.4

    • getTabSelectedColor

      java.lang.String getTabSelectedColor()
      The background color applied to both tab header and its content panel when a tab is selected. This overrides any value set for the tabAllColor property.

      Further documentation.

      Since:
      V4.4

    • setTabSelectedColor

      void setTabSelectedColor​(java.lang.String tabSelectedColor)
      Sets the background color applied to both tab header and its content panel when a tab is selected. This overrides any value set for the tabAllColor property. Any valid value for this CSS color property can be used.

      Further documentation.

      Since:
      V4.4

    • getTabHoverColor

      java.lang.String getTabHoverColor()
      The background color applied to a tab header when the mouse is hovered over a tab. This overrides any value set for the tabAllColor property.

      Further documentation.

      Since:
      V4.4

    • setTabHoverColor

      void setTabHoverColor​(java.lang.String tabHoverColor)
      Sets the background color applied to both tab header when the mouse is hovered over a tab. This overrides any value set for the tabAllColor property. Any valid value for this CSS color property can be used.

      Further documentation.

      Since:
      V4.4

    • getAllState

      TabAllStateProperties getAllState()
      Default styling properties for all tab headers. These properties can be overridden by setting properties to be applied when a tab has an explicit state. The properties can also be overridden for individual tabs using TabControl.getAllState().

      Further documentation.

      Since:
      V4.4
      See Also:
      getUnselectedState(), getSelectedState(), getHoverState()

    • getUnselectedState

      TextStyleProperties getUnselectedState()
      Styling properties applied to tab headers when a tab is not selected. These properties override any properties set using the allState property. The properties can also be overridden for individual tabs using TabControl.getUnselectedState().

      Further documentation.

      Since:
      V4.4

    • getSelectedState

      TextStyleProperties getSelectedState()
      Styling properties applied to tab headers when a tab is selected. These properties override any properties set using the allState property. The properties can also be overridden for individual tabs using TabControl.getSelectedState().

      Further documentation.

      Since:
      V4.4

    • getHoverState

      TextStyleProperties getHoverState()
      Styling properties applied to tab headers when the mouse is hovered over a tab. These properties override any properties set using the allState property. The properties can also be overridden for individual tabs using TabControl.getHoverState().

      Further documentation.

      Since:
      V4.4

    • getContentPanel

      TabSetContentPanelProperties getContentPanel()
      Styling properties applied to tab content panels.

      Further documentation.

      Since:
      V4.4

    • getLeftTabImage

      java.lang.String getLeftTabImage()
      URL of the image used for the top left corner of all tab headers when not selected. When specified, this overrides the system generated corner image.

      Further documentation.

      Since:
      V4.4

    • setLeftTabImage

      void setLeftTabImage​(java.lang.String leftTabImage)
      Sets the URL of the image used for the top left corner of all tab headers when not selected. When specified, this overrides the system generated corner image.

      Further documentation.

      Since:
      V4.4

    • getRightTabImage

      java.lang.String getRightTabImage()
      URL of the image used for the top right corner of all tab headers when not selected. When specified, this overrides the system generated corner image.

      Further documentation.

      Since:
      V4.4

    • setRightTabImage

      void setRightTabImage​(java.lang.String rightTabImage)
      Sets the URL of the image used for the top right corner of all tab headers when not selected. When specified, this overrides the system generated corner image.

      Further documentation.

      Since:
      V4.4

    • getLeftSelectedTabImage

      java.lang.String getLeftSelectedTabImage()
      URL of the image used for the top left corner of all tab headers when selected. When specified, this overrides the system generated corner image.

      Further documentation.

      Since:
      V4.4

    • setLeftSelectedTabImage

      void setLeftSelectedTabImage​(java.lang.String leftSelectedTabImage)
      Sets the URL of the image used for the top left corner of all tab headers when selected. When specified, this overrides the system generated corner image.

      Further documentation.

      Since:
      V4.4

    • getRightSelectedTabImage

      java.lang.String getRightSelectedTabImage()
      URL of the image used for the top right corner of all tab headers when selected. When specified, this overrides the system generated corner image.

      Further documentation.

      Since:
      V4.4

    • setRightSelectedTabImage

      void setRightSelectedTabImage​(java.lang.String rightSelectedTabImage)
      Sets the URL of the image used for the top right corner of all tab headers when selected. When specified, this overrides the system generated corner image.

      Further documentation.

      Since:
      V4.4

    • getLeftHoverTabImage

      java.lang.String getLeftHoverTabImage()
      URL of the image used for the top left corner of all tab headers when the mouse is hovered over a tab. When specified, this overrides the system generated corner image.

      Further documentation.

      Since:
      V4.4

    • setLeftHoverTabImage

      void setLeftHoverTabImage​(java.lang.String 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. When specified, this overrides the system generated corner image.

      Further documentation.

      Since:
      V4.4

    • getRightHoverTabImage

      java.lang.String getRightHoverTabImage()
      URL of the image used for the top right corner of all tab headers when the mouse is hovered over a tab. When specified, this overrides the system generated corner image.

      Further documentation.

      Since:
      V4.4

    • setRightHoverTabImage

      void setRightHoverTabImage​(java.lang.String 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. When specified, this overrides the system generated corner image.

      Further documentation.

      Since:
      V4.4

    • isSkipValidation

      boolean 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).

      Note that field type validation is always executed regardless of the setting of this flag (e.g. check that only numeric data is entered for numeric fields).

      Further documentation.

      Since:
      V4.4

    • setSkipValidation

      void setSkipValidation​(boolean skipValidation)
      Specifies whether or not validation of controls higher on the page is skipped prior to executing the on tab click event (if configured).

      Note that field type validation is always executed regardless of the setting of this flag (e.g. check that only numeric data is entered for numeric fields).

      Further documentation.

      Since:
      V4.4

    • getSelectedTextStyle

      java.lang.String getSelectedTextStyle()
      Returns the inline CSS style applied to both a tab header and its content panel when a tab has been selected.

      This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.

      Further documentation.

      Since:
      V4.4
      See Also:
      setSelectedTextStyle(String)

    • setSelectedTextStyle

      void setSelectedTextStyle​(java.lang.String selectedTextStyle)
      Sets the inline CSS style to be applied to both a tab header and its content panel when a tab has been selected. 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.

      Further documentation.

      Since:
      V4.4

    • getUnselectedTextStyle

      java.lang.String getUnselectedTextStyle()
      Returns the inline CSS style applied to unselected tab headers.

      This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.

      Further documentation.

      Since:
      V4.4
      See Also:
      setUnselectedTextStyle(String)

    • setUnselectedTextStyle

      void setUnselectedTextStyle​(java.lang.String unselectedTextStyle)
      Sets the inline CSS style to be applied to unselected tab headers. 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.

      Further documentation.

      Since:
      V4.4

    • getHoverTextStyle

      java.lang.String getHoverTextStyle()
      Returns the inline CSS style applied to tab headers when the mouse is hovered over a tab..

      This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.

      Further documentation.

      Since:
      V4.4
      See Also:
      setHoverTextStyle(String)

    • setHoverTextStyle

      void setHoverTextStyle​(java.lang.String hoverTextStyle)
      Sets the inline CSS style to be applied to tab headers when the mouse is hovered over a tab. 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.

      Further documentation.

      Since:
      V4.4

    • getPanelClass

      java.lang.String getPanelClass()
      Returns the list of CSS classes applied to the tab content panels.

      These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.

      Since:
      V4.4
      See Also:
      setPanelClass(String)

    • setPanelClass

      void setPanelClass​(java.lang.String panelClass)
      Sets one or more CSS classes to be applied to the tab content panels. 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

    • getPanelStyle

      java.lang.String getPanelStyle()
      Returns the inline CSS style applied to the tab content panels.

      This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.

      Since:
      V4.4
      See Also:
      setPanelStyle(String)

    • setPanelStyle

      void setPanelStyle​(java.lang.String panelStyle)
      Sets the inline CSS style to be applied to the tab content panels. 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

    • getTabHeaderClass

      java.lang.String getTabHeaderClass()
      Returns the list of CSS classes applied to all tab headers.

      These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.

      Since:
      V4.4
      See Also:
      setTabHeaderClass(String)

    • setTabHeaderClass

      void setTabHeaderClass​(java.lang.String tabHeaderClass)
      Sets one or more CSS classes to be applied to all tab headers. 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

    • getTabHeaderStyle

      java.lang.String getTabHeaderStyle()
      Returns the inline CSS style applied to all tab headers.

      This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.

      Since:
      V4.4
      See Also:
      setTabHeaderStyle(String)

    • setTabHeaderStyle

      void setTabHeaderStyle​(java.lang.String tabHeaderStyle)
      Sets the inline CSS style to be applied to all tab headers. 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