Package space.maxus.flare.ui.page

Class DefaultPagination

java.lang.Object

space.maxus.flare.ui.page.DefaultPagination

All Implemented Interfaces:

Pagination<Consumer<PageFrame>>

public final class DefaultPagination
extends Object
implements Pagination<Consumer<PageFrame>>

A default pagination implementation

Constructor Summary

Constructors

Constructor	Description
DefaultPagination(int defaultPage)	Constructs a new default pagination with default page

Method Summary

Modifier and Type	Method	Description
void	addSharedData(Map<ComposableSpace,Composable> packed)	Adds shared data to this pagination.
void	close()	Closes this pagination
void	commit()	Finishes the initialization of this pagination.
void	composePrioritizedShared(@NotNull Callable<PackedComposable> packed)	Adds prioritized shared components to this pagination.
void	composeShared(@NotNull ComposableSpace space, @NotNull Composable composable)	Adds shared component to this pagination.
@NotNull Frame	createPage(int page, @Nullable String title, @NotNull Consumer<PageFrame> props)	Creates a single page frame
int	currentPage()	Gets the zero-based index of currently open page
void	enable(@NotNull Frame currentFrame)	Enables pagination for current frame.
Frame	getPage(int page)	Gets the page with provided number
int	nextPageIdx()	Increments atomic counter and returns the index of the next page
void	open(org.bukkit.entity.Player player)	Opens this pagination to player
int	pageCount()	Gets the current count of pages
@Nullable Frame	peekPrevious()	Peeks the previous frame in this pagination
void	setPage(int page)	Sets current page number
void	switchPage(org.bukkit.entity.Player viewer, int to)	Switches page for viewer to certain index

Methods inherited from class java.lang.Object

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

Methods inherited from interface space.maxus.flare.ui.page.Pagination

composeShared, createPage, createPage, nextPage, previousPage

Constructor Details

DefaultPagination

public DefaultPagination(int defaultPage)

Constructs a new default pagination with default page

Parameters:

defaultPage - Default page

Method Details

createPage

@NotNull
public @NotNull Frame createPage(int page,
 @Nullable
 @Nullable String title,
 @NotNull
 @NotNull Consumer<PageFrame> props)

Description copied from interface: Pagination

Creates a single page frame

Specified by:

createPage in interface Pagination<Consumer<PageFrame>>

Parameters:

page - Number of the page

title - Title of the page

props - Props passed to the page

Returns:

Constructed page

getPage

public Frame getPage(int page)

Description copied from interface: Pagination

Gets the page with provided number

Specified by:

getPage in interface Pagination<Consumer<PageFrame>>

Parameters:

page - Number of the page

Returns:

Found page

setPage

public void setPage(int page)

Description copied from interface: Pagination

Sets current page number

Specified by:

setPage in interface Pagination<Consumer<PageFrame>>

Parameters:

page - New page number

nextPageIdx

public int nextPageIdx()

Description copied from interface: Pagination

Increments atomic counter and returns the index of the next page

Specified by:

nextPageIdx in interface Pagination<Consumer<PageFrame>>

Returns:

Zero-based index of the next page

pageCount

public int pageCount()

Description copied from interface: Pagination

Gets the current count of pages

Specified by:

pageCount in interface Pagination<Consumer<PageFrame>>

Returns:

Current count of pages

currentPage

public int currentPage()

Description copied from interface: Pagination

Gets the zero-based index of currently open page

Specified by:

currentPage in interface Pagination<Consumer<PageFrame>>

Returns:

Zero-based index of currently open page

enable

public void enable(@NotNull
 @NotNull Frame currentFrame)

Description copied from interface: Pagination

Enables pagination for current frame. Partially internal method

Specified by:

enable in interface Pagination<Consumer<PageFrame>>

Parameters:

currentFrame - Frame to be used

switchPage

public void switchPage(org.bukkit.entity.Player viewer,
 int to)

Description copied from interface: Pagination

Switches page for viewer to certain index

Specified by:

switchPage in interface Pagination<Consumer<PageFrame>>

Parameters:

viewer - Viewer of this pagination

to - Zero-based index of page to change to

open

public void open(org.bukkit.entity.Player player)

Description copied from interface: Pagination

Opens this pagination to player

Specified by:

open in interface Pagination<Consumer<PageFrame>>

Parameters:

player - Player for whom to open this pagination

close

public void close()

Description copied from interface: Pagination

Closes this pagination

Specified by:

close in interface Pagination<Consumer<PageFrame>>

peekPrevious

@Nullable
public @Nullable Frame peekPrevious()

Description copied from interface: Pagination

Peeks the previous frame in this pagination

Specified by:

peekPrevious in interface Pagination<Consumer<PageFrame>>

Returns:

Previous frame or null

addSharedData

public void addSharedData(Map<ComposableSpace,Composable> packed)

Description copied from interface: Pagination

Adds shared data to this pagination. Shared components will be injected at the initialization of page frames

Specified by:

addSharedData in interface Pagination<Consumer<PageFrame>>

Parameters:

packed - Data to be added

composeShared

public void composeShared(@NotNull
 @NotNull ComposableSpace space,
 @NotNull
 @NotNull Composable composable)

Description copied from interface: Pagination

Adds shared component to this pagination. Shared components will be injected at the initialization of page frames

Specified by:

composeShared in interface Pagination<Consumer<PageFrame>>

Parameters:

space - Space of the composed data

composable - Composable to be added

composePrioritizedShared

public void composePrioritizedShared(@NotNull
 @NotNull Callable<PackedComposable> packed)

Description copied from interface: Pagination

Adds prioritized shared components to this pagination. Shared components will be injected at the initialization of page frames

Specified by:

composePrioritizedShared in interface Pagination<Consumer<PageFrame>>

Parameters:

packed - Producer for the packed composable. It will be called lazily.

commit

public void commit()

Description copied from interface: Pagination

Finishes the initialization of this pagination. After this method call Pagination.composeShared(space.maxus.flare.ui.space.ComposableSpace, space.maxus.flare.ui.Composable), etc. will not have any effect.

Specified by:

commit in interface Pagination<Consumer<PageFrame>>