Package com.ebasetech.xi.api.controls

Interface TableControl

All Superinterfaces:
BaseTableControl, ContainerControl, Control, Element, EventOwner, MessageContainer, MessageProperties, java.io.Serializable, WebFormEventOwner
public interface TableControl
extends ContainerControl, MessageProperties, BaseTableControl
Table Control - represents a displayed table.

Further documentation.

  • Method Details

    • scrollLeft

      void scrollLeft()
      Scroll the table horizontally left one page

    • scrollRight

      void scrollRight()
      Scroll the table horizontally right one page

    • getTableHeaderText

      Text getTableHeaderText()
      Returns the Text object for the table header text.

      Further documentation.

      Since:
      V4.4

    • getTableInfoText

      Text getTableInfoText()
      Returns the Text object for the table information text.

      Further documentation.

      Since:
      V4.4

    • getTableTrailerText

      Text getTableTrailerText()
      Returns the Text object for the table trailer text.

      Further documentation.

      Since:
      V4.4

    • getTableCaptionText

      Text getTableCaptionText()
      Returns the Text object for the table caption text. This text will be visible and will also be read by Screen Readers. Captions help users to find a table and understand what it's about and decide if they want to read it.

      Further documentation.

      Since:
      V5.9

    • getWidth

      java.lang.String getWidth()
      Table width. See setWidth(String) for details of supported values when setting this property.
      Since:
      V4.4

    • setWidth

      void setWidth​(java.lang.String width)
      Sets the table width.

      Any valid value for the CSS width property can be specified e.g. 300px.

      Warning: any margins specified for the table will be in addition to the width value and can cause the Table Control to "break out" of its parent space.

      Further documentation.

      Since:
      V4.4

    • isInsertable

      boolean isInsertable()
      Returns whether or not the user row insertion built-in feature is activated. When activated, the Add Row button is displayed underneath the table row data.

      Further documentation.

      Since:
      V4.4

    • setInsertable

      void setInsertable​(boolean insertable)
      Sets whether or not the user row insertion built-in feature is activated. When activated, the Add Row button is displayed underneath the table row data.

      Further documentation.

      Since:
      V4.4

    • isDeletable

      boolean isDeletable()
      Returns whether or not the user row deletion built-in feature is activated. When activated, the Delete column is displayed as the rightmost table column.

      Further documentation.

      Since:
      V4.4

    • setDeletable

      void setDeletable​(boolean deletable)
      Sets whether or not the user row deletion built-in feature is activated. When activated, the Delete column is displayed as the rightmost table column.

      Further documentation.

      Since:
      V4.4

    • isSelectable

      boolean isSelectable()
      Returns whether or not the user row selection built-in feature is activated. When activated, the Select column is displayed as the leftmost table column.

      Further documentation.

      Since:
      V4.4

    • setSelectable

      void setSelectable​(boolean selectable)
      Sets whether or not the user row selection built-in feature is activated. When activated, the Select column is displayed as the leftmost table column.

      Further documentation.

      Since:
      V4.4

    • isShowColumnHeaders

      boolean isShowColumnHeaders()
      Indicates whether or not column headers are displayed. Note that when true, column headers are displayed, even for empty tables.
      Since:
      V4.4

    • setShowColumnHeaders

      void setShowColumnHeaders​(boolean showColumnHeaders)
      Sets whether or not column headers are displayed. Note that when true, column headers are displayed, even for empty tables.
      Since:
      V4.4

    • getSortAscendingIcon

      java.lang.String getSortAscendingIcon()
      Returns the URL of the column header icon used to sort the table in ascending order.

      Further documentation.

      Since:
      V4.4

    • setSortAscendingIcon

      void setSortAscendingIcon​(java.lang.String sortAscendingIcon)
      Sets the URL of the column header icon used to sort the table in ascending order.

      Further documentation.

      Since:
      V4.4

    • getSortDescendingIcon

      java.lang.String getSortDescendingIcon()
      Returns the URL of the column header icon used to sort the table in descending order.

      Further documentation.

      Since:
      V4.4

    • setSortDescendingIcon

      void setSortDescendingIcon​(java.lang.String sortDescendingIcon)
      Sets the URL of the column header icon used to sort the table in descending order.

      Further documentation.

      Since:
      V4.4

    • getUnsortedIcon

      java.lang.String getUnsortedIcon()
      Returns the URL of the column header icon displayed when the table is not currently sorted by this column.

      Further documentation.

      Since:
      V4.4

    • setUnsortedIcon

      void setUnsortedIcon​(java.lang.String unsortedIcon)
      Sets the URL of the column header icon displayed when the table is not currently sorted by this column.

      Further documentation.

      Since:
      V4.4

    • getScrollLeftIcon

      java.lang.String getScrollLeftIcon()
      Returns the URL of the horizontal scroll left icon.

      Further documentation.

      Since:
      V4.4

    • setScrollLeftIcon

      void setScrollLeftIcon​(java.lang.String scrollLeftIcon)
      Sets the URL of the horizontal scroll left icon.

      Further documentation.

      Since:
      V4.4

    • getScrollRightIcon

      java.lang.String getScrollRightIcon()
      Returns the URL of the horizontal scroll right icon.

      Further documentation.

      Since:
      V4.4

    • setScrollRightIcon

      void setScrollRightIcon​(java.lang.String scrollRightIcon)
      Sets the URL of the horizontal scroll right icon.

      Further documentation.

      Since:
      V4.4

    • getStripeColor

      java.lang.String getStripeColor()
      Returns stripe color applied as a background color to alternate table rows. This property overrides the background color set with getTableRowStyleProperties() for alternate rows.
      Since:
      V4.4

    • setStripeColor

      void setStripeColor​(java.lang.String stripeColor)
      Sets the stripe color applied as a background color to alternate table rows. Any valid value for the CSS color property can be used.
      Since:
      V4.4

    • getSelectableWidth

      java.lang.String getSelectableWidth()
      Returns the width of the select column.
      Since:
      V4.4

    • setSelectableWidth

      void setSelectableWidth​(java.lang.String selectableWidth)
      Sets the width of the select column. Any valid value for the CSS width property can be used.
      Since:
      V4.4

    • getDeletableWidth

      java.lang.String getDeletableWidth()
      Returns the width of the delete column.
      Since:
      V4.4

    • setDeletableWidth

      void setDeletableWidth​(java.lang.String deletableWidth)
      Sets the width of the delete column. Any valid value for the CSS width property can be used.
      Since:
      V4.4

    • isShowTableHeadersOverPDFPages

      boolean isShowTableHeadersOverPDFPages()
      When a page is included in a PDF, indicates whether column headers will be re-displayed at the top of each expansion page.

      Further documentation.

      Since:
      V4.4
      See Also:
      WebForm.generatePdf()

    • setShowTableHeadersOverPDFPages

      void setShowTableHeadersOverPDFPages​(boolean showTableHeadersOverPDFPages)
      When a page is included in a PDF, sets whether column headers will be re-displayed at the top of each expansion page.

      Further documentation.

      Since:
      V4.4
      See Also:
      WebForm.generatePdf()

    • getTableSortProperties

      TableSortProperties getTableSortProperties()
      Column sort icon properties.
      Since:
      V4.4

    • getTableStyleProperties

      TableControlStyleProperties getTableStyleProperties()
      Styling properties for the entire table.
      Since:
      V4.4

    • getHeaderStyleProperties

      TableControlTextProperties getHeaderStyleProperties()
      Styling properties for the table header text.

      Further documentation.

      Since:
      V4.4

    • getCaptionStyleProperties

      TableControlTextProperties getCaptionStyleProperties()
      Styling properties for the table caption.

      Further documentation.

      Since:
      V5.9

    • getInformationStyleProperties

      TableControlTextProperties getInformationStyleProperties()
      Styling properties for the table information text.

      Further documentation.

      Since:
      V4.4

    • getTrailerStyleProperties

      TableControlTextProperties getTrailerStyleProperties()
      Styling properties for the table trailer text.

      Further documentation.

      Since:
      V4.4

    • getAddRowStyleProperties

      TableControlAddRowProperties getAddRowStyleProperties()
      Styling properties for the add row button.

      Further documentation.

      Since:
      V4.4

    • getColumnHeaderStyleProperties

      TableColumnHeaderProperties getColumnHeaderStyleProperties()
      Styling properties for column header texts.

      Further documentation.

      Since:
      V4.4

    • getTableRowStyleProperties

      TableRowStyleProperties getTableRowStyleProperties()
      Background and border styling properties applied to table row data. Note that background color for alternate rows can be overridden with getStripeColor().

      Further documentation.

      Since:
      V4.4

    • getTableCellStyleProperties

      TableCellStyleProperties getTableCellStyleProperties()
      Styling properties for table column cells.

      Further documentation.

      Since:
      V4.4

    • getTableSelectStyleProperties

      TableCellStyleProperties getTableSelectStyleProperties()
      Styling properties for the select column.

      Further documentation.

      Since:
      V4.4

    • getTableDeleteStyleProperties

      TableCellStyleProperties getTableDeleteStyleProperties()
      Styling properties for the delete column.

      Further documentation.

      Since:
      V4.4

    • getHeaderClass

      java.lang.String getHeaderClass()
      Returns the list of CSS classes applied to the table header text.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setHeaderClass

      void setHeaderClass​(java.lang.String headerClass)
      Sets one or more CSS classes to be applied to the table header text. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getHeaderStyle

      java.lang.String getHeaderStyle()
      Returns the inline CSS style applied to the table header text.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setHeaderStyle

      void setHeaderStyle​(java.lang.String headerStyle)
      Sets the inline CSS style to be applied to the table header text. Style is entered as for the HTML style parameter.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getCaptionClass

      java.lang.String getCaptionClass()
      Returns the list of CSS classes applied to the table caption text.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V5.9
      See Also:
      setCaptionClass(String)

    • setCaptionClass

      void setCaptionClass​(java.lang.String captionClass)
      Sets one or more CSS classes to be applied to the table caption text. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V5.9

    • getCaptionStyle

      java.lang.String getCaptionStyle()
      Returns the inline CSS style applied to the table caption text.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V5.9
      See Also:
      setCaptionStyle(String)

    • setCaptionStyle

      void setCaptionStyle​(java.lang.String captionStyle)
      Sets the inline CSS style to be applied to the table caption text. Style is entered as for the HTML style parameter.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V5.9

    • getPatternTextClass

      java.lang.String getPatternTextClass()
      Returns the list of CSS classes applied to any value pattern text in the column header. This text provides information to the user on the format of data to be entered for date/time columns e.g. hh:mm:ss, mm/dd/yyyy etc.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setPatternTextClass

      void setPatternTextClass​(java.lang.String patternTextClass)
      Sets one or more CSS classes to be applied to any value pattern text in the column header. This text provides information to the user on the format of data to be entered for date/time columns e.g. hh:mm:ss, mm/dd/yyyy etc. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getPatternTextStyle

      java.lang.String getPatternTextStyle()
      Returns the inline CSS style applied to any value pattern text in the column header. This text provides information to the user on the format of data to be entered for date/time columns e.g. hh:mm:ss, mm/dd/yyyy etc.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setPatternTextStyle

      void setPatternTextStyle​(java.lang.String patternTextStyle)
      Sets the inline CSS style to be applied to any value pattern text in the column header. This text provides information to the user on the format of data to be entered for date/time columns e.g. hh:mm:ss, mm/dd/yyyy etc. Style is entered as for the HTML style parameter.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getInfoClass

      java.lang.String getInfoClass()
      Returns the list of CSS classes applied to the table information text.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setInfoClass

      void setInfoClass​(java.lang.String infoClass)
      Sets one or more CSS classes to be applied to the table information text. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getInfoStyle

      java.lang.String getInfoStyle()
      Returns the inline CSS style applied to the table information text.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setInfoStyle

      void setInfoStyle​(java.lang.String infoStyle)
      Sets the inline CSS style to be applied to the table information text. Style is entered as for the HTML style parameter.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getTrailerClass

      java.lang.String getTrailerClass()
      Returns the list of CSS classes applied to the table trailer text.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setTrailerClass

      void setTrailerClass​(java.lang.String trailerClass)
      Sets one or more CSS classes to be applied to the table trailer text. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getTrailerStyle

      java.lang.String getTrailerStyle()
      Returns the inline CSS style applied to the table trailer text.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setTrailerStyle

      void setTrailerStyle​(java.lang.String trailerStyle)
      Sets the inline CSS style to be applied to the table trailer text. Style is entered as for the HTML style parameter.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getColumnHeadingClass

      java.lang.String getColumnHeadingClass()
      Returns the list of CSS classes applied to column header texts.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setColumnHeadingClass

      void setColumnHeadingClass​(java.lang.String columnHeadingClass)
      Sets one or more CSS classes to be applied to column header texts. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getColumnHeadingStyle

      java.lang.String getColumnHeadingStyle()
      Returns the inline CSS style applied to column header texts.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setColumnHeadingStyle

      void setColumnHeadingStyle​(java.lang.String columnHeadingStyle)
      Sets the inline CSS style to be applied to column header texts. Style is entered as for the HTML style parameter.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getAddRowClass

      java.lang.String getAddRowClass()
      Returns the list of CSS classes applied to the add row button.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setAddRowClass

      void setAddRowClass​(java.lang.String addRowClass)
      Sets one or more CSS classes to be applied to the add row button. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getAddRowStyle

      java.lang.String getAddRowStyle()
      Returns the inline CSS style applied to the add row button.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setAddRowStyle

      void setAddRowStyle​(java.lang.String addRowStyle)
      Sets the inline CSS style to be applied to the add row button. Style is entered as for the HTML style parameter.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getAddRowCellClass

      java.lang.String getAddRowCellClass()
      Returns the list of CSS classes applied to the table row containing the add row button.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setAddRowCellClass

      void setAddRowCellClass​(java.lang.String addRowCellClass)
      Sets one or more CSS classes to be applied to the table row containing the add row button. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getAddRowCellStyle

      java.lang.String getAddRowCellStyle()
      Returns the inline CSS style applied to the table row containing the add row button.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setAddRowCellStyle

      void setAddRowCellStyle​(java.lang.String addRowCellStyle)
      Sets the inline CSS style to be applied to the table row containing the add row button. Style is entered as for the HTML style parameter.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getTableClass

      java.lang.String getTableClass()
      Returns the list of CSS classes applied to the outer table of the Table Control.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setTableClass

      void setTableClass​(java.lang.String tableClass)
      Sets one or more CSS classes to be applied to the outer table of the Table Control. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getTableStyle

      java.lang.String getTableStyle()
      Returns the inline CSS style applied to the outer table of the Table Control.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setTableStyle

      void setTableStyle​(java.lang.String tableStyle)
      Sets the inline CSS style to be applied to the outer table of the Table Control. Style is entered as for the HTML style parameter.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getTableGridClass

      java.lang.String getTableGridClass()
      Returns the list of CSS classes applied to the inner table containing column headers and table row data.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setTableGridClass

      void setTableGridClass​(java.lang.String tableGridClass)
      Sets one or more CSS classes to be applied to the inner table containing column headers and table row data. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getTableGridStyle

      java.lang.String getTableGridStyle()
      Returns the inline CSS style applied to the inner table containing column headers and table row data.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setTableGridStyle

      void setTableGridStyle​(java.lang.String tableGridStyle)
      Sets the inline CSS style to be applied to the inner table containing column headers and table row data. Style is entered as for the HTML style parameter.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getTableRowCellClass

      java.lang.String getTableRowCellClass()
      Returns the list of CSS classes applied to the table cells used to present table row data.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setTableRowCellClass

      void setTableRowCellClass​(java.lang.String tableRowCellClass)
      Sets one or more CSS classes to be applied to the table cells used to present table row data. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getTableRowCellStyle

      java.lang.String getTableRowCellStyle()
      Returns the inline CSS style applied to the table cells used to present table row data.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setTableRowCellStyle

      void setTableRowCellStyle​(java.lang.String tableRowCellStyle)
      Sets the inline CSS style applied to be applied to the table cells used to present table row data. Style is entered as for the HTML style parameter.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getTableRowDataClass

      java.lang.String getTableRowDataClass()
      Returns the list of CSS classes applied to table row data.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setTableRowDataClass

      void setTableRowDataClass​(java.lang.String tableRowDataClass)
      Sets one or more CSS classes to be applied to table row data. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getTableRowDataStyle

      java.lang.String getTableRowDataStyle()
      Returns the inline CSS style applied to table row data.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setTableRowDataStyle

      void setTableRowDataStyle​(java.lang.String tableRowDataStyle)
      Sets the inline CSS style applied to be applied to table row data. Style is entered as for the HTML style parameter.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getSelectableCellClass

      java.lang.String getSelectableCellClass()
      Returns the list of CSS classes applied to the Select Column table cells.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setSelectableCellClass

      void setSelectableCellClass​(java.lang.String selectableCellClass)
      Sets one or more CSS classes to be applied to the Select Column table cells. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getSelectableCellStyle

      java.lang.String getSelectableCellStyle()
      Returns the inline CSS style applied to the Select Column table cells.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setSelectableCellStyle

      void setSelectableCellStyle​(java.lang.String selectableCellStyle)
      Sets the inline CSS style applied to the Select Column table cells. Style is entered as for the HTML style parameter.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getSelectableDataClass

      java.lang.String getSelectableDataClass()
      Returns the list of CSS classes applied to the Select Column checkboxes.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setSelectableDataClass

      void setSelectableDataClass​(java.lang.String selectableDataClass)
      Sets one or more CSS classes to be applied to the Select Column checkboxes. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getSelectableDataStyle

      java.lang.String getSelectableDataStyle()
      Returns the inline CSS style applied to the Select Column checkboxes.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setSelectableDataStyle

      void setSelectableDataStyle​(java.lang.String selectableDataStyle)
      Sets the inline CSS style applied to the Select Column checkboxes. Style is entered as for the HTML style parameter.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getDeletableCellClass

      java.lang.String getDeletableCellClass()
      Returns the list of CSS classes applied to the Delete Column table cells.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setDeletableCellClass

      void setDeletableCellClass​(java.lang.String deletableCellClass)
      Sets one or more CSS classes to be applied to the Delete Column table cells. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getDeletableCellStyle

      java.lang.String getDeletableCellStyle()
      Returns the inline CSS style applied to the the Delete Column table cells.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setDeletableCellStyle

      void setDeletableCellStyle​(java.lang.String deletableCellStyle)
      Sets the inline CSS style applied to the Delete Column table cells. Style is entered as for the HTML style parameter.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getDeletableDataClass

      java.lang.String getDeletableDataClass()
      Returns the list of CSS classes applied to the Delete Column checkboxes.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setDeletableDataClass

      void setDeletableDataClass​(java.lang.String deletableDataClass)
      Sets one or more CSS classes to be applied to the Delete Column checkboxes. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getDeletableDataStyle

      java.lang.String getDeletableDataStyle()
      Returns the inline CSS style applied to the the Delete Column checkboxes.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setDeletableDataStyle

      void setDeletableDataStyle​(java.lang.String deletableDataStyle)
      Sets the inline CSS style applied to the Delete Column checkboxes. Style is entered as for the HTML style parameter.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getTableSortClass

      java.lang.String getTableSortClass()
      Returns the list of CSS classes applied to the column header sort icons.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setTableSortClass

      void setTableSortClass​(java.lang.String tableSortClass)
      Sets one or more CSS classes to be applied to the column header sort icons. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getTableSortStyle

      java.lang.String getTableSortStyle()
      Returns the inline CSS style applied to the the column header sort icons.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setTableSortStyle

      void setTableSortStyle​(java.lang.String tableSortStyle)
      Sets the inline CSS style applied to the column header sort icons. Style is entered as for the HTML style parameter.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getTablePageScrollClass

      java.lang.String getTablePageScrollClass()
      Returns the list of CSS classes applied to the horizontal scroll icons.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setTablePageScrollClass

      void setTablePageScrollClass​(java.lang.String tablePageScrollClass)
      Sets one or more CSS classes to be applied to the horizontal scroll icons. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      Further documentation.

      These classes are configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getTablePageScrollStyle

      java.lang.String getTablePageScrollStyle()
      Returns the inline CSS style applied to the the horizontal scroll icons.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

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

    • setTablePageScrollStyle

      void setTablePageScrollStyle​(java.lang.String tablePageScrollStyle)
      Sets the inline CSS style applied to the horizontal scroll icons. Style is entered as for the HTML style parameter.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V4.4

    • getCollapseBreakPoint

      java.lang.String getCollapseBreakPoint()
      Returns the breakpoint width e.g. 768px, 25rem; when the device viewport is smaller than this value the table will collapse to display each row vertically.
      Since:
      V5.5

    • setCollapseBreakPoint

      void setCollapseBreakPoint​(java.lang.String collapseBreakPoint)
      Sets the breakpoint width e.g. 768px, 25rem; when the device viewport is smaller than this value the table will collapse to display each row vertically.
      Since:
      V5.4

    • getCollapsedRowStyle

      java.lang.String getCollapsedRowStyle()
      Returns the inline CSS style applied to collapsed table rows; these are table rows displayed vertically when the device viewport is smaller than the breakpoint configured for the Collapse Breakpoint property. The class is applied to the tr tag which acts as the container for each row.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V5.5
      See Also:
      setCollapsedRowStyle(String)

    • setCollapsedRowStyle

      void setCollapsedRowStyle​(java.lang.String collapsedRowStyle)
      Sets the inline CSS style applied to collapsed table rows; these are table rows displayed vertically when the device viewport is smaller than the breakpoint configured for the Collapse Breakpoint property. The class is applied to the tr tag which acts as the container for each row. Style is entered as for the HTML style parameter.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V5.5

    • getCollapsedRowHeaderStyle

      java.lang.String getCollapsedRowHeaderStyle()
      Returns the inline CSS style applied to column headers displayed in collapsed table rows; these are table rows displayed vertically when the device viewport is smaller than the breakpoint configured for the Collapse Breakpoint property.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V5.5
      See Also:
      setCollapsedRowHeaderStyle(String)

    • setCollapsedRowHeaderStyle

      void setCollapsedRowHeaderStyle​(java.lang.String collapsedRowHeaderStyle)
      Sets the inline CSS style applied to column headers displayed in collapsed table rows; these are table rows displayed vertically when the device viewport is smaller than the breakpoint configured for the Collapse Breakpoint property. Style is entered as for the HTML style parameter.

      Further documentation.

      This inline style is configured in the studio using the Advanced Properties button within the Table Control Styling Assistant.

      Since:
      V5.5

    • getAddRowHtmlElementProperties

      HtmlElementProperties getAddRowHtmlElementProperties()
      Return the add button HTMLElementProperties of the Table Control
      Since:
      V5.9