Package space.maxus.flare.ui.frames

Class ParamPaginatedFrame<P>

java.lang.Object

space.maxus.flare.ui.Frame

space.maxus.flare.ui.frames.ParamPaginatedFrame<P>

Type Parameters:

P - The type of props to use.

All Implemented Interfaces:

ReactivityProvider, PaginationProxy

public abstract class ParamPaginatedFrame<P>
extends Frame
implements PaginationProxy

ParamPaginatedFrame is a simple frame that supports pagination and takes in props. Composition inside the Frame.init() method will not have effect. Use PaginationProxy.createPage(java.util.function.Consumer<space.maxus.flare.ui.page.PageFrame>) instead.

Field Summary

Fields

Modifier and Type	Field	Description
protected Dimensions	dimensions
protected final @NotNull ReactiveInventoryHolder	holder
protected final @NotNull Pagination<Consumer<PageFrame>>	pagination
protected final P	props

Fields inherited from class space.maxus.flare.ui.Frame

composed, isDirty

Constructor Summary

Constructors

Constructor	Description
ParamPaginatedFrame(P props)
ParamPaginatedFrame(P props, @NotNull Dimensions dimensions)

Method Summary

Modifier and Type	Method	Description
Dimensions	getDimensions()	Gets the dimensions of this frame's inventory
@NotNull Pagination<Consumer<PageFrame>>	getPagination()	Gets the pagination of this structure
void	preInit(P props)
@NotNull org.bukkit.inventory.Inventory	selfInventory()	Gets the inventory of this frame.
void	setDimensions(Dimensions dimensions)

Methods inherited from class space.maxus.flare.ui.Frame

bindViewer, close, composableMap, compose, compose, composeAll, context, contextOrNull, drag, fireDrag, fireGenericClick, fireLeftClick, fireRightClick, fireShiftClick, fireShiftRequest, genericClick, getHolder, getTitle, getViewer, goBack, init, leftClick, markDirty, markDirty, markDirty, onClose, onOpen, open, refreshTitle, render, renderPart, restorePreviousState, rightClick, setHolder, setTitle, shiftClick, shiftRequest, switchFrame, useBoundState, useContext, useState

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.PaginationProxy

createPage, createPage, nextPage, previousPage, switchPage, usePaginationDisplay, usePaginationDisplay, useTabulation, useTabulation

Methods inherited from interface space.maxus.flare.react.ReactivityProvider

useMemo, useUnboundState

Field Details

holder

@NotNull
protected final @NotNull ReactiveInventoryHolder holder

pagination

@NotNull
protected final @NotNull Pagination<Consumer<PageFrame>> pagination

props

@NotNull
protected final P props

dimensions

protected Dimensions dimensions

Constructor Details

ParamPaginatedFrame

public ParamPaginatedFrame(@NotNull
 P props,
 @NotNull
 @NotNull Dimensions dimensions)

ParamPaginatedFrame

public ParamPaginatedFrame(@NotNull
 P props)

Method Details

preInit

public void preInit(P props)

selfInventory

@NotNull
public @NotNull org.bukkit.inventory.Inventory selfInventory()

Description copied from class: Frame

Gets the inventory of this frame.

Specified by:

selfInventory in class Frame

Returns:

the inventory of this frame.

getPagination

@NotNull
public @NotNull Pagination<Consumer<PageFrame>> getPagination()

Description copied from interface: PaginationProxy

Gets the pagination of this structure

Specified by:

getPagination in interface PaginationProxy

Returns:

Pagination suitable for PageFrame creation

getDimensions

public Dimensions getDimensions()

Description copied from class: Frame

Gets the dimensions of this frame's inventory

Specified by:

getDimensions in class Frame

Returns:

the dimensions of this frame's inventory

setDimensions

public void setDimensions(Dimensions dimensions)