Class YAHOO.widget.Paginator.ui.RowsPerPageDropdown
ui Component to generate the rows-per-page dropdown
Constructor
YAHOO.widget.Paginator.ui.RowsPerPageDropdown
(
p
)
- Parameters:
-
p
<Pagintor>
Paginator instance to attach to
Properties
all
- protected HTMLElement
option node for the optional All value
Methods
protected
void
_handleTotalRecordsChange
(
e
)
Updates the all option value (and Paginator's rowsPerPage attribute if
necessary) in response to a change in the Paginator's totalRecords.
- Parameters:
-
e
<Event>
attribute change event
- Returns:
void
private
void
destroy
(
)
Removes the select node and clears event listeners
static
void
init
(
p
)
Decorates Paginator instances with new attributes. Called during
Paginator instantiation.
- Parameters:
-
p
<Paginator>
Paginator instance to decorate
- Returns:
void
void
onChange
(
e
)
Listener for the select's onchange event. Sent to setRowsPerPage method.
- Parameters:
-
e
<DOMEvent>
The change event
- Returns:
void
void
rebuild
(
)
(Re)generate the select options.
HTMLElement
render
(
id_base
)
Generate the select and option nodes and returns the select node.
- Parameters:
-
id_base
<string>
used to create unique ids for generated nodes
- Returns:
HTMLElement
void
update
(
e
)
Select the appropriate option if changed.
- Parameters:
-
e
<CustomEvent>
The calling change event
- Returns:
void
Events
beforeRowsPerPageDropdownClassChange
(
event
)
Fires before the value for the configuration attribute 'rowsPerPageDropdownClass' changes. Return false to cancel the attribute change.
- Parameters:
-
event
<{oldValue: any, newValue: any}>
An object containing the previous attribute value and the new value.
beforeRowsPerPageOptionsChange
(
event
)
Fires before the value for the configuration attribute 'rowsPerPageOptions' changes. Return false to cancel the attribute change.
- Parameters:
-
event
<{oldValue: any, newValue: any}>
An object containing the previous attribute value and the new value.
rowsPerPageDropdownClassChange
(
event
)
Fires when the value for the configuration attribute 'rowsPerPageDropdownClass' changes.
- Parameters:
-
event
<{oldValue: any, newValue: any}>
An object containing the previous attribute value and the new value.
rowsPerPageOptionsChange
(
event
)
Fires when the value for the configuration attribute 'rowsPerPageOptions' changes.
- Parameters:
-
event
<{oldValue: any, newValue: any}>
An object containing the previous attribute value and the new value.
Configuration Attributes
CSS class assigned to the select node
Default Value: 'yui-pg-rpp-options'
Array of available rows-per-page sizes. Converted into select options.
Array values may be positive integers or object literals in the form
{ value : NUMBER, text : STRING }
Default Value: []