true if the paginator should be displayed always, or false if it is allowed to
be hidden under some circumstances that depend on the widget that uses the paginator.
ARIA LABEL attribute for the page links.
A map with all behaviors that were defined for this widget. The key is the name of the behavior, the value is the callback function that is invoked when the behavior is called.
Template for the paginator text. It may contain placeholders such as
{currentPage} or {totalPages}.
ID of the form to use for AJAX requests.
The client-side ID of the widget, with all parent naming containers, such as
myForm:myWidget. This is also the ID of the container HTML element for this widget. In case the widget needs
multiple container elements (such as Paginator), this may also be an array if IDs.
The current page, 0-based index.
The number of pages.
The maximum number of page links to display (when there are many pages).
A callback method that is invoked when the pagination state changes, such as when the user selects a different page or changes the current rows per page count. This property is usually provided by another widget that makes use of this paginator. You should use this callback to perform any actions required to apply the new pagination state.
An optional callback that is invoked
after this widget was created successfully, at the end of the init method. This is
usually specified via the widgetPostConstruct attribute on the JSF component. Note that this is also called
during a refresh (AJAX update).
An optional callback that is invoked after
this widget was refreshed after an AJAX update, at the end of the refresh method.
This is usually specified via the widgetPostRefresh attribute on the JSF component.
An optional callback that is invoked before
this widget is about to be destroyed, e.g. when the component was removed at the end of an AJAX update. This is
called at the beginning of the destroy method. This is usually specified via the
widgetPreDestroy attribute on the JSF component.
The number of rows per page for the dropdown.
Total number of rows (records) to be displayed.
The number of rows per page.
The name of the widget variables of this widget. The widget variable can be used to
access a widget instance by calling PF("myWidgetVar").
Generated using TypeDoc
The configuration for the Paginator widget. You can access this configuration via BaseWidget.cfg. Please note that this configuration is usually meant to be read-only and should not be modified.