Package com.sk89q.worldedit.util.formatting.component

Class PaginationBox

java.lang.Object

com.sk89q.worldedit.util.formatting.component.TextComponentProducer

com.sk89q.worldedit.util.formatting.component.MessageBox

com.sk89q.worldedit.util.formatting.component.PaginationBox

Direct Known Subclasses:

CommandListBox, PaginationBox.MergedPaginationBox, SelectionCommands.BlockDistributionResult, SideEffectBox

public abstract class PaginationBox
extends MessageBox

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PaginationBox.MergedPaginationBox

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PaginationBox(String title)	Creates a Paginated component
protected	PaginationBox(String title, String pageCommand)	Creates a Paginated component

Method Summary

Modifier and Type	Method	Description
com.sk89q.worldedit.util.formatting.text.TextComponent	create()	Create a TextComponent from this producer.
com.sk89q.worldedit.util.formatting.text.Component	create(int page)
void	formatForConsole()
static PaginationBox	fromComponents(String header, String pageCommand, Collection<com.sk89q.worldedit.util.formatting.text.Component> lines)
static PaginationBox	fromStrings(String header, String pageCommand, Collection<String> lines)
static <T> PaginationBox	fromStrings(String header, String pageCommand, Collection<T> lines, com.google.common.base.Function<T,com.sk89q.worldedit.util.formatting.text.Component> adapt)
abstract com.sk89q.worldedit.util.formatting.text.Component	getComponent(int number)
abstract int	getComponentsSize()
protected final int	getCurrentPage()
void	setComponentsPerPage(int componentsPerPage)

Methods inherited from class com.sk89q.worldedit.util.formatting.component.MessageBox

centerAndBorder, getContents

Methods inherited from class com.sk89q.worldedit.util.formatting.component.TextComponentProducer

append, append, getBuilder, newline, reset

Methods inherited from class java.lang.Object

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

Constructor Details

PaginationBox

protected PaginationBox(String title)

Creates a Paginated component

Parameters:

title - The title

PaginationBox

protected PaginationBox(String title,
 @Nullable
 String pageCommand)

Creates a Paginated component

Parameters:

title - The title

pageCommand - The command to run to switch page, with %page% representing page number

Method Details

getComponent

public abstract com.sk89q.worldedit.util.formatting.text.Component getComponent(int number)

getComponentsSize

public abstract int getComponentsSize()

setComponentsPerPage

public void setComponentsPerPage(int componentsPerPage)

formatForConsole

public void formatForConsole()

getCurrentPage

protected final int getCurrentPage()

create

public com.sk89q.worldedit.util.formatting.text.Component create(int page)
                                                          throws InvalidComponentException

Throws:

InvalidComponentException

create

public com.sk89q.worldedit.util.formatting.text.TextComponent create()

Description copied from class: TextComponentProducer

Create a TextComponent from this producer.

Overrides:

create in class MessageBox

Returns:

The component

fromStrings

public static <T> PaginationBox fromStrings(String header,
 @Nullable
 String pageCommand,
 Collection<T> lines,
 com.google.common.base.Function<T,com.sk89q.worldedit.util.formatting.text.Component> adapt)

fromStrings

public static PaginationBox fromStrings(String header,
 @Nullable
 String pageCommand,
 Collection<String> lines)

fromComponents

public static PaginationBox fromComponents(String header,
 @Nullable
 String pageCommand,
 Collection<com.sk89q.worldedit.util.formatting.text.Component> lines)