IPaginator (Fujion Core Libraries 1.0.1 API)

All Known Implementing Classes:

Paginator
```
public interface IPaginator
```
Supports paging within a list model.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`IPaginator.IPagingListener` Interface for listeners receiving events when a setting is modified.
`static class`	`IPaginator.PagingEventType` Type of property change.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
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`	`getModelSize()` Returns the size of the model.
`int`	`getPageSize()` Returns the number of model objects in a single page.
`default boolean`	`hasNext()` Returns true if a previous page exists.
`default boolean`	`hasPrevious()` Returns true if a previous page exists.
`default boolean`	`isDisabled()` Returns true if paging is disabled.
`void`	`removeAllListeners()` Removes all listeners.
`boolean`	`removeEventListener(IPaginator.IPagingListener listener)` Removes a single event listener.
`void`	`setCurrentPage(int currentPage)` Sets the index of the current page.
`void`	`setPageSize(int pageSize)` Sets the number of model objects in a single page.

- Method Detail
  - getPageSize
```
int getPageSize()
```
    Returns the number of model objects in a single page. A value of <= 0 means that paging is disabled.
    
    Returns:
    
    The page size.
  - setPageSize
```
void setPageSize(int pageSize)
```
    Sets the number of model objects in a single page. A value of <= 0 disabled paging.
    
    Parameters:
    
    pageSize - The page size.
  - getCurrentPage
```
int getCurrentPage()
```
    Returns the index of the current page. Will always return 0 if paging is disabled.
    
    Returns:
    
    The current page.
  - setCurrentPage
```
void setCurrentPage(int currentPage)
```
    Sets the index of the current page. Has no effect if paging is disabled.
    
    Parameters:
    
    currentPage - Index of the page to become the current page.
  - getModelSize
```
int getModelSize()
```
    Returns the size of the model.
    
    Returns:
    
    Size of the model.
  - getMaxPage
```
int getMaxPage()
```
    Returns the index of the last page. Will always return 0 if paging is disabled.
    
    Returns:
    
    Index of the last page.
  - addEventListener
```
boolean addEventListener(IPaginator.IPagingListener listener)
```
    Register a listener to receive events when a setting changes.
    
    Parameters:
    
    listener - The listener to add.
    
    Returns:
    
    True if the listener was registered. False if already registered.
  - removeAllListeners
```
void removeAllListeners()
```
    Removes all listeners.
  - removeEventListener
```
boolean removeEventListener(IPaginator.IPagingListener listener)
```
    Removes a single event listener.
    
    Parameters:
    
    listener - The listener to remove.
    
    Returns:
    
    True if the listener was removed. False if it was not registered.
  - isDisabled
```
default boolean isDisabled()
```
    Returns true if paging is disabled.
    
    Returns:
    
    True if paging is disabled.
  - hasPrevious
```
default boolean hasPrevious()
```
    Returns true if a previous page exists. Will always return false if paging is disabled.
    
    Returns:
    
    True if a previous page exists.
  - hasNext
```
default boolean hasNext()
```
    Returns true if a previous page exists. Will always return false if paging is disabled.
    
    Returns:
    
    True if a previous page exists.

Interface IPaginator

Nested Class Summary

Method Summary

Method Detail

getPageSize

setPageSize

getCurrentPage

setCurrentPage

getModelSize

getMaxPage

addEventListener

removeAllListeners

removeEventListener

isDisabled

hasPrevious

hasNext