org.fujion.model

Class Paginator

java.lang.Object

org.fujion.model.Paginator

All Implemented Interfaces:

IPaginator

public class Paginator
extends Object
implements IPaginator

Simple implementation of a paginator that can notify subscribers when a property value has changed.

Nested Class Summary

Nested classes/interfaces inherited from interface org.fujion.model.IPaginator

IPaginator.IPagingListener, IPaginator.PagingEventType

Constructor Summary

Constructors

Constructor and Description
Paginator()

Method Summary

Modifier and Type	Method and Description
boolean	addEventListener(IPaginator.IPagingListener listener) Register a listener to receive events when a setting changes.
int	getCurrentPage() Returns the index of the current page.
int	getMaxPage() Returns the index of the last page.
int	getModelOffset(int pageIndex) Returns the index of the first model element on the specified page.
int	getModelSize() Returns the size of the model.
int	getPageSize() Returns the number of model objects in a single page.
boolean	inRange(int modelIndex) Returns true if the model index falls within the current page.
void	removeAllListeners() Removes all listeners.
boolean	removeEventListener(IPaginator.IPagingListener listener) Removes a single event listener.
void	setCurrentPage(int pageIndex) Sets the index of the current page.
void	setModelSize(int modelSize) Sets the number of elements in the underlying model.
void	setPageSize(int pageSize) Sets the number of model objects in a single page.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fujion.model.IPaginator

hasNext, hasPrevious, isDisabled

Constructor Detail

Paginator

public Paginator()

Method Detail

getPageSize

public int getPageSize()

Description copied from interface: IPaginator

Returns the number of model objects in a single page. A value of <= 0 means that paging is disabled.

Specified by:

getPageSize in interface IPaginator

Returns:

The page size.

See Also:

IPaginator.getPageSize()

setPageSize

public void setPageSize(int pageSize)

Description copied from interface: IPaginator

Sets the number of model objects in a single page. A value of <= 0 disabled paging.

Specified by:

setPageSize in interface IPaginator

Parameters:

pageSize - The page size.

See Also:

IPaginator.setPageSize(int)

getCurrentPage

public int getCurrentPage()

Description copied from interface: IPaginator

Returns the index of the current page. Will always return 0 if paging is disabled.

Specified by:

getCurrentPage in interface IPaginator

Returns:

The current page.

See Also:

IPaginator.getCurrentPage()

setCurrentPage

public void setCurrentPage(int pageIndex)

Description copied from interface: IPaginator

Sets the index of the current page. Has no effect if paging is disabled.

Specified by:

setCurrentPage in interface IPaginator

Parameters:

pageIndex - Index of the page to become the current page.

See Also:

IPaginator.setCurrentPage(int)

getModelSize

public int getModelSize()

Description copied from interface: IPaginator

Returns the size of the model.

Specified by:

getModelSize in interface IPaginator

Returns:

Size of the model.

See Also:

IPaginator.getModelSize()

setModelSize

public void setModelSize(int modelSize)

Sets the number of elements in the underlying model.

Parameters:

modelSize - Number of elements in the underlying model.

getMaxPage

public int getMaxPage()

Description copied from interface: IPaginator

Returns the index of the last page. Will always return 0 if paging is disabled.

Specified by:

getMaxPage in interface IPaginator

Returns:

Index of the last page.

See Also:

IPaginator.getMaxPage()

inRange

public boolean inRange(int modelIndex)

Returns true if the model index falls within the current page. If the paginator is disabled, will always return true.

Parameters:

modelIndex - The model index.

Returns:

True if the index falls within the current page.

getModelOffset

public int getModelOffset(int pageIndex)

Returns the index of the first model element on the specified page. If the paginator is disabled, will always return 0. If the page index exceeds the maximum page index, will return one more than the total number of model elements.

Parameters:

pageIndex - The page index.

Returns:

The index of the first model element on the page.

addEventListener

public boolean addEventListener(IPaginator.IPagingListener listener)

Description copied from interface: IPaginator

Register a listener to receive events when a setting changes.

Specified by:

addEventListener in interface IPaginator

Parameters:

listener - The listener to add.

Returns:

True if the listener was registered. False if already registered.

See Also:

IPaginator.addEventListener(org.fujion.model.IPaginator.IPagingListener)

removeAllListeners

public void removeAllListeners()

Description copied from interface: IPaginator

Removes all listeners.

Specified by:

removeAllListeners in interface IPaginator

See Also:

IPaginator.removeAllListeners()

removeEventListener

public boolean removeEventListener(IPaginator.IPagingListener listener)

Description copied from interface: IPaginator

Removes a single event listener.

Specified by:

removeEventListener in interface IPaginator

Parameters:

listener - The listener to remove.

Returns:

True if the listener was removed. False if it was not registered.

See Also:

IPaginator.removeEventListener(org.fujion.model.IPaginator.IPagingListener)