PaginatorSnippet
This is the paginator snippet. It provides page navigation and column sorting links.
The values for the pagination are bound according to the classes specified in the paginate method, using a CSS selector transform.
Attributes
- Graph
-
- Supertypes
- Known subtypes
-
Members list
Value members
Concrete methods
The status displayed when using <nav:records/> in the template.
The status displayed when using <nav:records/> in the template.
Attributes
Overrides the super's implementation so the first record can be overridden by a URL query parameter.
Overrides the super's implementation so the first record can be overridden by a URL query parameter.
Attributes
- Definition Classes
Sets the default starting record of the page (URL query parameters take precedence over this)
Sets the default starting record of the page (URL query parameters take precedence over this)
Attributes
The template prefix for general navigation components
The template prefix for general navigation components
Attributes
The URL query parameter to propagate the record the page should start at
The URL query parameter to propagate the record the page should start at
Attributes
Returns a URL used to link to a page starting at the given record offset.
Returns a URL used to link to a page starting at the given record offset.
Attributes
Returns XML that links to a page starting at the given record offset, if the offset is valid and not the current one.
Returns XML that links to a page starting at the given record offset, if the offset is valid and not the current one.
Value parameters
- ns
-
The link text, if the offset is valid and not the current offset; or, if that is not the case, the static unlinked text to display
Attributes
Generates links to multiple pages with arbitrary XML delimiting them.
Generates links to multiple pages with arbitrary XML delimiting them.
Attributes
This method binds template HTML based according to the specified configuration. You can reference this as a snippet method directly in your template; or you can call it directly as part of your binding code.
This method binds template HTML based according to the specified configuration. You can reference this as a snippet method directly in your template; or you can call it directly as part of your binding code.
Classes used to bind:
first: link to go back to the first page (populated by[[firstXml]])prev: link to go to previous page (populated by[[prevXml]])all-pages: container for all pages (populated by[[pagesXml]])zoomed-pages: container forzoomedPages(populated by[[pagesXml]])next: link to go to next page (populated by[[nextXml]])last: link to go to last page (populated by[[lastXml]])records: currently visible records + total count (populated by[[currentXml]])records-start: start of currently visible recordsrecords-end: end of currently visible recordsrecords-count: total records count
Attributes
How to display the page's starting record
How to display the page's starting record
Attributes
Inherited methods
Calculates the current page number, based on the value of 'first.'
Calculates the current page number, based on the value of 'first.'
Attributes
- Inherited from:
- Paginator
How many items to put on each page
Calculates the number of pages the items will be spread across
Returns a list of page numbers to be displayed in 'zoomed' mode, i.e., as the page numbers get further from the current page, they are more sparse.
Returns a list of page numbers to be displayed in 'zoomed' mode, i.e., as the page numbers get further from the current page, they are more sparse.
Attributes
- Inherited from:
- Paginator
Inherited fields
Attributes
- Inherited from:
- Loggable