Package de.placeblock.betterinventories.content.pane.impl.paginator

Class PaginatorGUIPane

java.lang.Object

de.placeblock.betterinventories.content.GUISection

de.placeblock.betterinventories.content.pane.GUIPane

de.placeblock.betterinventories.content.pane.impl.BaseHorizontalSplitGUIPane

de.placeblock.betterinventories.content.pane.impl.paginator.PaginatorGUIPane

All Implemented Interfaces:

ItemAddable<PaginatorGUIPane>, Sizeable

public class PaginatorGUIPane
extends BaseHorizontalSplitGUIPane
implements ItemAddable<PaginatorGUIPane>

A Paginator is a GUIPane that can contain items. If there are too many items you can switch pages to see all items.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PaginatorGUIPane.Builder	Builder for creating PaginatorGUIPane

Field Summary

Fields inherited from class de.placeblock.betterinventories.content.GUISection

maxSize, minSize

Constructor Summary

Constructors

Constructor	Description
PaginatorGUIPane(GUI gui, Vector2d minSize, Vector2d maxSize, boolean repeat, int startPage, PaginatorControlsPosition defaultControlsPosition, List<GUIItem> items)	Deprecated, for removal: This API element is subject to removal in a future version.
PaginatorGUIPane(GUI gui, Vector2d minSize, Vector2d maxSize, boolean repeat, int startPage, Function<PaginatorGUIPane,PaginatorControlsPane> defaultControls, List<GUIItem> items)	Deprecated.

Method Summary

Modifier and Type	Method	Description
PaginatorGUIPane	clearItems()	Clears all Items in this Paginator
Vector2d	getContentPaneSize()
int	getPages()
PaginatorGUIPane	nextPage()	Skips to the next page.
void	onItemAdd()	Is called whenever Items are added to the Paginator.
PaginatorGUIPane	previousPage()	Returns to the previous page.
PaginatorGUIPane	setCurrentPage(int index)	Sets the current page
<I extends GUIItem> PaginatorGUIPane	setItems(List<I> items)	Sets all Items in the Paginator.
void	updateSize(Sizeable parent)	Updates the size of the Paginator based on how many Items are added.
void	updateSizeRecursive(Sizeable parent)	Is called to recursively update the size of all GUIPanes

Methods inherited from class de.placeblock.betterinventories.content.pane.impl.BaseHorizontalSplitGUIPane

getChildren, getLowerPanePos, onItemProvide, render, search

Methods inherited from class de.placeblock.betterinventories.content.pane.GUIPane

onItemAdd, onItemAmount, onItemClick, onItemRemove, onSizeChange, provideItem, renderOnList, setHeight, setSize, setWidth, updateChildrenRecursive

Methods inherited from class de.placeblock.betterinventories.content.GUISection

getEmptyContentList, getHeight, getSlots, getWidth, slotToVector, vectorToSlot

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.placeblock.betterinventories.content.pane.impl.paginator.ItemAddable

addItem, addItems, addItems, addItems, addItems, getItems

Methods inherited from interface de.placeblock.betterinventories.Sizeable

clampSize, getMaxSize, getMinSize, getSize

Constructor Details

PaginatorGUIPane

@Deprecated
public PaginatorGUIPane(GUI gui,
 Vector2d minSize,
 Vector2d maxSize,
 boolean repeat,
 int startPage,
 Function<PaginatorGUIPane,PaginatorControlsPane> defaultControls,
 List<GUIItem> items)

Deprecated.

Creates a new PaginatorGUIPane

Parameters:

gui - The GUI

minSize - The minimum size of the Pane

maxSize - The minimum size of the Pane

repeat - Whether to jump back to the first page when reaching the last page (and via versa)

startPage - The start page

defaultControls - The default controls automatically appear if there is not enough space for all items. Set to null if you don't want automatic controls, or you want to handle them yourself.

items - The items to place in this paginator by default

PaginatorGUIPane

@Deprecated(forRemoval=true)
public PaginatorGUIPane(GUI gui,
 Vector2d minSize,
 Vector2d maxSize,
 boolean repeat,
 int startPage,
 PaginatorControlsPosition defaultControlsPosition,
 List<GUIItem> items)

Deprecated, for removal: This API element is subject to removal in a future version.

Creates a new PaginatorGUIPane

Parameters:

gui - The GUI

minSize - The minimum size of the Pane

maxSize - The minimum size of the Pane

repeat - Whether to jump back to the first page when reaching the last page (and via versa)

startPage - The start page

defaultControlsPosition - The default controls automatically appear if there is not enough space for all items. Set to null if you don't want automatic controls, or you want to handle them yourself. To add custom controls you can instantiate the PaginatorControlsPane

items - The items to place in this paginator by default

Method Details

updateSize

public void updateSize(Sizeable parent)

Updates the size of the Paginator based on how many Items are added.

Overrides:

updateSize in class BaseHorizontalSplitGUIPane

Parameters:

parent - The parent Pane or GUI (Sizeable)

updateSizeRecursive

public void updateSizeRecursive(Sizeable parent)

Is called to recursively update the size of all GUIPanes

Overrides:

updateSizeRecursive in class BaseHorizontalSplitGUIPane

Parameters:

parent - The parent Pane or GUI (Sizeable)

setItems

public <I extends GUIItem> PaginatorGUIPane setItems(List<I> items)

Sets all Items in the Paginator.

Type Parameters:

I - The type of the items

Parameters:

items - The new Items

Returns:

this

onItemAdd

public void onItemAdd()

Is called whenever Items are added to the Paginator. Resets Items in the content-pane

Specified by:

onItemAdd in interface ItemAddable<PaginatorGUIPane>

clearItems

public PaginatorGUIPane clearItems()

Clears all Items in this Paginator

Returns:

this

nextPage

public PaginatorGUIPane nextPage()

Skips to the next page.

Returns:

this

previousPage

public PaginatorGUIPane previousPage()

Returns to the previous page.

Returns:

this

setCurrentPage

public PaginatorGUIPane setCurrentPage(int index)

Sets the current page

Parameters:

index - The current page

Returns:

this

getPages

public int getPages()

Returns:

the amount of pages

getContentPaneSize

public Vector2d getContentPaneSize()

Returns:

The size of the content-pane according to the size of the Paginator