com.sap.ui.commons.client
Class PaginatorWidget

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.sap.ui.core.client.ControlWidget
              com.sap.ui.commons.client.PaginatorWidget

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.IsWidget

public class PaginatorWidget
extends com.sap.ui.core.client.ControlWidget

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: )

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

	PaginatorWidget() constructs the class PaginatorWidget
protected	PaginatorWidget(Paginator control) constructs the class PaginatorWidget
	PaginatorWidget(String id) constructs the class PaginatorWidget

Method Summary

void	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.
void	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.
Paginator	getControl() returns the reference to the Phoenix Control
int	getCurrentPage() Getter for property currentPage The current page.
int	getNumberOfPages() Getter for property numberOfPages The number of pages that the parent control has.
void	setCurrentPage(int value) Setter for property currentPage Default value is: 1
void	setNumberOfPages(int value) Setter for property numberOfPages Default value is:

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

destroy, doAttachChildren, doDetachChildren, isDesignTime, wrap

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PaginatorWidget

public PaginatorWidget()

constructs the class PaginatorWidget

PaginatorWidget

public PaginatorWidget(String id)

constructs the class PaginatorWidget

Parameters:

id - id of the PaginatorWidget

PaginatorWidget

protected PaginatorWidget(Paginator control)

constructs the class PaginatorWidget

Parameters:

control - reference to an existing Paginator

Method Detail

getControl

public Paginator getControl()

returns the reference to the Phoenix Control

Overrides:

getControl in class com.sap.ui.core.client.ControlWidget

Returns:

reference to the Phoenix Control

getCurrentPage

public int getCurrentPage()

Getter for property currentPage The current page.

Returns:

the value of property currentPage

setCurrentPage

public void setCurrentPage(int value)

Setter for property currentPage
Default value is: 1

Parameters:

value - int

getNumberOfPages

public int getNumberOfPages()

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

Returns:

the value of property numberOfPages

setNumberOfPages

public void setNumberOfPages(int value)

Setter for property numberOfPages
Default value is:

Parameters:

value - int

attachPageEvent

public void 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

detachPageEvent

public void 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