Package net.tnemc.menu.core

Class Page

java.lang.Object

net.tnemc.menu.core.Page

Direct Known Subclasses:

PlayerInstancePage

public class Page
extends Object

Page

Since:

1.5.0.0

Author:

creatorfromhell

Field Summary

Fields

Modifier and Type	Field	Description
protected Function<MenuClickHandler,Boolean>	clickHandler
protected final Map<Integer,Icon>	icons
protected Consumer<PageOpenCallback>	open
private final int	pageNumber

Constructor Summary

Constructors

Constructor	Description
Page(int pageNumber)

Method Summary

Modifier and Type	Method	Description
void	addIcon(Icon icon)
Function<MenuClickHandler,Boolean>	getClickHandler()
Map<Integer,Icon>	getIcons()
Consumer<PageOpenCallback>	getOpen()
int	number()
boolean	onClick(MenuClickHandler handler)	Handles a click action for a specific viewer identified by its UUID.
void	setClickHandler(Function<MenuClickHandler,Boolean> clickHandler)
void	setColumn(int menuRows, int startingRow, int endingRow, int column, IconBuilder iconBuilder)	Sets the specified IconBuilder to the specified column.
void	setColumn(int menuRows, int startingRow, int column, IconBuilder iconBuilder)	Sets the specified IconBuilder to the specified column.
void	setColumn(int menuRows, int column, IconBuilder iconBuilder)	Sets the specified IconBuilder to the specified column.
void	setOpen(Consumer<PageOpenCallback> open)
void	setRow(int row, int startingColumn, int endingColumn, IconBuilder iconBuilder)	Sets the specified IconBuilder to the specified row.
void	setRow(int row, int startingColumn, IconBuilder iconBuilder)	Sets the specified IconBuilder to the specified row.
void	setRow(int row, IconBuilder iconBuilder)	Sets the specified IconBuilder to the specified row.

Methods inherited from class java.lang.Object

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

Field Details

pageNumber

private final int pageNumber

icons

protected final Map<Integer,Icon> icons

clickHandler

protected Function<MenuClickHandler,Boolean> clickHandler

open

protected Consumer<PageOpenCallback> open

Constructor Details

Page

public Page(int pageNumber)

Method Details

number

public int number()

setRow

public void setRow(int row,
 IconBuilder iconBuilder)

Sets the specified IconBuilder to the specified row.

Parameters:

row - The row index where the icons will be set. Rows are indexed starting from 1, through MenuManager.ROW_SIZE.

iconBuilder - The IconBuilder used to construct the icons for the specified row.

setRow

public void setRow(int row,
 int startingColumn,
 IconBuilder iconBuilder)

Sets the specified IconBuilder to the specified row.

Parameters:

row - The row index where the icons will be set. Rows are indexed starting from 1, through MenuManager.ROW_SIZE.

startingColumn - The column to start applying the icons on, inclusive.

iconBuilder - The IconBuilder used to construct the icons for the specified row.

setRow

public void setRow(int row,
 int startingColumn,
 int endingColumn,
 IconBuilder iconBuilder)

Sets the specified IconBuilder to the specified row.

Parameters:

row - The row index where the icons will be set. Rows are indexed starting from 1, through MenuManager.ROW_SIZE.

startingColumn - The column to start applying the icons on, inclusive.

endingColumn - The column to stop applying the icons on, inclusive.

iconBuilder - The IconBuilder used to construct the icons for the specified row.

setColumn

public void setColumn(int menuRows,
 int column,
 IconBuilder iconBuilder)

Sets the specified IconBuilder to the specified column.

Parameters:

menuRows - The number of rows that the menu has.

column - The column index where the icons will be set. Columns are indexed starting from 1.

iconBuilder - The IconBuilder used to construct the icons for the specified column.

setColumn

public void setColumn(int menuRows,
 int startingRow,
 int column,
 IconBuilder iconBuilder)

Sets the specified IconBuilder to the specified column.

Parameters:

menuRows - The number of rows that the menu has.

startingRow - The row that the icons should start at, inclusive.

column - The column index where the icons will be set. Columns are indexed starting from 1.

iconBuilder - The IconBuilder used to construct the icons for the specified column.

setColumn

public void setColumn(int menuRows,
 int startingRow,
 int endingRow,
 int column,
 IconBuilder iconBuilder)

Sets the specified IconBuilder to the specified column.

Parameters:

menuRows - The number of rows that the menu has.

startingRow - The row that the icons should start at, inclusive.

endingRow - The row that the icons should end at, inclusive.

column - The column index where the icons will be set. Columns are indexed starting from 1.

iconBuilder - The IconBuilder used to construct the icons for the specified column.

onClick

public boolean onClick(MenuClickHandler handler)

Handles a click action for a specific viewer identified by its UUID.

Parameters:

handler - The MenuClickHandler for the click.

Returns:

true if the click action is blocked, indicating that it should be prevented, false if the click action is allowed to proceed.

addIcon

public void addIcon(Icon icon)

getIcons

public Map<Integer,Icon> getIcons()

getOpen

public Consumer<PageOpenCallback> getOpen()

setOpen

public void setOpen(Consumer<PageOpenCallback> open)

getClickHandler

public Function<MenuClickHandler,Boolean> getClickHandler()

setClickHandler

public void setClickHandler(Function<MenuClickHandler,Boolean> clickHandler)