TableControl
TableControl Functions
| getAddRowCellClass | TableControl.getAddRowCellClass( ) | Returns the list of CSS classes applied to the table row containing the add row button. |
| setAddRowCellClass | TableControl.setAddRowCellClass( addRowCellClass ) | Sets one or more CSS classes to be applied to the table row containing the add row button. |
| getAddRowCellStyle | TableControl.getAddRowCellStyle( ) | Returns the inline CSS style applied to the table row containing the add row button. |
| setAddRowCellStyle | TableControl.setAddRowCellStyle( addRowCellStyle ) | Sets the inline CSS style to be applied to the table row containing the add row button. |
| getAddRowClass | TableControl.getAddRowClass( ) | Returns the list of CSS classes applied to the add row button. |
| setAddRowClass | TableControl.setAddRowClass( addRowClass ) | Sets one or more CSS classes to be applied to the add row button. |
| getAddRowHtmlElementProperties | TableControl.getAddRowHtmlElementProperties( ) | Return the add button com.ebasetech.xi.api.controls.HtmlElementProperties of the Table Control |
| getAddRowStyle | TableControl.getAddRowStyle( ) | Returns the inline CSS style applied to the add row button. |
| setAddRowStyle | TableControl.setAddRowStyle( addRowStyle ) | Sets the inline CSS style to be applied to the add row button. |
| getAddRowStyleProperties | TableControl.getAddRowStyleProperties( ) | Styling properties for the add row button. |
| getCaptionClass | TableControl.getCaptionClass( ) | Returns the list of CSS classes applied to the table caption text. |
| setCaptionClass | TableControl.setCaptionClass( captionClass ) | Sets one or more CSS classes to be applied to the table caption text. |
| getCaptionStyle | TableControl.getCaptionStyle( ) | Returns the inline CSS style applied to the table caption text. |
| setCaptionStyle | TableControl.setCaptionStyle( captionStyle ) | Sets the inline CSS style to be applied to the table caption text. |
| getCaptionStyleProperties | TableControl.getCaptionStyleProperties( ) | Styling properties for the table caption. |
| getCollapseBreakPoint | TableControl.getCollapseBreakPoint( ) | Returns the breakpoint width e.g. |
| setCollapseBreakPoint | TableControl.setCollapseBreakPoint( collapseBreakPoint ) | Sets the breakpoint width e.g. |
| getCollapsedRowHeaderStyle | TableControl.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. |
| setCollapsedRowHeaderStyle | TableControl.setCollapsedRowHeaderStyle( 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. |
| getCollapsedRowStyle | TableControl.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. |
| setCollapsedRowStyle | TableControl.setCollapsedRowStyle( 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. |
| getColumnHeaderStyleProperties | TableControl.getColumnHeaderStyleProperties( ) | Styling properties for column header texts. |
| getColumnHeadingClass | TableControl.getColumnHeadingClass( ) | Returns the list of CSS classes applied to column header texts. |
| setColumnHeadingClass | TableControl.setColumnHeadingClass( columnHeadingClass ) | Sets one or more CSS classes to be applied to column header texts. |
| getColumnHeadingStyle | TableControl.getColumnHeadingStyle( ) | Returns the inline CSS style applied to column header texts. |
| setColumnHeadingStyle | TableControl.setColumnHeadingStyle( columnHeadingStyle ) | Sets the inline CSS style to be applied to column header texts. |
| isDeletable | TableControl.isDeletable( ) | Returns whether or not the user row deletion built-in feature is activated. |
| setDeletable | TableControl.setDeletable( deletable ) | Sets whether or not the user row deletion built-in feature is activated. |
| getDeletableCellClass | TableControl.getDeletableCellClass( ) | Returns the list of CSS classes applied to the Delete Column table cells. |
| setDeletableCellClass | TableControl.setDeletableCellClass( deletableCellClass ) | Sets one or more CSS classes to be applied to the Delete Column table cells. |
| getDeletableCellStyle | TableControl.getDeletableCellStyle( ) | Returns the inline CSS style applied to the the Delete Column table cells. |
| setDeletableCellStyle | TableControl.setDeletableCellStyle( deletableCellStyle ) | Sets the inline CSS style applied to the Delete Column table cells. |
| getDeletableDataClass | TableControl.getDeletableDataClass( ) | Returns the list of CSS classes applied to the Delete Column checkboxes. |
| setDeletableDataClass | TableControl.setDeletableDataClass( deletableDataClass ) | Sets one or more CSS classes to be applied to the Delete Column checkboxes. |
| getDeletableDataStyle | TableControl.getDeletableDataStyle( ) | Returns the inline CSS style applied to the the Delete Column checkboxes. |
| setDeletableDataStyle | TableControl.setDeletableDataStyle( deletableDataStyle ) | Sets the inline CSS style applied to the Delete Column checkboxes. |
| getDeletableWidth | TableControl.getDeletableWidth( ) | Returns the width of the delete column. |
| setDeletableWidth | TableControl.setDeletableWidth( deletableWidth ) | Sets the width of the delete column. |
| getHeaderClass | TableControl.getHeaderClass( ) | Returns the list of CSS classes applied to the table header text. |
| setHeaderClass | TableControl.setHeaderClass( headerClass ) | Sets one or more CSS classes to be applied to the table header text. |
| getHeaderStyle | TableControl.getHeaderStyle( ) | Returns the inline CSS style applied to the table header text. |
| setHeaderStyle | TableControl.setHeaderStyle( headerStyle ) | Sets the inline CSS style to be applied to the table header text. |
| getHeaderStyleProperties | TableControl.getHeaderStyleProperties( ) | Styling properties for the table header text. |
| getInfoClass | TableControl.getInfoClass( ) | Returns the list of CSS classes applied to the table information text. |
| setInfoClass | TableControl.setInfoClass( infoClass ) | Sets one or more CSS classes to be applied to the table information text. |
| getInformationStyleProperties | TableControl.getInformationStyleProperties( ) | Styling properties for the table information text. |
| getInfoStyle | TableControl.getInfoStyle( ) | Returns the inline CSS style applied to the table information text. |
| setInfoStyle | TableControl.setInfoStyle( infoStyle ) | Sets the inline CSS style to be applied to the table information text. |
| isInsertable | TableControl.isInsertable( ) | Returns whether or not the user row insertion built-in feature is activated. |
| setInsertable | TableControl.setInsertable( insertable ) | Sets whether or not the user row insertion built-in feature is activated. |
| getPatternTextClass | TableControl.getPatternTextClass( ) | Returns the list of CSS classes applied to any value pattern text in the column header. |
| setPatternTextClass | TableControl.setPatternTextClass( patternTextClass ) | Sets one or more CSS classes to be applied to any value pattern text in the column header. |
| getPatternTextStyle | TableControl.getPatternTextStyle( ) | Returns the inline CSS style applied to any value pattern text in the column header. |
| setPatternTextStyle | TableControl.setPatternTextStyle( patternTextStyle ) | Sets the inline CSS style to be applied to any value pattern text in the column header. |
| scrollLeft | TableControl.scrollLeft( ) | Scroll the table horizontally left one page |
| getScrollLeftIcon | TableControl.getScrollLeftIcon( ) | Returns the URL of the horizontal scroll left icon. |
| setScrollLeftIcon | TableControl.setScrollLeftIcon( scrollLeftIcon ) | Sets the URL of the horizontal scroll left icon. |
| scrollRight | TableControl.scrollRight( ) | Scroll the table horizontally right one page |
| getScrollRightIcon | TableControl.getScrollRightIcon( ) | Returns the URL of the horizontal scroll right icon. |
| setScrollRightIcon | TableControl.setScrollRightIcon( scrollRightIcon ) | Sets the URL of the horizontal scroll right icon. |
| isSelectable | TableControl.isSelectable( ) | Returns whether or not the user row selection built-in feature is activated. |
| setSelectable | TableControl.setSelectable( selectable ) | Sets whether or not the user row selection built-in feature is activated. |
| getSelectableCellClass | TableControl.getSelectableCellClass( ) | Returns the list of CSS classes applied to the Select Column table cells. |
| setSelectableCellClass | TableControl.setSelectableCellClass( selectableCellClass ) | Sets one or more CSS classes to be applied to the Select Column table cells. |
| getSelectableCellStyle | TableControl.getSelectableCellStyle( ) | Returns the inline CSS style applied to the Select Column table cells. |
| setSelectableCellStyle | TableControl.setSelectableCellStyle( selectableCellStyle ) | Sets the inline CSS style applied to the Select Column table cells. |
| getSelectableDataClass | TableControl.getSelectableDataClass( ) | Returns the list of CSS classes applied to the Select Column checkboxes. |
| setSelectableDataClass | TableControl.setSelectableDataClass( selectableDataClass ) | Sets one or more CSS classes to be applied to the Select Column checkboxes. |
| getSelectableDataStyle | TableControl.getSelectableDataStyle( ) | Returns the inline CSS style applied to the Select Column checkboxes. |
| setSelectableDataStyle | TableControl.setSelectableDataStyle( selectableDataStyle ) | Sets the inline CSS style applied to the Select Column checkboxes. |
| getSelectableWidth | TableControl.getSelectableWidth( ) | Returns the width of the select column. |
| setSelectableWidth | TableControl.setSelectableWidth( selectableWidth ) | Sets the width of the select column. |
| isShowColumnHeaders | TableControl.isShowColumnHeaders( ) | Indicates whether or not column headers are displayed. |
| setShowColumnHeaders | TableControl.setShowColumnHeaders( showColumnHeaders ) | Sets whether or not column headers are displayed. |
| isShowTableHeadersOverPDFPages | TableControl.isShowTableHeadersOverPDFPages( ) | When a page is included in a PDF, indicates whether column headers will be re-displayed at the top of each expansion page. |
| setShowTableHeadersOverPDFPages | TableControl.setShowTableHeadersOverPDFPages( showTableHeadersOverPDFPages ) | When a page is included in a PDF, sets whether column headers will be re-displayed at the top of each expansion page. |
| getSortAscendingIcon | TableControl.getSortAscendingIcon( ) | Returns the URL of the column header icon used to sort the table in ascending order. |
| setSortAscendingIcon | TableControl.setSortAscendingIcon( sortAscendingIcon ) | Sets the URL of the column header icon used to sort the table in ascending order. |
| getSortDescendingIcon | TableControl.getSortDescendingIcon( ) | Returns the URL of the column header icon used to sort the table in descending order. |
| setSortDescendingIcon | TableControl.setSortDescendingIcon( sortDescendingIcon ) | Sets the URL of the column header icon used to sort the table in descending order. |
| getStripeColor | TableControl.getStripeColor( ) | Returns stripe color applied as a background color to alternate table rows. |
| setStripeColor | TableControl.setStripeColor( stripeColor ) | Sets the stripe color applied as a background color to alternate table rows. |
| getTableCaptionText | TableControl.getTableCaptionText( ) | Returns the com.ebasetech.xi.api.Text object for the table caption text. |
| getTableCellStyleProperties | TableControl.getTableCellStyleProperties( ) | Styling properties for table column cells. |
| getTableClass | TableControl.getTableClass( ) | Returns the list of CSS classes applied to the outer table of the Table Control. |
| setTableClass | TableControl.setTableClass( tableClass ) | Sets one or more CSS classes to be applied to the outer table of the Table Control. |
| getTableDeleteStyleProperties | TableControl.getTableDeleteStyleProperties( ) | Styling properties for the delete column. |
| getTableGridClass | TableControl.getTableGridClass( ) | Returns the list of CSS classes applied to the inner table containing column headers and table row data. |
| setTableGridClass | TableControl.setTableGridClass( tableGridClass ) | Sets one or more CSS classes to be applied to the inner table containing column headers and table row data. |
| getTableGridStyle | TableControl.getTableGridStyle( ) | Returns the inline CSS style applied to the inner table containing column headers and table row data. |
| setTableGridStyle | TableControl.setTableGridStyle( tableGridStyle ) | Sets the inline CSS style to be applied to the inner table containing column headers and table row data. |
| getTableHeaderText | TableControl.getTableHeaderText( ) | Returns the com.ebasetech.xi.api.Text object for the table header text. |
| getTableInfoText | TableControl.getTableInfoText( ) | Returns the com.ebasetech.xi.api.Text object for the table information text. |
| getTablePageScrollClass | TableControl.getTablePageScrollClass( ) | Returns the list of CSS classes applied to the horizontal scroll icons. |
| setTablePageScrollClass | TableControl.setTablePageScrollClass( tablePageScrollClass ) | Sets one or more CSS classes to be applied to the horizontal scroll icons. |
| getTablePageScrollStyle | TableControl.getTablePageScrollStyle( ) | Returns the inline CSS style applied to the the horizontal scroll icons. |
| setTablePageScrollStyle | TableControl.setTablePageScrollStyle( tablePageScrollStyle ) | Sets the inline CSS style applied to the horizontal scroll icons. |
| getTableRowCellClass | TableControl.getTableRowCellClass( ) | Returns the list of CSS classes applied to the table cells used to present table row data. |
| setTableRowCellClass | TableControl.setTableRowCellClass( tableRowCellClass ) | Sets one or more CSS classes to be applied to the table cells used to present table row data. |
| getTableRowCellStyle | TableControl.getTableRowCellStyle( ) | Returns the inline CSS style applied to the table cells used to present table row data. |
| setTableRowCellStyle | TableControl.setTableRowCellStyle( tableRowCellStyle ) | Sets the inline CSS style applied to be applied to the table cells used to present table row data. |
| getTableRowDataClass | TableControl.getTableRowDataClass( ) | Returns the list of CSS classes applied to table row data. |
| setTableRowDataClass | TableControl.setTableRowDataClass( tableRowDataClass ) | Sets one or more CSS classes to be applied to table row data. |
| getTableRowDataStyle | TableControl.getTableRowDataStyle( ) | Returns the inline CSS style applied to table row data. |
| setTableRowDataStyle | TableControl.setTableRowDataStyle( tableRowDataStyle ) | Sets the inline CSS style applied to be applied to table row data. |
| getTableRowStyleProperties | TableControl.getTableRowStyleProperties( ) | Background and border styling properties applied to table row data. |
| getTableSelectStyleProperties | TableControl.getTableSelectStyleProperties( ) | Styling properties for the select column. |
| getTableSortClass | TableControl.getTableSortClass( ) | Returns the list of CSS classes applied to the column header sort icons. |
| setTableSortClass | TableControl.setTableSortClass( tableSortClass ) | Sets one or more CSS classes to be applied to the column header sort icons. |
| getTableSortProperties | TableControl.getTableSortProperties( ) | Column sort icon properties. |
| getTableSortStyle | TableControl.getTableSortStyle( ) | Returns the inline CSS style applied to the the column header sort icons. |
| setTableSortStyle | TableControl.setTableSortStyle( tableSortStyle ) | Sets the inline CSS style applied to the column header sort icons. |
| getTableStyle | TableControl.getTableStyle( ) | Returns the inline CSS style applied to the outer table of the Table Control. |
| setTableStyle | TableControl.setTableStyle( tableStyle ) | Sets the inline CSS style to be applied to the outer table of the Table Control. |
| getTableStyleProperties | TableControl.getTableStyleProperties( ) | Styling properties for the entire table. |
| getTableTrailerText | TableControl.getTableTrailerText( ) | Returns the com.ebasetech.xi.api.Text object for the table trailer text. |
| getTrailerClass | TableControl.getTrailerClass( ) | Returns the list of CSS classes applied to the table trailer text. |
| setTrailerClass | TableControl.setTrailerClass( trailerClass ) | Sets one or more CSS classes to be applied to the table trailer text. |
| getTrailerStyle | TableControl.getTrailerStyle( ) | Returns the inline CSS style applied to the table trailer text. |
| setTrailerStyle | TableControl.setTrailerStyle( trailerStyle ) | Sets the inline CSS style to be applied to the table trailer text. |
| getTrailerStyleProperties | TableControl.getTrailerStyleProperties( ) | Styling properties for the table trailer text. |
| getUnsortedIcon | TableControl.getUnsortedIcon( ) | Returns the URL of the column header icon displayed when the table is not currently sorted by this column. |
| setUnsortedIcon | TableControl.setUnsortedIcon( unsortedIcon ) | Sets the URL of the column header icon displayed when the table is not currently sorted by this column. |
| getWidth | TableControl.getWidth( ) | Table width. |
| setWidth | TableControl.setWidth( width ) | Sets the table width. |
BaseTableControl Functions
| getActivePageNumberProperties | TableControl.getActivePageNumberProperties( ) | Text styling properties for active (clickable) page numbers in the navigation bar. |
| getCurrentPageClass | TableControl.getCurrentPageClass( ) | Returns the list of CSS classes configured for inactive pages (i.e. |
| setCurrentPageClass | TableControl.setCurrentPageClass( currentPageClass ) | Sets one or more CSS classes to be applied to inactive pages (i.e. |
| getCurrentPageStyle | TableControl.getCurrentPageStyle( ) | Returns the inline CSS style configured for inactive pages (i.e. |
| setCurrentPageStyle | TableControl.setCurrentPageStyle( currentPageStyle ) | Sets the inline CSS style to be applied to inactive pages (i.e. |
| isDisplayInfoPrefix | TableControl.isDisplayInfoPrefix( ) | Indicates whether or not the navigation bar prefix text is displayed. |
| setDisplayInfoPrefix | TableControl.setDisplayInfoPrefix( displayInfoPrefix ) | Sets whether or not the navigation bar prefix text is displayed. |
| isDisplayScrollTopBottomIcons | TableControl.isDisplayScrollTopBottomIcons( ) | Indicates whether or not scroll to top and scroll to bottom icons or corresponding texts are included in the navigation bar. |
| setDisplayScrollTopBottomIcons | TableControl.setDisplayScrollTopBottomIcons( displayScrollTopBottomIcons ) | Sets whether or not scroll to top and scroll to bottom icons or corresponding texts are included in the navigation bar. |
| getFilterExpression | TableControl.getFilterExpression( ) | Returns an FPL conditional expression that limits which table rows are displayed or null if no expression is configured. |
| setFilterExpression | TableControl.setFilterExpression( filterExpression ) | Sets an FPL conditional expression that limits which table rows are displayed. |
| getFirstDisplayRow | TableControl.getFirstDisplayRow( ) | Returns the row number of the first displayable row - equivalent to scroll to top. |
| getInactiveNavigationClass | TableControl.getInactiveNavigationClass( ) | Returns the list of CSS classes configured for inactive (not clickable) scroll icons/texts in the navigation bar. |
| setInactiveNavigationClass | TableControl.setInactiveNavigationClass( inactiveNavigationClass ) | Sets one or more CSS classes to be applied to inactive (not clickable) scroll icons/texts in the navigation bar. |
| getInactiveNavigationStyle | TableControl.getInactiveNavigationStyle( ) | Returns the inline CSS style configured for inactive (not clickable) scroll icons/texts in the navigation bar. |
| setInactiveNavigationStyle | TableControl.setInactiveNavigationStyle( inactiveNavigationStyle ) | Sets the inline CSS style to be applied to inactive (not clickable) scroll icons/texts in the navigation bar. |
| getInactivePageNumberProperties | TableControl.getInactivePageNumberProperties( ) | Text styling properties for inactive (not clickable) page numbers in the navigation bar. |
| getInactiveScrollDownIcon | TableControl.getInactiveScrollDownIcon( ) | URL of the inactive (not clickable) scroll down icon in the navigation bar. |
| setInactiveScrollDownIcon | TableControl.setInactiveScrollDownIcon( inactiveScrollDownIcon ) | Sets the URL of the inactive (not clickable) scroll down icon in the navigation bar. |
| getInactiveScrollToBottomIcon | TableControl.getInactiveScrollToBottomIcon( ) | URL of the inactive (not clickable) scroll to bottom icon in the navigation bar. |
| setInactiveScrollToBottomIcon | TableControl.setInactiveScrollToBottomIcon( inactiveScrollToBottomIcon ) | Sets the URL of the inactive ( not clickable) scroll to bottom icon in the navigation bar. |
| getInactiveScrollToTopIcon | TableControl.getInactiveScrollToTopIcon( ) | URL of the inactive (not clickable) scroll to top icon in the navigation bar. |
| setInactiveScrollToTopIcon | TableControl.setInactiveScrollToTopIcon( inactiveScrollToTopIcon ) | Sets the URL of the inactive (not clickable) scroll to top icon in the navigation bar. |
| getInactiveScrollUpIcon | TableControl.getInactiveScrollUpIcon( ) | URL of the inactive (not clickable) scroll up icon in the navigation bar. |
| setInactiveScrollUpIcon | TableControl.setInactiveScrollUpIcon( inactiveScrollUpIcon ) | Sets the URL of the inactive (not clickable) scroll up icon in the navigation bar. |
| isIncludePageNumbers | TableControl.isIncludePageNumbers( ) | Indicates whether or not clickable page numbers are included in the navigation bar. |
| setIncludePageNumbers | TableControl.setIncludePageNumbers( includePageNumbers ) | Sets whether or not clickable page numbers are included in the navigation bar. |
| getInfoPrefixClass | TableControl.getInfoPrefixClass( ) | Returns the list of CSS classes configured for the navigation bar prefix text. |
| setInfoPrefixClass | TableControl.setInfoPrefixClass( infoPrefixClass ) | Sets one or more CSS classes to be applied to the navigation bar prefix text. |
| getInfoPrefixStyle | TableControl.getInfoPrefixStyle( ) | Returns the inline CSS style configured for the navigation bar prefix text. |
| setInfoPrefixStyle | TableControl.setInfoPrefixStyle( infoPrefixStyle ) | Sets the inline CSS style to be applied to the navigation bar prefix text. |
| getMaxNumberOfResultPages | TableControl.getMaxNumberOfResultPages( ) | Returns the maximum number of page numbers included in the navigation bar when property includePageNumbers is true. |
| setMaxNumberOfResultPages | TableControl.setMaxNumberOfResultPages( maxNumberOfResultPages ) | Sets the maximum number of page numbers included in the navigation bar when property includePageNumbers is true. |
| getNavigationAlignBottom | TableControl.getNavigationAlignBottom( ) | Returns the alignment of the navigation bar relative to the table when the bar is displayed below the table. |
| setNavigationAlignBottom | TableControl.setNavigationAlignBottom( navigationAlignBottom ) | Sets the alignment of the navigation bar relative to the table when the bar is displayed below the table. |
| getNavigationAlignTop | TableControl.getNavigationAlignTop( ) | Returns the alignment of the navigation bar relative to the table when the bar is displayed above the table. |
| setNavigationAlignTop | TableControl.setNavigationAlignTop( navigationAlignTop ) | Sets the alignment of the navigation bar relative to the table when the bar is displayed above the table. |
| getNavigationBarClass | TableControl.getNavigationBarClass( ) | Returns the list of CSS classes configured for the <div> tag containing the entire navigation bar. |
| setNavigationBarClass | TableControl.setNavigationBarClass( navigationBarClass ) | Sets one or more CSS classes to be applied to the <div> tag containing the entire navigation bar. |
| getNavigationBarStyle | TableControl.getNavigationBarStyle( ) | Returns the inline CSS style configured for the <div> tag containing the entire navigation bar. |
| setNavigationBarStyle | TableControl.setNavigationBarStyle( navigationBarStyle ) | Sets the inline CSS style to be applied to the <div> tag containing the entire navigation bar. |
| getNavigationClass | TableControl.getNavigationClass( ) | Returns the list of CSS classes configured for active (clickable) scroll icons/texts in the navigation bar. |
| setNavigationClass | TableControl.setNavigationClass( navigationClass ) | Sets one or more CSS classes to be applied to active (clickable) scroll icons/texts in the navigation bar. |
| getNavigationDisplay | TableControl.getNavigationDisplay( ) | Returns the position of the navigation bar. |
| setNavigationDisplay | TableControl.setNavigationDisplay( navigationDisplay ) | Sets the position of the navigation bar. |
| getNavigationStyle | TableControl.getNavigationStyle( ) | Returns the inline CSS style configured for active (clickable) scroll icons/texts in the navigation bar. |
| setNavigationStyle | TableControl.setNavigationStyle( navigationStyle ) | Sets the inline CSS style to be applied to active (clickable) scroll icons/texts in the navigation bar. |
| getNavigationStyleProperties | TableControl.getNavigationStyleProperties( ) | Navigation bar styling properties |
| getNumVisibleRows | TableControl.getNumVisibleRows( ) | Returns the number of rows in a scroll set i.e. |
| setNumVisibleRows | TableControl.setNumVisibleRows( numVisibleRows ) | Sets the number of rows in a scroll set i.e. |
| getPageNavigationInactiveProperties | TableControl.getPageNavigationInactiveProperties( ) | Text styling properties for inactive (not clickable) icons/texts in the navigation bar. |
| getPageNavigationProperties | TableControl.getPageNavigationProperties( ) | Text styling properties for active (clickable) icons/texts in the navigation bar. |
| getPageNumbersClass | TableControl.getPageNumbersClass( ) | Returns the list of CSS classes configured for active (clickable) page numbers in the navigation bar. |
| setPageNumbersClass | TableControl.setPageNumbersClass( pageNumbersClass ) | Sets one or more CSS classes to be applied to active (clickable) page numbers in the navigation bar. |
| getPageNumbersStyle | TableControl.getPageNumbersStyle( ) | Returns the inline CSS style configured for active (clickable) page numbers in the navigation bar. |
| setPageNumbersStyle | TableControl.setPageNumbersStyle( pageNumbersStyle ) | Sets the inline CSS style to be applied to active (clickable) page numbers in the navigation bar. |
| getRowInformationClass | TableControl.getRowInformationClass( ) | Returns the list of CSS classes configured for the row information text in the navigation bar. |
| setRowInformationClass | TableControl.setRowInformationClass( rowInformationClass ) | Sets one or more CSS classes to be applied to the row information text in the navigation bar. |
| getRowInformationProperties | TableControl.getRowInformationProperties( ) | Navigation bar row information text properties Further documentation. |
| getRowInformationStyle | TableControl.getRowInformationStyle( ) | Returns the inline CSS style configured for the row information text in the navigation bar. |
| setRowInformationStyle | TableControl.setRowInformationStyle( rowInformationStyle ) | Sets the inline CSS style to be applied to the row information text in the navigation bar. |
| getRowPrefixProperties | TableControl.getRowPrefixProperties( ) | Navigation bar prefix text properties. |
| scrollDown | TableControl.scrollDown( ) | Scroll the table vertically down one page |
| getScrollDownIcon | TableControl.getScrollDownIcon( ) | URL of the active (clickable) scroll down icon in the navigation bar. |
| setScrollDownIcon | TableControl.setScrollDownIcon( scrollDownIcon ) | Sets the URL of the active (clickable) scroll down icon in the navigation bar. |
| scrollToBottom | TableControl.scrollToBottom( ) | Scroll the table vertically to the last page |
| getScrollToBottomIcon | TableControl.getScrollToBottomIcon( ) | URL of the active (clickable) scroll to bottom icon in the navigation bar. |
| setScrollToBottomIcon | TableControl.setScrollToBottomIcon( scrollToBottomIcon ) | Sets the URL of the active (clickable) scroll to bottom icon in the navigation bar. |
| scrollToTop | TableControl.scrollToTop( ) | Scroll the table vertically to the first page |
| getScrollToTopIcon | TableControl.getScrollToTopIcon( ) | URL of the active (clickable) scroll to top icon in the navigation bar. |
| setScrollToTopIcon | TableControl.setScrollToTopIcon( scrollToTopIcon ) | Sets the URL of the active (clickable) scroll to top icon in the navigation bar. |
| scrollUp | TableControl.scrollUp( ) | Scroll the table vertically up one page |
| getScrollUpIcon | TableControl.getScrollUpIcon( ) | URL of the active (clickable) scroll up icon in the navigation bar. |
| setScrollUpIcon | TableControl.setScrollUpIcon( scrollUpIcon ) | Sets the URL of the active (clickable) scroll up icon in the navigation bar. |
| isShowInactiveScrollIcons | TableControl.isShowInactiveScrollIcons( ) | Indicates whether or not inactive scroll icons/texts are included in the navigation bar. |
| setShowInactiveScrollIcons | TableControl.setShowInactiveScrollIcons( showInactiveScrollIcons ) | Sets whether or not inactive scroll icons/texts are included in the navigation bar. |
| isShowInfoMessage | TableControl.isShowInfoMessage( ) | Indicates whether or not the row information text is displayed in the navigation bar. |
| setShowInfoMessage | TableControl.setShowInfoMessage( showInfoMessage ) | Sets whether or not the row information text is displayed in the navigation bar. |
| isStartNewRowOnNextPage | TableControl.isStartNewRowOnNextPage( ) | When a page is included in a PDF, indicates whether the content of a table row can be split across two pages. |
| setStartNewRowOnNextPage | TableControl.setStartNewRowOnNextPage( startNewRowOnNextPage ) | When a page is included in a PDF, sets whether the content of a table row can be split across two pages. |
| getTable | TableControl.getTable( ) | Returns the com.ebasetech.xi.api.Table displayed by this control. |
| getVisibleRow | TableControl.getVisibleRow( ) | Returns the row number of the first row currently visible to the user i.e. |
| setVisibleRow | TableControl.setVisibleRow( row ) | Scrolls the table to make the table row with row number row visible. |
ContainerControl Functions
| getChildControls | TableControl.getChildControls( ) | Returns an array of controls that are immediate children of this control. |
MessageProperties Functions
| getErrorMessageStyle | TableControl.getErrorMessageStyle( ) | Returns the MessageStyleProperties object representing error message styling properties. |
| getInfoMessageStyle | TableControl.getInfoMessageStyle( ) | Returns the MessageStyleProperties object representing info message styling properties. |
| getWarningMessageStyle | TableControl.getWarningMessageStyle( ) | Returns the MessageStyleProperties object representing warning message styling properties. |
Control Functions
| addCssClass | TableControl.addCssClass( cssClass ) | Adds one or more CSS classes to the list of classes applied to the control, retaining any existing classes. |
| getAll | TableControl.getAll( ) | Returns a control object of the same type as the control object on which this method is invoked, that gives access to all occurrences of this control on the page. |
| isContainer | TableControl.isContainer( ) | Returns true if this control is a container control i.e. |
| getCssClass | TableControl.getCssClass( ) | Returns the list of CSS classes configured for the control. |
| setCssClass | TableControl.setCssClass( cssClass ) | Sets one or more CSS classes to be applied to the control. |
| isDisplayOnly | TableControl.isDisplayOnly( ) | Returns true if the control is marked as display only, otherwise returns false. |
| setDisplayOnly | TableControl.setDisplayOnly( displayOnly ) | Marks the control and all its children as display only (when displayOnly is true) or
enterable (when displayOnly is false). |
| isDisplayOnlyIncludingParents | TableControl.isDisplayOnlyIncludingParents( ) | Returns true if the control or any of its parents is marked as display only, otherwise returns false. |
| getErrorMsgClass | TableControl.getErrorMsgClass( ) | Returns the list of CSS classes configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgClass | TableControl.setErrorMsgClass( errorMsgClass ) | Sets one or more CSS classes to be applied to error messages when the messages are displayed locally to the control. |
| getErrorMsgStyle | TableControl.getErrorMsgStyle( ) | Returns the inline CSS style configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgStyle | TableControl.setErrorMsgStyle( errorMsgStyle ) | Sets inline CSS style to be applied to error messages when the messages are displayed locally to the control. |
| isEventField | TableControl.isEventField( ) | Returns true if the control is an event field i.e. |
| hasModifier | TableControl.hasModifier( modifier ) | Returns true if the control has the specified modifier, otherwise returns false. |
| isHidden | TableControl.isHidden( ) | Returns true if the control is marked as hidden, otherwise returns false. |
| setHidden | TableControl.setHidden( hidden ) | Hides or shows the control and all its children. |
| hide | TableControl.hide( ) | Hides the control, this is equivalent to setting property hidden to true. |
| getInfoMsgClass | TableControl.getInfoMsgClass( ) | Returns the list of CSS classes configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgClass | TableControl.setInfoMsgClass( infoMsgClass ) | Sets one or more CSS classes to be applied to info messages when the messages are displayed locally to the control. |
| getInfoMsgStyle | TableControl.getInfoMsgStyle( ) | Returns the inline CSS style configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgStyle | TableControl.setInfoMsgStyle( infoMsgStyle ) | Sets inline CSS style to be applied to info messages when the messages are displayed locally to the control. |
| isInheritMsg | TableControl.isInheritMsg( ) | Returns true if Use parent control setting is checked in the Message Options properties for the control, otherwise returns false. |
| getLayoutCell | TableControl.getLayoutCell( ) | Returns the LayoutCell object which can be used to override properties of the parent control's layout as applied to this control. |
| isLocalMsg | TableControl.isLocalMsg( ) | Returns true if Local Message is checked in the Message Options properties for the control, otherwise returns false. |
| isNewLine | TableControl.isNewLine( ) | Returns the new line property. |
| setNewLine | TableControl.setNewLine( newLine ) | Sets or unsets the control's new line property. |
| getNextSiblingControl | TableControl.getNextSiblingControl( ) | Returns the control that appears after this control within the same parent, or null if no such control exists. |
| getPage | TableControl.getPage( ) | Returns the com.ebasetech.xi.api.Page where this control is located. |
| getParentControl | TableControl.getParentControl( ) | Returns this control's parent control or null if no such parent exists. |
| getPreviousSiblingControl | TableControl.getPreviousSiblingControl( ) | Returns the control that appears before this control within the same parent, or null if no such control exists. |
| refresh | TableControl.refresh( ) | Refreshes this control in the user's browser when the page is next displayed. |
| removeCssClass | TableControl.removeCssClass( cssClass ) | Removes one or more CSS classes from the control. |
| requestFocus | TableControl.requestFocus( ) | Sets the browser focus to the control. |
| getRootHtmlElementProperties | TableControl.getRootHtmlElementProperties( ) | Return the root com.ebasetech.xi.api.controls.HtmlElementProperties for the Control |
| show | TableControl.show( ) | Shows the control, this is equivalent to setting property hidden to false. |
| isShowing | TableControl.isShowing( ) | Returns true if the control will be included in the web page when it's next displayed to the user, otherwise returns false. |
| getStyle | TableControl.getStyle( ) | Returns the inline CSS style configured for the control. |
| setStyle | TableControl.setStyle( style ) | Sets inline CSS style to be applied to the control. |
| getWarningMsgClass | TableControl.getWarningMsgClass( ) | Returns the list of CSS classes configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgClass | TableControl.setWarningMsgClass( warningMsgClass ) | Sets one or more CSS classes to be applied to warning messages when the messages are displayed locally to the control. |
| getWarningMsgStyle | TableControl.getWarningMsgStyle( ) | Returns the inline CSS style configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgStyle | TableControl.setWarningMsgStyle( warningMsgStyle ) | Sets inline CSS style to be applied to warning messages when the messages are displayed locally to the control. |
MessageContainer Functions
| addErrorMessage | TableControl.addErrorMessage( message [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessage | TableControl.addErrorMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessageText | TableControl.addErrorMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user, sourced from an existing text. |
| addInfoMessage | TableControl.addInfoMessage( message [, stopProcessing ] ) | Adds an information message that will be displayed to the user. |
| addInfoMessageText | TableControl.addInfoMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an info message that will be displayed to the user, sourced from an existing text. |
| addWarningMessage | TableControl.addWarningMessage( message [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessage | TableControl.addWarningMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessageText | TableControl.addWarningMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user, sourced from an existing text. |
| existErrorMessages | TableControl.existErrorMessages( ) | Returns true if undisplayed error messages exist for this element, otherwise returns false. |
| existInfoMessages | TableControl.existInfoMessages( ) | Returns true if undisplayed info messages exist for this element, otherwise returns false. |
| existMessages | TableControl.existMessages( ) | Returns true if undisplayed info, warning or error messages exist for this element, otherwise returns false. |
| existWarningMessages | TableControl.existWarningMessages( ) | Returns true if undisplayed warning messages exist for this element, otherwise returns false. |
Element Functions
| getElementName | TableControl.getElementName( ) | Returns the element name |
| getElementType | TableControl.getElementType( ) | Returns the element type |
Further documentation.