at.favre.lib.hood.interfaces

Interface Pages

public interface Pages

Method Summary

Modifier and Type	Method and Description
Page	addNewPage() Adds a new page to the internal list with default title
Page	addNewPage(java.lang.String title) Adds a new page to the internal list with given title
java.util.List<Page>	getAll() Returns the actual reference, not a copy.
Config	getConfig() The config should be passed to this class
Page	getFirstPage() Same as getPage(int) with parameter 0, but throws exception, ie. making it null safe.
Page	getPage(int index) Retrieves a page for the specific index
void	log(java.lang.String message) The default implementation of what should happen when a component wants to log something.
void	logPages() Logs the whole page data
void	refreshData() Calls PageEntry.refresh() on every entry.
int	size() The count of contained pages

Method Detail

addNewPage

Page addNewPage()

Adds a new page to the internal list with default title

Returns:

the newly created page

addNewPage

Page addNewPage(java.lang.String title)

Adds a new page to the internal list with given title

Parameters:

title - of the page

Returns:

the newly created page

getFirstPage

Page getFirstPage()

Same as getPage(int) with parameter 0, but throws exception, ie. making it null safe.

Returns:

the first page

Throws:

java.lang.IllegalStateException - if no page was added

getPage

Page getPage(int index)

Retrieves a page for the specific index

Parameters:

index - of the requested page (beginning with 0)

Returns:

the page if one was found, null otherwise

getAll

java.util.List<Page> getAll()

Returns the actual reference, not a copy.

Returns:

all contained pages

size

int size()

The count of contained pages

Returns:

size

refreshData

void refreshData()

Calls PageEntry.refresh() on every entry.

log

void log(java.lang.String message)

The default implementation of what should happen when a component wants to log something. You can set e.g. tag, formatting, etc.

logPages

void logPages()

Logs the whole page data

getConfig

Config getConfig()

The config should be passed to this class

Returns:

the currently set config