com.sap.ui.commons.client
Class Paginator

java.lang.Object
  com.google.gwt.core.client.JavaScriptObject
      com.sap.ui.core.client.Element
          com.sap.ui.core.client.Control
              com.sap.ui.commons.client.Paginator

public class Paginator
extends com.sap.ui.core.client.Control

The class Paginator is the GWT wrapper for the Phoenix control: sap.ui.commons.Paginator.

The Paginator control offers navigation within a list of numbered pages. The user can directly access pages in the vicinity of the current page as well as jump to the beginning or end of the list of pages. The application is notified of any user interaction through the 'page' event.

• Properties
  • currentPage : int
    The current page.
  • numberOfPages : int
    The number of pages that the parent control has.
• Aggregations
• Associations
• Events
  • page Fired when the user when the user navigates to a different page bey either selecting it directly or jumping forward/backward.

Version:

0.18.0-SNAPSHOT

Author:

GENERATOR (JavaScript control: sap.ui.commons.Paginator)

Constructor Summary

protected

Paginator() constructs the class Paginator hidden due to JavaScriptObject restriction

Method Summary

Paginator	attachPageEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener Fired when the user when the user navigates to a different page bey either selecting it directly or jumping forward/backward.
static Paginator	create() creates a new instance of the class Paginator
static Paginator	create(String idOrConfig) creates a new instance of the class Paginator
static Paginator	create(String id, String config) creates a new instance of the class Paginator
Paginator	detachPageEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener Fired when the user when the user navigates to a different page bey either selecting it directly or jumping forward/backward.
int	getCurrentPage() Getter for property currentPage The current page.
int	getNumberOfPages() Getter for property numberOfPages The number of pages that the parent control has.
Paginator	setCurrentPage(int value) Setter for property currentPage Default value is: 1
Paginator	setNumberOfPages(int value) Setter for property numberOfPages Default value is:

Methods inherited from class com.sap.ui.core.client.Control

addStyleClass, hasStyleClass, invalidate, placeAt, placeAt, removeStyleClass, rerender

Methods inherited from class com.sap.ui.core.client.Element

_convertArray, _convertArray, _convertArray, _convertArray, _convertArray, attachBrowserEvent, attachEvent, bindAggregation, bindContext, bindProperty, bindProperty, destroy, detachBrowserEvent, detachEvent, getDomRef, getElementName, getId, getLibraryName, getModel, getParent, getProperty, getTooltip_AsString, getTooltip_Text, getTooltip, isActive, setModel, setProperty, setTooltip, setTooltip, unbindAggregation, unbindContext, unbindProperty

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Paginator

protected Paginator()

constructs the class Paginator
hidden due to JavaScriptObject restriction

Method Detail

create

public static Paginator create()

creates a new instance of the class Paginator

create

public static Paginator create(String idOrConfig)

creates a new instance of the class Paginator

Parameters:

id - id of the Paginator or configuration JSON string

create

public static Paginator create(String id,
                               String config)

creates a new instance of the class Paginator

Parameters:

id - id of the Paginator

config - configuration JSON string

getCurrentPage

public final int getCurrentPage()

Getter for property currentPage The current page.

Returns:

the value of property currentPage

setCurrentPage

public final Paginator setCurrentPage(int value)

Setter for property currentPage
Default value is: 1

Parameters:

value - int

Returns:

this to allow method chaining

getNumberOfPages

public final int getNumberOfPages()

Getter for property numberOfPages The number of pages that the parent control has.

Returns:

the value of property numberOfPages

setNumberOfPages

public final Paginator setNumberOfPages(int value)

Setter for property numberOfPages
Default value is:

Parameters:

value - int

Returns:

this to allow method chaining

attachPageEvent

public final Paginator attachPageEvent(com.sap.ui.core.client.event.EventListener listener)

attach an EventListener Fired when the user when the user navigates to a different page bey either selecting it directly or jumping forward/backward.

Event Parameters:

{int} srcPage Page which was current before the event was fired.

{int} targetPage The next page that should be displayed.

{PaginatorEvent} type What type of event was triggered.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining

detachPageEvent

public final Paginator detachPageEvent(com.sap.ui.core.client.event.EventListener listener)

detach an EventListener Fired when the user when the user navigates to a different page bey either selecting it directly or jumping forward/backward.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining