Package com.ebasetech.xi.api.controls

Interface BaseTableControl

All Known Subinterfaces:
RepeatingTableControl, RepeatingTableListControl, TableControl
public interface BaseTableControl
Interface BaseTableControl contains properties and methods that apply to both a Table Control and a Repeater Control.

  • Method Summary

    Modifier and Type Method Description
    TextStyleProperties getActivePageNumberProperties()
    Text styling properties for active (clickable) page numbers in the navigation bar.
    java.lang.String getCurrentPageClass()
    Returns the list of CSS classes configured for inactive pages (i.e.
    java.lang.String getCurrentPageStyle()
    Returns the inline CSS style configured for inactive pages (i.e.
    java.lang.String getFilterExpression()
    Returns an FPL conditional expression that limits which table rows are displayed or null if no expression is configured.
    int getFirstDisplayRow()
    Returns the row number of the first displayable row - equivalent to scroll to top.
    java.lang.String getInactiveNavigationClass()
    Returns the list of CSS classes configured for inactive (not clickable) scroll icons/texts in the navigation bar.
    java.lang.String getInactiveNavigationStyle()
    Returns the inline CSS style configured for inactive (not clickable) scroll icons/texts in the navigation bar.
    TextStyleProperties getInactivePageNumberProperties()
    Text styling properties for inactive (not clickable) page numbers in the navigation bar.
    java.lang.String getInactiveScrollDownIcon()
    URL of the inactive (not clickable) scroll down icon in the navigation bar.
    java.lang.String getInactiveScrollToBottomIcon()
    URL of the inactive (not clickable) scroll to bottom icon in the navigation bar.
    java.lang.String getInactiveScrollToTopIcon()
    URL of the inactive (not clickable) scroll to top icon in the navigation bar.
    java.lang.String getInactiveScrollUpIcon()
    URL of the inactive (not clickable) scroll up icon in the navigation bar.
    java.lang.String getInfoPrefixClass()
    Returns the list of CSS classes configured for the navigation bar prefix text.
    java.lang.String getInfoPrefixStyle()
    Returns the inline CSS style configured for the navigation bar prefix text.
    int getMaxNumberOfResultPages()
    Returns the maximum number of page numbers included in the navigation bar when property includePageNumbers is true.
    java.lang.String getNavigationAlignBottom()
    Returns the alignment of the navigation bar relative to the table when the bar is displayed below the table.
    java.lang.String getNavigationAlignTop()
    Returns the alignment of the navigation bar relative to the table when the bar is displayed above the table.
    java.lang.String getNavigationBarClass()
    Returns the list of CSS classes configured for the <div> tag containing the entire navigation bar.
    java.lang.String getNavigationBarStyle()
    Returns the inline CSS style configured for the <div> tag containing the entire navigation bar.
    java.lang.String getNavigationClass()
    Returns the list of CSS classes configured for active (clickable) scroll icons/texts in the navigation bar.
    java.lang.String getNavigationDisplay()
    Returns the position of the navigation bar.
    java.lang.String getNavigationStyle()
    Returns the inline CSS style configured for active (clickable) scroll icons/texts in the navigation bar.
    NavigationBarStyleProperties getNavigationStyleProperties()
    Navigation bar styling properties
    int getNumVisibleRows()
    Returns the number of rows in a scroll set i.e.
    TextStyleProperties getPageNavigationInactiveProperties()
    Text styling properties for inactive (not clickable) icons/texts in the navigation bar.
    TextStyleProperties getPageNavigationProperties()
    Text styling properties for active (clickable) icons/texts in the navigation bar.
    java.lang.String getPageNumbersClass()
    Returns the list of CSS classes configured for active (clickable) page numbers in the navigation bar.
    java.lang.String getPageNumbersStyle()
    Returns the inline CSS style configured for active (clickable) page numbers in the navigation bar.
    java.lang.String getRowInformationClass()
    Returns the list of CSS classes configured for the row information text in the navigation bar.
    NavigationRowProperties getRowInformationProperties()
    Navigation bar row information text properties Further documentation.
    java.lang.String getRowInformationStyle()
    Returns the inline CSS style configured for the row information text in the navigation bar.
    NavigationRowProperties getRowPrefixProperties()
    Navigation bar prefix text properties.
    java.lang.String getScrollDownIcon()
    URL of the active (clickable) scroll down icon in the navigation bar.
    java.lang.String getScrollToBottomIcon()
    URL of the active (clickable) scroll to bottom icon in the navigation bar.
    java.lang.String getScrollToTopIcon()
    URL of the active (clickable) scroll to top icon in the navigation bar.
    java.lang.String getScrollUpIcon()
    URL of the active (clickable) scroll up icon in the navigation bar.
    Table getTable()
    Returns the Table displayed by this control.
    int getVisibleRow()
    Returns the row number of the first row currently visible to the user i.e.
    boolean isDisplayInfoPrefix()
    Indicates whether or not the navigation bar prefix text is displayed.
    boolean isDisplayScrollTopBottomIcons()
    Indicates whether or not scroll to top and scroll to bottom icons or corresponding texts are included in the navigation bar.
    boolean isIncludePageNumbers()
    Indicates whether or not clickable page numbers are included in the navigation bar.
    boolean isShowInactiveScrollIcons()
    Indicates whether or not inactive scroll icons/texts are included in the navigation bar.
    boolean isShowInfoMessage()
    Indicates whether or not the row information text is displayed in the navigation bar.
    boolean isStartNewRowOnNextPage()
    When a page is included in a PDF, indicates whether the content of a table row can be split across two pages.
    void scrollDown()
    Scroll the table vertically down one page
    void scrollToBottom()
    Scroll the table vertically to the last page
    void scrollToTop()
    Scroll the table vertically to the first page
    void scrollUp()
    Scroll the table vertically up one page
    void setCurrentPageClass​(java.lang.String currentPageClass)
    Sets one or more CSS classes to be applied to inactive pages (i.e.
    void setCurrentPageStyle​(java.lang.String currentPageStyle)
    Sets the inline CSS style to be applied to inactive pages (i.e.
    void setDisplayInfoPrefix​(boolean displayInfoPrefix)
    Sets whether or not the navigation bar prefix text is displayed.
    void setDisplayScrollTopBottomIcons​(boolean displayScrollTopBottomIcons)
    Sets whether or not scroll to top and scroll to bottom icons or corresponding texts are included in the navigation bar.
    void setFilterExpression​(java.lang.String filterExpression)
    Sets an FPL conditional expression that limits which table rows are displayed.
    void setInactiveNavigationClass​(java.lang.String inactiveNavigationClass)
    Sets one or more CSS classes to be applied to inactive (not clickable) scroll icons/texts in the navigation bar.
    void setInactiveNavigationStyle​(java.lang.String inactiveNavigationStyle)
    Sets the inline CSS style to be applied to inactive (not clickable) scroll icons/texts in the navigation bar.
    void setInactiveScrollDownIcon​(java.lang.String inactiveScrollDownIcon)
    Sets the URL of the inactive (not clickable) scroll down icon in the navigation bar.
    void setInactiveScrollToBottomIcon​(java.lang.String inactiveScrollToBottomIcon)
    Sets the URL of the inactive ( not clickable) scroll to bottom icon in the navigation bar.
    void setInactiveScrollToTopIcon​(java.lang.String inactiveScrollToTopIcon)
    Sets the URL of the inactive (not clickable) scroll to top icon in the navigation bar.
    void setInactiveScrollUpIcon​(java.lang.String inactiveScrollUpIcon)
    Sets the URL of the inactive (not clickable) scroll up icon in the navigation bar.
    void setIncludePageNumbers​(boolean includePageNumbers)
    Sets whether or not clickable page numbers are included in the navigation bar.
    void setInfoPrefixClass​(java.lang.String infoPrefixClass)
    Sets one or more CSS classes to be applied to the navigation bar prefix text.
    void setInfoPrefixStyle​(java.lang.String infoPrefixStyle)
    Sets the inline CSS style to be applied to the navigation bar prefix text.
    void setMaxNumberOfResultPages​(int maxNumberOfResultPages)
    Sets the maximum number of page numbers included in the navigation bar when property includePageNumbers is true.
    void setNavigationAlignBottom​(java.lang.String navigationAlignBottom)
    Sets the alignment of the navigation bar relative to the table when the bar is displayed below the table.
    void setNavigationAlignTop​(java.lang.String navigationAlignTop)
    Sets the alignment of the navigation bar relative to the table when the bar is displayed above the table.
    void setNavigationBarClass​(java.lang.String navigationBarClass)
    Sets one or more CSS classes to be applied to the <div> tag containing the entire navigation bar.
    void setNavigationBarStyle​(java.lang.String navigationBarStyle)
    Sets the inline CSS style to be applied to the <div> tag containing the entire navigation bar.
    void setNavigationClass​(java.lang.String navigationClass)
    Sets one or more CSS classes to be applied to active (clickable) scroll icons/texts in the navigation bar.
    void setNavigationDisplay​(java.lang.String navigationDisplay)
    Sets the position of the navigation bar.
    void setNavigationStyle​(java.lang.String navigationStyle)
    Sets the inline CSS style to be applied to active (clickable) scroll icons/texts in the navigation bar.
    void setNumVisibleRows​(int numVisibleRows)
    Sets the number of rows in a scroll set i.e.
    void setPageNumbersClass​(java.lang.String pageNumbersClass)
    Sets one or more CSS classes to be applied to active (clickable) page numbers in the navigation bar.
    void setPageNumbersStyle​(java.lang.String pageNumbersStyle)
    Sets the inline CSS style to be applied to active (clickable) page numbers in the navigation bar.
    void setRowInformationClass​(java.lang.String rowInformationClass)
    Sets one or more CSS classes to be applied to the row information text in the navigation bar.
    void setRowInformationStyle​(java.lang.String rowInformationStyle)
    Sets the inline CSS style to be applied to the row information text in the navigation bar.
    void setScrollDownIcon​(java.lang.String scrollDownIcon)
    Sets the URL of the active (clickable) scroll down icon in the navigation bar.
    void setScrollToBottomIcon​(java.lang.String scrollToBottomIcon)
    Sets the URL of the active (clickable) scroll to bottom icon in the navigation bar.
    void setScrollToTopIcon​(java.lang.String scrollToTopIcon)
    Sets the URL of the active (clickable) scroll to top icon in the navigation bar.
    void setScrollUpIcon​(java.lang.String scrollUpIcon)
    Sets the URL of the active (clickable) scroll up icon in the navigation bar.
    void setShowInactiveScrollIcons​(boolean showInactiveScrollIcons)
    Sets whether or not inactive scroll icons/texts are included in the navigation bar.
    void setShowInfoMessage​(boolean showInfoMessage)
    Sets whether or not the row information text is displayed in the navigation bar.
    void setStartNewRowOnNextPage​(boolean startNewRowOnNextPage)
    When a page is included in a PDF, sets whether the content of a table row can be split across two pages.
    void setVisibleRow​(int row)
    Scrolls the table to make the table row with row number row visible.

  • Method Details

    • getNavigationDisplay

      java.lang.String getNavigationDisplay()
      Returns the position of the navigation bar. See setNavigationDisplay(String) for supported values.

      Further documentation.

      Since:
      V4.4

    • setNavigationDisplay

      void setNavigationDisplay​(java.lang.String navigationDisplay)
      Sets the position of the navigation bar.

      Supported values:

      Value
      TAbove the table
      UBelow the table
      BBoth above and below the table
      nullThe navigation bar is not displayed

      Further documentation.

      Since:
      V4.4

    • getNavigationAlignTop

      java.lang.String getNavigationAlignTop()
      Returns the alignment of the navigation bar relative to the table when the bar is displayed above the table. See setNavigationAlignTop(String) for supported values.

      Further documentation.

      Since:
      V4.4

    • setNavigationAlignTop

      void setNavigationAlignTop​(java.lang.String navigationAlignTop)
      Sets the alignment of the navigation bar relative to the table when the bar is displayed above the table.

      Supported values:

      Value
      LLeft
      RRight
      CCenter

      Further documentation.

      Since:
      V4.4

    • getNavigationAlignBottom

      java.lang.String getNavigationAlignBottom()
      Returns the alignment of the navigation bar relative to the table when the bar is displayed below the table. See setNavigationAlignBottom(String) for supported values.

      Further documentation.

      Since:
      V4.4

    • setNavigationAlignBottom

      void setNavigationAlignBottom​(java.lang.String navigationAlignBottom)
      Sets the alignment of the navigation bar relative to the table when the bar is displayed below the table.

      Supported values:

      Value
      LLeft
      RRight
      CCenter

      Further documentation.

      Since:
      V4.4

    • isIncludePageNumbers

      boolean isIncludePageNumbers()
      Indicates whether or not clickable page numbers are included in the navigation bar.

      Further documentation.

      Since:
      V4.4

    • setIncludePageNumbers

      void setIncludePageNumbers​(boolean includePageNumbers)
      Sets whether or not clickable page numbers are included in the navigation bar.

      Further documentation.

      Since:
      V4.4

    • isDisplayInfoPrefix

      boolean isDisplayInfoPrefix()
      Indicates whether or not the navigation bar prefix text is displayed.

      Further documentation.

      Since:
      V4.4

    • setDisplayInfoPrefix

      void setDisplayInfoPrefix​(boolean displayInfoPrefix)
      Sets whether or not the navigation bar prefix text is displayed.

      Further documentation.

      Since:
      V4.4

    • isShowInfoMessage

      boolean isShowInfoMessage()
      Indicates whether or not the row information text is displayed in the navigation bar. This text shows the number of records. The default text Displaying .. of .. records is built using system texts 370, 371, 372, 373

      Further documentation.

      Since:
      V4.4

    • setShowInfoMessage

      void setShowInfoMessage​(boolean showInfoMessage)
      Sets whether or not the row information text is displayed in the navigation bar. This text shows the number of records. The default text Displaying .. of .. records is built using system texts 370, 371, 372, 373

      Further documentation.

      Since:
      V4.4

    • isDisplayScrollTopBottomIcons

      boolean isDisplayScrollTopBottomIcons()
      Indicates whether or not scroll to top and scroll to bottom icons or corresponding texts are included in the navigation bar.

      Further documentation.

      Since:
      V4.4

    • setDisplayScrollTopBottomIcons

      void setDisplayScrollTopBottomIcons​(boolean displayScrollTopBottomIcons)
      Sets whether or not scroll to top and scroll to bottom icons or corresponding texts are included in the navigation bar.

      Further documentation.

      Since:
      V4.4

    • isShowInactiveScrollIcons

      boolean isShowInactiveScrollIcons()
      Indicates whether or not inactive scroll icons/texts are included in the navigation bar. For example when this property is true, scroll up and scroll to top icons/texts are displayed when the first page of a scroll set is displayed.

      Further documentation.

      Since:
      V4.4

    • setShowInactiveScrollIcons

      void setShowInactiveScrollIcons​(boolean showInactiveScrollIcons)
      Sets whether or not inactive scroll icons/texts are included in the navigation bar. For example when this property is true, scroll up and scroll to top icons/texts are displayed when the first page of a scroll set is displayed.

      Further documentation.

      Since:
      V4.4

    • getScrollToTopIcon

      java.lang.String getScrollToTopIcon()
      URL of the active (clickable) scroll to top icon in the navigation bar.

      Further documentation.

      Since:
      V4.4

    • setScrollToTopIcon

      void setScrollToTopIcon​(java.lang.String scrollToTopIcon)
      Sets the URL of the active (clickable) scroll to top icon in the navigation bar.

      Further documentation.

      Since:
      V4.4

    • getScrollToBottomIcon

      java.lang.String getScrollToBottomIcon()
      URL of the active (clickable) scroll to bottom icon in the navigation bar.

      Further documentation.

      Since:
      V4.4

    • setScrollToBottomIcon

      void setScrollToBottomIcon​(java.lang.String scrollToBottomIcon)
      Sets the URL of the active (clickable) scroll to bottom icon in the navigation bar.

      Further documentation.

      Since:
      V4.4

    • getScrollUpIcon

      java.lang.String getScrollUpIcon()
      URL of the active (clickable) scroll up icon in the navigation bar.

      Further documentation.

      Since:
      V4.4

    • setScrollUpIcon

      void setScrollUpIcon​(java.lang.String scrollUpIcon)
      Sets the URL of the active (clickable) scroll up icon in the navigation bar.

      Further documentation.

      Since:
      V4.4

    • getScrollDownIcon

      java.lang.String getScrollDownIcon()
      URL of the active (clickable) scroll down icon in the navigation bar.

      Further documentation.

      Since:
      V4.4

    • setScrollDownIcon

      void setScrollDownIcon​(java.lang.String scrollDownIcon)
      Sets the URL of the active (clickable) scroll down icon in the navigation bar.

      Further documentation.

      Since:
      V4.4

    • getInactiveScrollToTopIcon

      java.lang.String getInactiveScrollToTopIcon()
      URL of the inactive (not clickable) scroll to top icon in the navigation bar.

      Further documentation.

      Since:
      V4.4

    • setInactiveScrollToTopIcon

      void setInactiveScrollToTopIcon​(java.lang.String inactiveScrollToTopIcon)
      Sets the URL of the inactive (not clickable) scroll to top icon in the navigation bar.

      Further documentation.

      Since:
      V4.4

    • getInactiveScrollToBottomIcon

      java.lang.String getInactiveScrollToBottomIcon()
      URL of the inactive (not clickable) scroll to bottom icon in the navigation bar.

      Further documentation.

      Since:
      V4.4

    • setInactiveScrollToBottomIcon

      void setInactiveScrollToBottomIcon​(java.lang.String inactiveScrollToBottomIcon)
      Sets the URL of the inactive ( not clickable) scroll to bottom icon in the navigation bar.

      Further documentation.

      Since:
      V4.4

    • getInactiveScrollUpIcon

      java.lang.String getInactiveScrollUpIcon()
      URL of the inactive (not clickable) scroll up icon in the navigation bar.

      Further documentation.

      Since:
      V4.4

    • setInactiveScrollUpIcon

      void setInactiveScrollUpIcon​(java.lang.String inactiveScrollUpIcon)
      Sets the URL of the inactive (not clickable) scroll up icon in the navigation bar.

      Further documentation.

      Since:
      V4.4

    • getInactiveScrollDownIcon

      java.lang.String getInactiveScrollDownIcon()
      URL of the inactive (not clickable) scroll down icon in the navigation bar.

      Further documentation.

      Since:
      V4.4

    • setInactiveScrollDownIcon

      void setInactiveScrollDownIcon​(java.lang.String inactiveScrollDownIcon)
      Sets the URL of the inactive (not clickable) scroll down icon in the navigation bar.

      Further documentation.

      Since:
      V4.4

    • getVisibleRow

      int getVisibleRow()
      Returns the row number of the first row currently visible to the user i.e. the first row in the current scroll set. Returns -1 when the table is empty.

      Further documentation.

      Since:
      V4.4

    • setVisibleRow

      void setVisibleRow​(int row)
      Scrolls the table to make the table row with row number row visible. Invalid row numbers are ignored.

      Further documentation.

      Since:
      V4.4

    • scrollToTop

      void scrollToTop()
      Scroll the table vertically to the first page

    • scrollToBottom

      void scrollToBottom()
      Scroll the table vertically to the last page

    • scrollDown

      void scrollDown()
      Scroll the table vertically down one page

    • scrollUp

      void scrollUp()
      Scroll the table vertically up one page

    • getNumVisibleRows

      int getNumVisibleRows()
      Returns the number of rows in a scroll set i.e. presented to the user. When more rows exist in the table, the navigation bar is displayed. A value of 0 indicates that all rows should be displayed without scrolling.
      Since:
      V4.4

    • setNumVisibleRows

      void setNumVisibleRows​(int numVisibleRows)
      Sets the number of rows in a scroll set i.e. presented to the user. When more rows exist in the table, the navigation bar is displayed. When set to 0, all rows are displayed without scrolling.
      Since:
      V4.4

    • getFirstDisplayRow

      int getFirstDisplayRow()
      Returns the row number of the first displayable row - equivalent to scroll to top. Returns -1 when the table is empty.

      Further documentation.

      Since:
      V4.4

    • getMaxNumberOfResultPages

      int getMaxNumberOfResultPages()
      Returns the maximum number of page numbers included in the navigation bar when property includePageNumbers is true.

      Further documentation.

      Since:
      V4.4

    • setMaxNumberOfResultPages

      void setMaxNumberOfResultPages​(int maxNumberOfResultPages)
      Sets the maximum number of page numbers included in the navigation bar when property includePageNumbers is true.

      Further documentation.

      Since:
      V4.4

    • getRowPrefixProperties

      NavigationRowProperties getRowPrefixProperties()
      Navigation bar prefix text properties.

      Further documentation.

      Since:
      V4.4

    • getRowInformationProperties

      NavigationRowProperties getRowInformationProperties()
      Navigation bar row information text properties Further documentation.
      Since:
      V4.4

    • getNavigationStyleProperties

      NavigationBarStyleProperties getNavigationStyleProperties()
      Navigation bar styling properties
      Since:
      V4.4

    • getActivePageNumberProperties

      TextStyleProperties getActivePageNumberProperties()
      Text styling properties for active (clickable) page numbers in the navigation bar.
      Since:
      V4.4

    • getInactivePageNumberProperties

      TextStyleProperties getInactivePageNumberProperties()
      Text styling properties for inactive (not clickable) page numbers in the navigation bar.
      Since:
      V4.4

    • getPageNavigationProperties

      TextStyleProperties getPageNavigationProperties()
      Text styling properties for active (clickable) icons/texts in the navigation bar.
      Since:
      V4.4

    • getPageNavigationInactiveProperties

      TextStyleProperties getPageNavigationInactiveProperties()
      Text styling properties for inactive (not clickable) icons/texts in the navigation bar.
      Since:
      V4.4

    • getPageNumbersClass

      java.lang.String getPageNumbersClass()
      Returns the list of CSS classes configured for active (clickable) page numbers in the navigation bar.

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

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

    • setPageNumbersClass

      void setPageNumbersClass​(java.lang.String pageNumbersClass)
      Sets one or more CSS classes to be applied to active (clickable) page numbers in the navigation bar. 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

    • getPageNumbersStyle

      java.lang.String getPageNumbersStyle()
      Returns the inline CSS style configured for active (clickable) page numbers in the navigation bar.

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

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

    • setPageNumbersStyle

      void setPageNumbersStyle​(java.lang.String pageNumbersStyle)
      Sets the inline CSS style to be applied to active (clickable) page numbers in the navigation bar. Style is entered as for the HTML style parameter.

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

      Since:
      V4.4

    • getNavigationClass

      java.lang.String getNavigationClass()
      Returns the list of CSS classes configured for active (clickable) scroll icons/texts in the navigation bar.

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

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

    • setNavigationClass

      void setNavigationClass​(java.lang.String navigationClass)
      Sets one or more CSS classes to be applied to active (clickable) scroll icons/texts in the navigation bar. 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

    • getNavigationStyle

      java.lang.String getNavigationStyle()
      Returns the inline CSS style configured for active (clickable) scroll icons/texts in the navigation bar.

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

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

    • setNavigationStyle

      void setNavigationStyle​(java.lang.String navigationStyle)
      Sets the inline CSS style to be applied to active (clickable) scroll icons/texts in the navigation bar. Style is entered as for the HTML style parameter.

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

      Since:
      V4.4

    • getInactiveNavigationClass

      java.lang.String getInactiveNavigationClass()
      Returns the list of CSS classes configured for inactive (not clickable) scroll icons/texts in the navigation bar.

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

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

    • setInactiveNavigationClass

      void setInactiveNavigationClass​(java.lang.String inactiveNavigationClass)
      Sets one or more CSS classes to be applied to inactive (not clickable) scroll icons/texts in the navigation bar. 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

    • getInactiveNavigationStyle

      java.lang.String getInactiveNavigationStyle()
      Returns the inline CSS style configured for inactive (not clickable) scroll icons/texts in the navigation bar.

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

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

    • setInactiveNavigationStyle

      void setInactiveNavigationStyle​(java.lang.String inactiveNavigationStyle)
      Sets the inline CSS style to be applied to inactive (not clickable) scroll icons/texts in the navigation bar. Style is entered as for the HTML style parameter.

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

      Since:
      V4.4

    • getCurrentPageClass

      java.lang.String getCurrentPageClass()
      Returns the list of CSS classes configured for inactive pages (i.e. the current page number) in the navigation bar.

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

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

    • setCurrentPageClass

      void setCurrentPageClass​(java.lang.String currentPageClass)
      Sets one or more CSS classes to be applied to inactive pages (i.e. the current page number) in the navigation bar. 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

    • getCurrentPageStyle

      java.lang.String getCurrentPageStyle()
      Returns the inline CSS style configured for inactive pages (i.e. the current page number) in the navigation bar.

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

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

    • setCurrentPageStyle

      void setCurrentPageStyle​(java.lang.String currentPageStyle)
      Sets the inline CSS style to be applied to inactive pages (i.e. the current page number) in the navigation bar. Style is entered as for the HTML style parameter.

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

      Since:
      V4.4

    • getRowInformationClass

      java.lang.String getRowInformationClass()
      Returns the list of CSS classes configured for the row information text in the navigation bar.

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

      Further documentation.

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

    • setRowInformationClass

      void setRowInformationClass​(java.lang.String rowInformationClass)
      Sets one or more CSS classes to be applied to the row information text in the navigation bar. 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.

      Further documentation.

      Since:
      V4.4

    • getRowInformationStyle

      java.lang.String getRowInformationStyle()
      Returns the inline CSS style configured for the row information text in the navigation bar.

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

      Further documentation.

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

    • setRowInformationStyle

      void setRowInformationStyle​(java.lang.String rowInformationStyle)
      Sets the inline CSS style to be applied to the row information text in the navigation bar. Style is entered as for the HTML style parameter.

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

      Further documentation.

      Since:
      V4.4

    • getNavigationBarClass

      java.lang.String getNavigationBarClass()
      Returns the list of CSS classes configured for the <div> tag containing the entire navigation bar.

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

      Further documentation.

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

    • setNavigationBarClass

      void setNavigationBarClass​(java.lang.String navigationBarClass)
      Sets one or more CSS classes to be applied to the <div> tag containing the entire navigation bar. 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.

      Further documentation.

      Since:
      V4.4

    • getNavigationBarStyle

      java.lang.String getNavigationBarStyle()
      Returns the inline CSS style configured for the <div> tag containing the entire navigation bar.

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

      Further documentation.

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

    • setNavigationBarStyle

      void setNavigationBarStyle​(java.lang.String navigationBarStyle)
      Sets the inline CSS style to be applied to the <div> tag containing the entire navigation bar. Style is entered as for the HTML style parameter.

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

      Further documentation.

      Since:
      V4.4

    • getInfoPrefixClass

      java.lang.String getInfoPrefixClass()
      Returns the list of CSS classes configured for the navigation bar prefix text.

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

      Further documentation.

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

    • setInfoPrefixClass

      void setInfoPrefixClass​(java.lang.String infoPrefixClass)
      Sets one or more CSS classes to be applied to the navigation bar prefix text. 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.

      Further documentation.

      Since:
      V4.4

    • getInfoPrefixStyle

      java.lang.String getInfoPrefixStyle()
      Returns the inline CSS style configured for the navigation bar prefix text.

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

      Further documentation.

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

    • setInfoPrefixStyle

      void setInfoPrefixStyle​(java.lang.String infoPrefixStyle)
      Sets the inline CSS style to be applied to the navigation bar prefix text. Style is entered as for the HTML style parameter.

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

      Further documentation.

      Since:
      V4.4

    • getFilterExpression

      java.lang.String getFilterExpression()
      Returns an FPL conditional expression that limits which table rows are displayed or null if no expression is configured. The expression is applied to each row in the underlying table when the page is prepared for output. The expression can refer to any form field or table column and must evaluate to true or false.

      Further documentation.

      Since:
      V4.4

    • setFilterExpression

      void setFilterExpression​(java.lang.String filterExpression)
      Sets an FPL conditional expression that limits which table rows are displayed. The expression is applied to each row in the underlying table when the page is prepared for output. The expression can refer to any form field or table column and must evaluate to true or false.

      Further documentation.

      Since:
      V4.4

    • getTable

      Table getTable()
      Returns the Table displayed by this control.
      Since:
      V4.4

    • isStartNewRowOnNextPage

      boolean isStartNewRowOnNextPage()
      When a page is included in a PDF, indicates whether the content of a table row can be split across two pages. When true, content can be split.

      Further documentation.

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

    • setStartNewRowOnNextPage

      void setStartNewRowOnNextPage​(boolean startNewRowOnNextPage)
      When a page is included in a PDF, sets whether the content of a table row can be split across two pages. When true, content can be split.

      Further documentation.

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