com.codelanx.codelanxlib.util

Class Paginator

java.lang.Object

com.codelanx.codelanxlib.util.Paginator

public class Paginator
extends Object

Wraps text in formatted bars with a title, and allows for paging through text content

Since:

0.1.0

Version:

0.1.0

Author:

1Rogue

Constructor Summary

Constructors

Constructor and Description
Paginator(String title, int itemsPerPage, List<String> content) Constructor.
Paginator(String title, int itemsPerPage, String... itr) Constructor.
Paginator(String title, int itemsPerPage, String wholeText) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getPage(int page) Returns the appropriately formatted page for this Paginator
List<String>	getPages() Returns a copy of all the pages in this instance
int	size() Returns the number of pages in this instance

Methods inherited from class java.lang.Object

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

Constructor Detail

Paginator

public Paginator(String title,
                 int itemsPerPage,
                 String wholeText)

Constructor. Splits the wholeText parameter by a newline character (\n) and forwards it to Paginator(String, int, List)

Parameters:

title - The title for the pages

itemsPerPage - The number of items from the content parameter to display on a page

wholeText - A string to be split by the newline character \n

Since:

0.1.0

See Also:

Paginator(String, int, List)

Paginator

public Paginator(String title,
                 int itemsPerPage,
                 String... itr)

Constructor. Converts the passed itr parameter into a List and forwards it to Paginator(String, int, List)

Parameters:

title - The title for the pages

itemsPerPage - The number of items from the content parameter to display on a page

itr - An iterable collection of strings

Since:

0.1.0

See Also:

Paginator(String, int, List)

Paginator

public Paginator(String title,
                 int itemsPerPage,
                 List<String> content)

Constructor. Takes a List of strings and creates formatted pages which can be output to a CommandSender. These pages should be considered immutable as they are only rendered once and then subsequently stored.

Parameters:

title - The title for the pages

itemsPerPage - The number of items from the content parameter to display on a page

content - A List of strings to display

Since:

0.1.0

Method Detail

getPage

public String getPage(int page)

Returns the appropriately formatted page for this Paginator

Parameters:

page - The page to retrieve

Returns:

The page in the form of a string

Since:

0.1.0

size

public int size()

Returns the number of pages in this instance

Returns:

The number of pages

Since:

0.1.0

getPages

public List<String> getPages()

Returns a copy of all the pages in this instance

Returns:

A copy of the pages

Since:

0.1.0