no.g9.client.core.action

Class PaginatorEvent

java.lang.Object

no.g9.client.core.action.PaginatorEvent

public final class PaginatorEvent
extends Object

PaginatorEvent is used to signal that a paginator navigation button has been clicked.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PaginatorEvent.NavigationButton Enumerates the paging buttons

Constructor Summary

Constructors

Constructor and Description
PaginatorEvent(PaginatorEvent.NavigationButton navigationButton, int currentPage, int pageCount, int maxPages, Object sourceEvent) Create a new paginator event.
PaginatorEvent(String navigationButton, int currentPage, int pageCount, int maxPages, Object sourceEvent) Construct a new paginator event.

Method Summary

Modifier and Type	Method and Description
int	getCurrentPage() Get the current paginator page.
int	getMaxPages() Get the maximum number of displayed pages.
PaginatorEvent.NavigationButton	getNavigationButton() Get the navigation button that originated this event.
static PaginatorEvent.NavigationButton	getNavigationButton(String buttonDescription) Get a navigation button based on a descriptive text.
int	getPageCount() Get the number of displayed pages.
Object	getSourceEvent() Get the (target specific) source event.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PaginatorEvent

public PaginatorEvent(PaginatorEvent.NavigationButton navigationButton,
                      int currentPage,
                      int pageCount,
                      int maxPages,
                      Object sourceEvent)

Create a new paginator event.

Parameters:

navigationButton - the selected navigation button

currentPage - the current paginator page

pageCount - number of displayed pages

maxPages - the maximum number of pages to be displayed in the paginator

sourceEvent - the original paginator event

PaginatorEvent

public PaginatorEvent(String navigationButton,
                      int currentPage,
                      int pageCount,
                      int maxPages,
                      Object sourceEvent)

Construct a new paginator event.

Parameters:

navigationButton - the selected navigation button

currentPage - the current paginator page

pageCount - number of displayed pages

maxPages - the maximum number of pages to be displayed in the paginator

sourceEvent - the original paginator event

Method Detail

getNavigationButton

public static PaginatorEvent.NavigationButton getNavigationButton(String buttonDescription)

Get a navigation button based on a descriptive text.

Parameters:

buttonDescription - text describing the navigation button

Returns:

the navigation button matching the description

getSourceEvent

public Object getSourceEvent()

Get the (target specific) source event.

Returns:

the source event

getCurrentPage

public int getCurrentPage()

Get the current paginator page.

Returns:

the current page

getPageCount

public int getPageCount()

Get the number of displayed pages.

Returns:

the page count

getMaxPages

public int getMaxPages()

Get the maximum number of displayed pages.

Returns:

the max pages

getNavigationButton

public PaginatorEvent.NavigationButton getNavigationButton()

Get the navigation button that originated this event.

Returns:

the selected navigation button

toString

public String toString()

Overrides:

toString in class Object