Options
All
  • Public
  • Public/Protected
  • All
Menu

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.

Hierarchy

Index

Properties

alwaysVisible: boolean

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.

behaviors: Record<string, Behavior>

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.

currentPageTemplate: string

Template for the paginator text. It may contain placeholders such as {currentPage} or {totalPages}.

formId?: string

ID of the form to use for AJAX requests.

id: string | string[]

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.

page: number

The current page, 0-based index.

pageCount: number

The number of pages.

pageLinks: number

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.

postConstruct: PostConstructCallback

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).

postRefresh: PostRefreshCallback

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.

preDestroy: PreDestroyCallback

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.

prevRows: number

The number of rows per page for the dropdown.

rowCount: number

Total number of rows (records) to be displayed.

rows: number

The number of rows per page.

rpp: number

The configured number of rows set per page.

widgetVar: string

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