org.fit.layout.api

Interface PageSetStorage

All Superinterfaces:

GUIUpdateSource, Service

public interface PageSetStorage
extends Service, GUIUpdateSource

A service that is able to manage a list of pages that are being processed. It may load the next/previous page when available.

Author:

burgetr

Method Summary

Modifier and Type	Method and Description
int	getCurrentIndex() Obtains the index of the currently loaded page.
PageSet	getCurrentPageSet() Obtains the currently active page set that is used for storing the new pages and obtaining the previous/next page.
int	getTotalCount() Obtains the total number of pages available in the current page set.
void	loadNext() Loads the next page from the current page set.
void	loadPageAt(int index) Loads the page from the storage based in its index.
void	loadPrevious() Loads the previous page from the current page set.
boolean	nextPageAvailable() Check whether a next page is available in the currently processed page set.
boolean	previousPageAvailable() Checks whether a previous page is available in the currently processed page set.

Methods inherited from interface org.fit.layout.api.Service

getDescription, getId, getName

Methods inherited from interface org.fit.layout.gui.GUIUpdateSource

registerGUIUpdateListener

Method Detail

getCurrentPageSet

PageSet getCurrentPageSet()

Obtains the currently active page set that is used for storing the new pages and obtaining the previous/next page.

Returns:

the page set or null when no page set is active

nextPageAvailable

boolean nextPageAvailable()

Check whether a next page is available in the currently processed page set.

Returns:

loadNext

void loadNext()

Loads the next page from the current page set.

previousPageAvailable

boolean previousPageAvailable()

Checks whether a previous page is available in the currently processed page set.

Returns:

loadPrevious

void loadPrevious()

Loads the previous page from the current page set.

getTotalCount

int getTotalCount()

Obtains the total number of pages available in the current page set.

Returns:

the page count or 0 when the page set is empty or no page set is selected.

getCurrentIndex

int getCurrentIndex()

Obtains the index of the currently loaded page.

Returns:

The page index or -1 when no page is loaded.

loadPageAt

void loadPageAt(int index)

Loads the page from the storage based in its index.

Parameters:

index - The page index.