YUI recommends YUI3.

YUI 2 has been deprecated since 2011. This site acts as an archive for files and documentation.

This documentation is no longer maintained.

Yahoo! UI Library

paginator  2.9.0

Yahoo! UI Library > paginator > YAHOO.widget.Paginator.ui.NextPageLink
Search:
 
Filters

Class YAHOO.widget.Paginator.ui.NextPageLink

ui Component to generate the link to jump to the next page.

Constructor

YAHOO.widget.Paginator.ui.NextPageLink ( p )
Parameters:
p <Pagintor> Paginator instance to attach to

Properties

current - private HTMLElement

Currently placed HTMLElement node

link - private HTMLElement

Link node

span - private HTMLElement

Span node (inactive link)

Methods

destroy

private void destroy ( )
Removes the link/span node and clears event listeners

init

static void init ( p )
Decorates Paginator instances with new attributes. Called during Paginator instantiation.
Parameters:
p <Paginator> Paginator instance to decorate

onClick

void onClick ( e )
Listener for the link's onclick event. Passes to setPage method.
Parameters:
e <DOMEvent> The click event

render

HTMLElement render ( id_base )
Generate the nodes and return the appropriate node given the current pagination state.
Parameters:
id_base <string> used to create unique ids for generated nodes

update

void update ( e )
Swap the link and span nodes if appropriate.
Parameters:
e <CustomEvent> The calling change event

Events

beforeNextPageLinkClassChange

beforeNextPageLinkClassChange ( event )
Fires before the value for the configuration attribute 'nextPageLinkClass' 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.

beforeNextPageLinkLabelChange

beforeNextPageLinkLabelChange ( event )
Fires before the value for the configuration attribute 'nextPageLinkLabel' 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.

beforeNextPageLinkTitleChange

beforeNextPageLinkTitleChange ( event )
Fires before the value for the configuration attribute 'nextPageLinkTitle' 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.

nextPageLinkClassChange

nextPageLinkClassChange ( event )
Fires when the value for the configuration attribute 'nextPageLinkClass' changes.
Parameters:
event <{oldValue: any, newValue: any}> An object containing the previous attribute value and the new value.

nextPageLinkLabelChange

nextPageLinkLabelChange ( event )
Fires when the value for the configuration attribute 'nextPageLinkLabel' changes.
Parameters:
event <{oldValue: any, newValue: any}> An object containing the previous attribute value and the new value.

nextPageLinkTitleChange

nextPageLinkTitleChange ( event )
Fires when the value for the configuration attribute 'nextPageLinkTitle' changes.
Parameters:
event <{oldValue: any, newValue: any}> An object containing the previous attribute value and the new value.

Configuration Attributes

nextPageLinkClass - object

CSS class assigned to the link/span
Default Value: 'yui-pg-next'

nextPageLinkLabel - object

Used as innerHTML for the next page link/span.
Default Value: 'next >'

nextPageLinkTitle - object

Used as title for the next page link.
Default Value: 'Next Page'


Copyright © 2011 Yahoo! Inc. All rights reserved.