DataTable.Paginator Class
Item Index
Methods
- _afterDataChangeWithPaginator
- _afterDataUpdatesWithPaginator
- _afterPaginatorModelChange
- _afterRowsPerPageChange
- _augmentData
- _defPageSizeVal
- _getConstructor
- _initPaginatorStrings
- _paginatorRender
- _paginatorRenderUI
- _setPageSizesFn
- _setPaginatorModel
- _uiPgHandler
- firstPage
- initializer
- lastPage
- nextPage
- previousPage
Methods
_afterDataChangeWithPaginator
()
protected
After the data changes, we ensure we are on the first page and the data is augmented
_afterDataUpdatesWithPaginator
-
e
After data has changed due to a model being added, removed, or changed, update paginator model totalItems to reflect the changes.
Parameters:
_afterPaginatorModelChange
-
[e]
Augments the model list with a paged structure, or updates the paged data. Then fires reset on the model list.
Parameters:
-
[e]EventFacade optional
_afterRowsPerPageChange
-
e
After the rowsPerPage changes, update the UI to reflect the new number of
rows to be displayed. If the new value is null, destroy all instances
of the paginators.
Parameters:
_augmentData
()
protected
Augments the model list data structure with paged implementations.
The model list will contain a method for getPage that will return the
given number of items listed within the range.
each will also loop over the items in the page
_defPageSizeVal
()
protected
Returns an Array with default values for the Rows Per Page select option. We had to use a valueFn to enable language string replacement.
_getConstructor
-
type
Returns a pointer to an object to be instantiated if the provided type is a string
Parameters:
Returns:
_initPaginatorStrings
()
protected
Initializes paginatorStrings used for internationalization
_paginatorRender
()
protected
Renders the paginator into locations and attaches events.
_paginatorRenderUI
()
protected
Parse each location and render a new view into each area.
_setPageSizesFn
-
val
Ensures pageSizes value is an array of objects to be used in the
paginator view.
Parameters:
-
valArray
Returns:
Array
_setPaginatorModel
-
model
Ensures the object provided is an instance of a Y.Model. If it is not,
it assumes it is the configuration of a model, and gets the new model
type from paginatorModelType.
Returns:
Y.Model instance
_uiPgHandler
-
e
Handles the paginator's UI event into a single location. Updates the
paginatorModel according to what type is provided.
Parameters:
firstPage
()
chainable
Sets the paginatorModel to the first page.
initializer
()
protected
Constructor logic
lastPage
()
chainable
Sets the paginatorModel to the last page.
nextPage
()
chainable
Sets the paginatorModel to the next page.
previousPage
()
chainable
Sets the paginatorModel to the previous page.
Attributes
pageSizes
Array
Array of values used to populate the values in the Paginator UI allowing the end user to select the number of items to display per page.
Default: [10, 50, 100, { label: 'Show All', value: -1 }]
Fires event pageSizesChange
Fires when the value for the configuration attribute pageSizes is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
paginatorLocation
String | Array | Node
String of footer or header, a Y.Node, or an Array or any combination
of those values.
Default: footer
Fires event paginatorLocationChange
Fires when the value for the configuration attribute paginatorLocation is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
paginatorModel
Model | Object
A model instance or a configuration object for the Model.
Default: null
Fires event paginatorModelChange
Fires when the value for the configuration attribute paginatorModel is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
paginatorModelType
Model | String
A pointer to a Model object to be instantiated, or a String off of the
Y namespace.
This is only used if the paginatorModel is a configuration object or
is null.
Default: 'DataTable.Paginator.Model'
Fires event paginatorModelTypeChange
Fires when the value for the configuration attribute paginatorModelType is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
paginatorView
View | String
A pointer to a Y.View object to be instantiated. A new view will be
created for each location provided. Each view created will be given the
same model instance.
Default: 'DataTable.Paginator.View'
Fires event paginatorViewChange
Fires when the value for the configuration attribute paginatorView is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
rowsPerPage
Number | null
Number of rows to display per page. As the UI changes the number of pages to display, this will update to reflect the value selected in the UI
Default: null
Fires event rowsPerPageChange
Fires when the value for the configuration attribute rowsPerPage is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added: