API Docs for: 1.0.0
Show:

Paginator.ui.RowsPerPageDropdown Class

ui Component to generate the rows-per-page dropdown

Constructor

Paginator.ui.RowsPerPageDropdown

(
  • p
)

Parameters:

  • p Pagintor

    Paginator instance to attach to

Methods

_handleTotalRecordsChange

(
  • e
)
protected

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

destroy

() private

Removes the select node and clears event listeners

onChange

(
  • e
)

Listener for the select's onchange event. Sent to setRowsPerPage method.

Parameters:

  • e DOMEvent

    The change event

rebuild

()

(Re)generate the select options.

render

(
  • id_base
)
HTMLElement

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:

update

(
  • e
)

Select the appropriate option if changed.

Parameters:

Properties

all

HTMLElement protected

option node for the optional All value

select

HTMLElement private

select node

Attributes

rowsPerPageDropdownClass

CSS class assigned to the select node

Default: 'yui-paginator-rpp-options'

rowsPerPageDropdownTitle

CSS class assigned to the select node

Default: 'Rows per page'

rowsPerPageOptions

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: []