public interface BaseTableControl
BaseTableControl
contains properties and methods that apply to both a Table Control
and a Repeater Control
.Modifier and Type | Method and 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. |
java.lang.String getNavigationDisplay()
setNavigationDisplay(String)
for supported values.
void setNavigationDisplay(java.lang.String navigationDisplay)
Supported values:
Value | |
---|---|
T | Above the table |
U | Below the table |
B | Both above and below the table |
null | The navigation bar is not displayed |
java.lang.String getNavigationAlignTop()
setNavigationAlignTop(String)
for supported values.
void setNavigationAlignTop(java.lang.String navigationAlignTop)
Supported values:
Value | |
---|---|
L | Left |
R | Right |
C | Center |
java.lang.String getNavigationAlignBottom()
setNavigationAlignBottom(String)
for supported values.
void setNavigationAlignBottom(java.lang.String navigationAlignBottom)
Supported values:
Value | |
---|---|
L | Left |
R | Right |
C | Center |
boolean isIncludePageNumbers()
void setIncludePageNumbers(boolean includePageNumbers)
boolean isDisplayInfoPrefix()
void setDisplayInfoPrefix(boolean displayInfoPrefix)
boolean isShowInfoMessage()
void setShowInfoMessage(boolean showInfoMessage)
boolean isDisplayScrollTopBottomIcons()
void setDisplayScrollTopBottomIcons(boolean displayScrollTopBottomIcons)
boolean isShowInactiveScrollIcons()
true
, scroll up and scroll to top icons/texts are displayed
when the first page of a scroll set is displayed.
void setShowInactiveScrollIcons(boolean showInactiveScrollIcons)
true
, scroll up and scroll to top icons/texts are displayed
when the first page of a scroll set is displayed.
java.lang.String getScrollToTopIcon()
void setScrollToTopIcon(java.lang.String scrollToTopIcon)
java.lang.String getScrollToBottomIcon()
void setScrollToBottomIcon(java.lang.String scrollToBottomIcon)
java.lang.String getScrollUpIcon()
void setScrollUpIcon(java.lang.String scrollUpIcon)
java.lang.String getScrollDownIcon()
void setScrollDownIcon(java.lang.String scrollDownIcon)
java.lang.String getInactiveScrollToTopIcon()
void setInactiveScrollToTopIcon(java.lang.String inactiveScrollToTopIcon)
java.lang.String getInactiveScrollToBottomIcon()
void setInactiveScrollToBottomIcon(java.lang.String inactiveScrollToBottomIcon)
java.lang.String getInactiveScrollUpIcon()
void setInactiveScrollUpIcon(java.lang.String inactiveScrollUpIcon)
java.lang.String getInactiveScrollDownIcon()
void setInactiveScrollDownIcon(java.lang.String inactiveScrollDownIcon)
int getVisibleRow()
void setVisibleRow(int row)
row
visible.
Invalid row numbers are ignored.
void scrollToTop()
void scrollToBottom()
void scrollDown()
void scrollUp()
int getNumVisibleRows()
void setNumVisibleRows(int numVisibleRows)
int getFirstDisplayRow()
int getMaxNumberOfResultPages()
includePageNumbers
is true
.
void setMaxNumberOfResultPages(int maxNumberOfResultPages)
includePageNumbers
is true
.
NavigationRowProperties getRowPrefixProperties()
NavigationRowProperties getRowInformationProperties()
NavigationBarStyleProperties getNavigationStyleProperties()
TextStyleProperties getActivePageNumberProperties()
TextStyleProperties getInactivePageNumberProperties()
TextStyleProperties getPageNavigationProperties()
TextStyleProperties getPageNavigationInactiveProperties()
java.lang.String getPageNumbersClass()
These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.
setPageNumbersClass(String)
void setPageNumbersClass(java.lang.String pageNumbersClass)
These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.
java.lang.String getPageNumbersStyle()
This style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.
setPageNumbersStyle(String)
void setPageNumbersStyle(java.lang.String pageNumbersStyle)
This style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.
java.lang.String getNavigationClass()
These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.
setNavigationClass(String)
void setNavigationClass(java.lang.String navigationClass)
These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.
java.lang.String getNavigationStyle()
This style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.
setNavigationStyle(String)
void setNavigationStyle(java.lang.String navigationStyle)
This style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.
java.lang.String getInactiveNavigationClass()
These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.
setInactiveNavigationClass(String)
void setInactiveNavigationClass(java.lang.String inactiveNavigationClass)
These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.
java.lang.String getInactiveNavigationStyle()
This style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.
setInactiveNavigationStyle(String)
void setInactiveNavigationStyle(java.lang.String inactiveNavigationStyle)
This style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.
java.lang.String getCurrentPageClass()
These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.
setCurrentPageClass(String)
void setCurrentPageClass(java.lang.String currentPageClass)
These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.
java.lang.String getCurrentPageStyle()
This style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.
setCurrentPageStyle(String)
void setCurrentPageStyle(java.lang.String currentPageStyle)
This style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.
java.lang.String getRowInformationClass()
These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.
setRowInformationClass(String)
void setRowInformationClass(java.lang.String rowInformationClass)
These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.
java.lang.String getRowInformationStyle()
This style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.
setRowInformationStyle(String)
void setRowInformationStyle(java.lang.String rowInformationStyle)
This style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.
java.lang.String getNavigationBarClass()
These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.
setNavigationBarClass(String)
void setNavigationBarClass(java.lang.String navigationBarClass)
These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.
java.lang.String getNavigationBarStyle()
This style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.
setNavigationBarStyle(String)
void setNavigationBarStyle(java.lang.String navigationBarStyle)
This style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.
java.lang.String getInfoPrefixClass()
These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.
setInfoPrefixClass(String)
void setInfoPrefixClass(java.lang.String infoPrefixClass)
These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.
java.lang.String getInfoPrefixStyle()
This style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.
setInfoPrefixStyle(String)
void setInfoPrefixStyle(java.lang.String infoPrefixStyle)
This style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.
java.lang.String getFilterExpression()
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.
void setFilterExpression(java.lang.String filterExpression)
boolean isStartNewRowOnNextPage()
true
, content can be split.
WebForm.generatePdf()
void setStartNewRowOnNextPage(boolean startNewRowOnNextPage)
true
, content can be split.
WebForm.generatePdf()