Index

A B C D E F G H I K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form

A

acceptInput(ConversationContext, String) - Method in class space.maxus.flare.util.SimpleInvBoundPrompt

acceptName(String) - Method in class space.maxus.flare.ui.compose.complex.Modals.YesNoModal.YesNoModalBuilder

acceptValidatedInput(ConversationContext, String) - Method in class space.maxus.flare.util.ValidatingInvBoundPrompt

acquireCatching(Callable<V>) - Static method in class space.maxus.flare.util.FlareUtil

Acquires result of a callable, returning null if an error was encountered

acquireThrowing(Callable<V>) - Static method in class space.maxus.flare.util.FlareUtil

Acquires result of a callable, throwing a runtime error if an error was encountered

AcquiringException() - Constructor for exception space.maxus.flare.util.FlareUtil.AcquiringException

AcquiringException(String) - Constructor for exception space.maxus.flare.util.FlareUtil.AcquiringException

AcquiringException(String, Throwable) - Constructor for exception space.maxus.flare.util.FlareUtil.AcquiringException

AcquiringException(Throwable) - Constructor for exception space.maxus.flare.util.FlareUtil.AcquiringException

activate() - Method in class space.maxus.flare.ui.compose.FunctionComposable

addLore(String) - Method in class space.maxus.flare.item.ItemStackBuilder

Adds provided lore to this item's lore via FlareUtil.partitionString(String)

addLore(List<Component>) - Method in class space.maxus.flare.item.ItemStackBuilder

Adds all components to this item lore

addLoreLine(String) - Method in class space.maxus.flare.item.ItemStackBuilder

Adds a single lore line to this item lore

addLoreLine(Component) - Method in class space.maxus.flare.item.ItemStackBuilder

Adds a single lore line to this item lore

addSharedData(Map<ComposableSpace, Composable>) - Method in class space.maxus.flare.ui.page.DefaultPagination

addSharedData(Map<ComposableSpace, Composable>) - Method in interface space.maxus.flare.ui.page.Pagination

Adds shared data to this pagination.

ALL - Static variable in class space.maxus.flare.ui.space.Slot

allow(ItemStack, InventoryClickEvent) - Method in interface space.maxus.flare.ui.compose.ContainerSlot.ContainerPredicate

and(Validator) - Method in class space.maxus.flare.util.CompoundValidator

and(Validator) - Method in interface space.maxus.flare.util.Validator

Combines two validators into one, that ensures that both output true

andMatching(String) - Method in interface space.maxus.flare.util.Validator

Combines this validator with a new regex-based validator

andMatching(Pattern) - Method in interface space.maxus.flare.util.Validator

Combines this validator with a new regex-based validator

arrowBackwardButton(boolean) - Static method in interface space.maxus.flare.ui.compose.complex.PaginationDisplay

Returns the item builder for arrow backward button

arrowForwardButton(boolean) - Static method in interface space.maxus.flare.ui.compose.complex.PaginationDisplay

Returns the item builder for arrow forward button

asBuilder() - Method in class space.maxus.flare.ui.compose.complex.Modals.YesNoModal

Converts this modal into a modal builder

asComposable() - Method in interface space.maxus.flare.ui.Composable

asComposable() - Method in interface space.maxus.flare.ui.ComposableLike

Converts self to a composable

asComposable() - Method in interface space.maxus.flare.ui.compose.Button.Builder

asComposable() - Method in interface space.maxus.flare.ui.compose.Checkbox.Builder

asComposable() - Method in interface space.maxus.flare.ui.compose.complex.Modal.Builder

asComposable() - Method in class space.maxus.flare.ui.compose.complex.Modals.YesNoModal

asComposable() - Method in interface space.maxus.flare.ui.compose.complex.PaginationDisplay.Builder

asComposable() - Method in interface space.maxus.flare.ui.compose.ContainerSlot.Builder

asComposable() - Method in interface space.maxus.flare.ui.compose.Selection.Builder

asComposable() - Method in interface space.maxus.flare.ui.compose.TextInput.Builder

B

backButton(ItemProvider) - Method in interface space.maxus.flare.ui.compose.complex.PaginationDisplay.Builder

Sets the back button item provider

bind(ReactiveState<?>) - Method in interface space.maxus.flare.ui.Composable

Binds provided ReactiveState to this Composable.

bindViewer(Player) - Method in class space.maxus.flare.ui.Frame

Binds a viewer to this frame.

blocksForInput(ConversationContext) - Method in class space.maxus.flare.util.SimpleInvBoundPrompt

branch(boolean, Consumer<ItemStackBuilder>) - Method in class space.maxus.flare.item.ItemStackBuilder

A utility method that branches configuration of this builder based on condition.

branch(boolean, Consumer<ItemStackBuilder>, Consumer<ItemStackBuilder>) - Method in class space.maxus.flare.item.ItemStackBuilder

A utility method that branches configuration of this builder based on condition.

build() - Method in class space.maxus.flare.item.ItemStackBuilder

Finishes this builder and returns clone of inner stack

build() - Method in interface space.maxus.flare.ui.compose.Button.Builder

Builds the button

build() - Method in interface space.maxus.flare.ui.compose.Checkbox.Builder

Builds the component

build() - Method in interface space.maxus.flare.ui.compose.complex.Modal.Builder

Builds this modal

build() - Method in class space.maxus.flare.ui.compose.complex.Modals.YesNoModal.YesNoModalBuilder

build() - Method in interface space.maxus.flare.ui.compose.complex.PaginationDisplay.Builder

Builds this pagination display

build() - Method in interface space.maxus.flare.ui.compose.ContainerSlot.Builder

Builds this container

build() - Method in interface space.maxus.flare.ui.compose.Selection.Builder

Builds this selection

build() - Method in interface space.maxus.flare.ui.compose.TextInput.Builder

Builds this text input

builder() - Static method in interface space.maxus.flare.ui.compose.Checkbox

Creates a new Checkbox builder.

builder() - Static method in class space.maxus.flare.ui.compose.complex.Modals.YesNoModal

builder() - Static method in interface space.maxus.flare.ui.compose.ContainerSlot

Constructs a new container slot builder

builder() - Static method in interface space.maxus.flare.ui.compose.TextInput

Constructs a new text input builder

builder(ItemProvider) - Static method in interface space.maxus.flare.ui.compose.complex.Modal

Constructs a new modal builder

builder(String, String) - Static method in interface space.maxus.flare.ui.compose.TextInput

Constructs a new text input builder

builder(ItemProvider) - Static method in interface space.maxus.flare.ui.compose.TextInput

Constructs a new text input builder

builder(Collection<E>) - Static method in interface space.maxus.flare.ui.compose.Selection

Constructs a new selection builder

builder(Material) - Static method in class space.maxus.flare.item.Items

Constructs a new item stack builder for provided item type

builder(Material, Player) - Static method in class space.maxus.flare.item.Items

Constructs a new item stack builder for provided item type with PlaceholderAPI placeholder support

builder(ItemProvider) - Static method in interface space.maxus.flare.ui.compose.Button

Creates a new button builder.

builder(ItemProvider, boolean) - Static method in interface space.maxus.flare.ui.compose.Button

Creates a new button builder.

builder(Pagination<?>) - Static method in interface space.maxus.flare.ui.compose.complex.PaginationDisplay

Creates a new pagination builder

Button - Interface in space.maxus.flare.ui.compose

A button is a simple clickable component.

Button.Builder - Interface in space.maxus.flare.ui.compose

The button builder

Button.CancellingClickHandler - Interface in space.maxus.flare.ui.compose

Button.ClickHandler - Interface in space.maxus.flare.ui.compose

C

cancelling(BiConsumer<Button, InventoryClickEvent>) - Static method in interface space.maxus.flare.ui.compose.Button.ClickHandler

A click handler that always cancels event

cancellingOnLeftClick(PageFrame.SimpleClickHandler) - Method in class space.maxus.flare.ui.page.PageFrame

Adds a cancelling left click handler

cancellingOnRightClick(PageFrame.SimpleClickHandler) - Method in class space.maxus.flare.ui.page.PageFrame

Adds a cancelling right click handler

cancellingOnShiftClick(PageFrame.SimpleClickHandler) - Method in class space.maxus.flare.ui.page.PageFrame

Adds a cancelling shift click handler

canEqual(Object) - Method in class space.maxus.flare.item.ReactiveItemProvider

canEqual(Object) - Method in class space.maxus.flare.item.StillItemProvider

canEqual(Object) - Method in class space.maxus.flare.ui.compose.complex.Modal.ModalFrame

canEqual(Object) - Method in class space.maxus.flare.ui.frames.SimpleFrame

canEqual(Object) - Method in class space.maxus.flare.ui.PackedComposable

canEqual(Object) - Method in class space.maxus.flare.ui.page.PageFrame

canEqual(Object) - Method in class space.maxus.flare.ui.ReactiveInventoryHolder

canEqual(Object) - Method in class space.maxus.flare.ui.space.Rect

canEqual(Object) - Method in class space.maxus.flare.ui.space.SetSpace

canEqual(Object) - Method in class space.maxus.flare.ui.space.Slot

canEqual(Object) - Method in class space.maxus.flare.util.CompoundValidator

canEqual(Object) - Method in class space.maxus.flare.util.MinMaxPair

canEqual(Object) - Method in class space.maxus.flare.util.SimpleInvBoundPrompt

Checkbox - Interface in space.maxus.flare.ui.compose

A checkbox is a clickable component that is toggled on click.

Checkbox.Builder - Interface in space.maxus.flare.ui.compose

checkedBuilder(String, String) - Static method in interface space.maxus.flare.ui.compose.Checkbox

Standard item builder for unchecked checkbox

checkedItem(ItemProvider) - Method in interface space.maxus.flare.ui.compose.Checkbox.Builder

Sets the checked item provider for this checkbox

checkedItem(String, String) - Static method in interface space.maxus.flare.ui.compose.Checkbox

Standard item provider for checked checkbox

checkedState() - Method in interface space.maxus.flare.ui.compose.Checkbox

Returns the reactive toggle state of the checkbox.

children() - Method in interface space.maxus.flare.ui.compose.complex.Composition

Returns all composable elements inside this composition

click(InventoryClickEvent) - Method in interface space.maxus.flare.ui.Composable

Called each time this item is clicked, no matter if it is a right click, left click, middle click, etc.

click(InventoryClickEvent) - Method in interface space.maxus.flare.ui.compose.Checkbox

click(InventoryClickEvent) - Method in interface space.maxus.flare.ui.compose.complex.Composition

click(InventoryClickEvent) - Method in class space.maxus.flare.ui.compose.FunctionComposable

click(InventoryClickEvent) - Method in interface space.maxus.flare.ui.compose.TextInput

click(Button, InventoryClickEvent) - Method in interface space.maxus.flare.ui.compose.Button.CancellingClickHandler

click(Button, InventoryClickEvent) - Method in interface space.maxus.flare.ui.compose.Button.ClickHandler

click(Slot, InventoryClickEvent) - Method in interface space.maxus.flare.ui.page.PageFrame.BooleanReturningClickHandler

click(Slot, InventoryClickEvent) - Method in interface space.maxus.flare.ui.page.PageFrame.SimpleClickHandler

ClickHandler - Class in space.maxus.flare.handlers

Handles (almost) all click events for Flare.

ClickHandler() - Constructor for class space.maxus.flare.handlers.ClickHandler

close() - Method in class space.maxus.flare.ui.compose.complex.Modal.ModalFrame

close() - Method in class space.maxus.flare.ui.Frame

Closes this frame

close() - Method in class space.maxus.flare.ui.page.DefaultPagination

close() - Method in interface space.maxus.flare.ui.page.Pagination

Closes this pagination

commit() - Method in class space.maxus.flare.ui.page.DefaultPagination

commit() - Method in interface space.maxus.flare.ui.page.Pagination

Finishes the initialization of this pagination.

compareTo(Slot) - Method in class space.maxus.flare.ui.space.Slot

Composable - Interface in space.maxus.flare.ui

Represents a Component that can be rendered inside an inventory.

ComposableLike - Interface in space.maxus.flare.ui

Represents a structure that can represent itself as a Composable

composableMap() - Method in class space.maxus.flare.ui.Frame

Returns the concurrent map containing all composed elements

ComposableReactiveState<V> - Class in space.maxus.flare.ui

Represents a reactive state that is bound to certain composable, and will mark it dirty on each state change.

ComposableReactiveState(V, Composable) - Constructor for class space.maxus.flare.ui.ComposableReactiveState

Constructs a new ComposableReactiveState.

ComposableSpace - Interface in space.maxus.flare.ui.space

Represents space where composable elements can be rendered

compose() - Method in class space.maxus.flare.ui.compose.FunctionComposable

compose(PackedComposable) - Method in class space.maxus.flare.ui.Frame

Composes provided packed composable

compose(ComposableSpace, Composable) - Method in class space.maxus.flare.ui.Frame

Composes provided element inside the provided space.

composeAll(Map<ComposableSpace, Composable>) - Method in class space.maxus.flare.ui.Frame

Composes provided elements inside the provided spaces.

composed - Variable in class space.maxus.flare.ui.Frame

Elements composed inside this frame

composePrioritizedShared(Callable<PackedComposable>) - Method in class space.maxus.flare.ui.page.DefaultPagination

composePrioritizedShared(Callable<PackedComposable>) - Method in interface space.maxus.flare.ui.page.Pagination

Adds prioritized shared components to this pagination.

composeShared(PackedComposable) - Method in interface space.maxus.flare.ui.page.Pagination

Composes shared packed composable data for this pagination.

composeShared(ComposableSpace, Composable) - Method in class space.maxus.flare.ui.page.DefaultPagination

composeShared(ComposableSpace, Composable) - Method in interface space.maxus.flare.ui.page.Pagination

Adds shared component to this pagination.

Composition - Interface in space.maxus.flare.ui.compose.complex

A composition is a collection of multiple components, composed by relative coordinates.

CompoundValidator - Class in space.maxus.flare.util

A compound validator that can validate multiple predicates at once

CompoundValidator(List<Validator>) - Constructor for class space.maxus.flare.util.CompoundValidator

compute(I) - Method in class space.maxus.flare.react.MemoizedReactiveComputable

compute(I) - Method in interface space.maxus.flare.util.SafeComputable

ComputeInterruptionException() - Constructor for exception space.maxus.flare.util.SafeComputable.ComputeInterruptionException

ComputeInterruptionException(String) - Constructor for exception space.maxus.flare.util.SafeComputable.ComputeInterruptionException

ComputeInterruptionException(String, Throwable) - Constructor for exception space.maxus.flare.util.SafeComputable.ComputeInterruptionException

ComputeInterruptionException(Throwable) - Constructor for exception space.maxus.flare.util.SafeComputable.ComputeInterruptionException

Configurable<S> - Interface in space.maxus.flare.ui.compose

Represents a composable that can be further configured after creation

Configurable.Configurator<S> - Interface in space.maxus.flare.ui.compose

configure(Configurable.Configurator<TextInput>) - Method in interface space.maxus.flare.ui.compose.TextInput

configure(S) - Method in interface space.maxus.flare.ui.compose.Configurable.Configurator

configure(Configurable.Configurator<S>) - Method in interface space.maxus.flare.ui.compose.Configurable

Configures this composable element.

configureTyped(Configurable.Configurator<V>) - Method in interface space.maxus.flare.ui.compose.Configurable

Configures this composable element with a certain subtype of the object.

connect(ReactiveState<V>) - Method in class space.maxus.flare.react.ReactiveState

Connects this state to another state, meaning that whenever the other state changes, this state will be updated with its new value.

ContainerSlot - Interface in space.maxus.flare.ui.compose

ContainerSlot is a component that can have an item placed in it.

ContainerSlot.Builder - Interface in space.maxus.flare.ui.compose

Builder for ContainerSlot

ContainerSlot.ContainerEvent - Interface in space.maxus.flare.ui.compose

ContainerSlot.ContainerPredicate - Interface in space.maxus.flare.ui.compose

context() - Method in interface space.maxus.flare.ui.Composable

Attempts to get context of this composable's frame.

context() - Method in class space.maxus.flare.ui.Frame

Attempts to get current context.

contextOrNull() - Method in interface space.maxus.flare.ui.Composable

Attempts to get context of this composable's frame.

contextOrNull() - Method in class space.maxus.flare.ui.Frame

Attempts to get current context.

copy() - Method in class space.maxus.flare.util.PausingTask

Copies this task without copying its pause state

count(int) - Method in class space.maxus.flare.item.ItemStackBuilder

Sets the amount of items in this stack

create() - Static method in interface space.maxus.flare.ui.compose.GoBackButton

Returns a default go back item

createPage(int, String, Consumer<PageFrame>) - Method in class space.maxus.flare.ui.page.DefaultPagination

createPage(int, String, P) - Method in interface space.maxus.flare.ui.page.Pagination

Creates a single page frame

createPage(String, P) - Method in interface space.maxus.flare.ui.page.Pagination

Creates a frame with props and title

createPage(String, Consumer<PageFrame>) - Method in interface space.maxus.flare.ui.page.PaginationProxy

Creates a page with the provided configurator function and title

createPage(Consumer<PageFrame>) - Method in interface space.maxus.flare.ui.page.PaginationProxy

Creates a page with the provided configurator function

createPage(P) - Method in interface space.maxus.flare.ui.page.Pagination

Creates a frame with props

createProfile(String) - Static method in class space.maxus.flare.util.FlareUtil

Creates a new player profile with provided skin

currentPage() - Method in class space.maxus.flare.ui.page.DefaultPagination

currentPage() - Method in interface space.maxus.flare.ui.page.Pagination

Gets the zero-based index of currently open page

D

declineName(String) - Method in class space.maxus.flare.ui.compose.complex.Modals.YesNoModal.YesNoModalBuilder

DefaultPagination - Class in space.maxus.flare.ui.page

A default pagination implementation

DefaultPagination(int) - Constructor for class space.maxus.flare.ui.page.DefaultPagination

Constructs a new default pagination with default page

description(String) - Method in class space.maxus.flare.ui.compose.complex.Modals.YesNoModal.YesNoModalBuilder

destroy() - Method in interface space.maxus.flare.ui.Composable

Destroys this composable and its underlying resources.

dim() - Method in record class space.maxus.flare.ui.page.PageFrame.Props

Returns the value of the dim record component.

dimensions - Variable in class space.maxus.flare.ui.frames.PaginatedFrame

dimensions - Variable in class space.maxus.flare.ui.frames.ParamFrame

dimensions - Variable in class space.maxus.flare.ui.frames.ParamPaginatedFrame

dimensions - Variable in class space.maxus.flare.ui.frames.SimpleFrame

dimensions() - Method in record class space.maxus.flare.ui.compose.complex.Modal.ModalProps

Returns the value of the dimensions record component.

dimensions(Dimensions) - Method in interface space.maxus.flare.ui.compose.complex.Modal.Builder

Sets the dimensions of the modal frame

Dimensions - Enum Class in space.maxus.flare.ui

Possible dimensions for Flare UIs

Disable - Interface in space.maxus.flare.ui.compose

A super interface for composable elements that can be disabled

disabled(boolean) - Method in interface space.maxus.flare.ui.compose.Button.Builder

Sets whether the button is disabled

disabled(boolean) - Method in interface space.maxus.flare.ui.compose.complex.Modal.Builder

Disables the modal button

disabled(boolean) - Method in interface space.maxus.flare.ui.compose.ContainerSlot.Builder

Makes the container disabled

disabled(boolean) - Method in interface space.maxus.flare.ui.compose.TextInput.Builder

Sets the disabled state

disabledState() - Method in interface space.maxus.flare.ui.compose.Checkbox

disabledState() - Method in interface space.maxus.flare.ui.compose.Disable

Returns the reactive disabled state of the element

drag(Map<Slot, ItemStack>, InventoryDragEvent) - Method in interface space.maxus.flare.ui.Composable

Called when items are dragged across this composable inside interface.

drag(Map<Slot, ItemStack>, InventoryDragEvent) - Method in interface space.maxus.flare.ui.compose.complex.Composition

drag(Map<Slot, ItemStack>, InventoryDragEvent) - Method in class space.maxus.flare.ui.Frame

Called when items are dragged across this frame.

drag(Map<Slot, ItemStack>, InventoryDragEvent) - Method in class space.maxus.flare.ui.frames.PaginatedFrame

drag(Map<Slot, ItemStack>, InventoryDragEvent) - Method in class space.maxus.flare.ui.page.PageFrame

drag(Map<Slot, ItemStack>, InventoryDragEvent) - Method in interface space.maxus.flare.ui.page.PageFrame.DragHandler

E

editMeta(Consumer<ItemMeta>) - Method in class space.maxus.flare.item.ItemStackBuilder

Edits meta of this item

editTypedMeta(Consumer<M>) - Method in class space.maxus.flare.item.ItemStackBuilder

Edits meta of this item, using a generic type ItemStackBuilder

empty() - Static method in class space.maxus.flare.item.Items

Constructs an empty ItemStack of type Material.GRAY_STAINED_GLASS_PANE.

empty(ItemProvider) - Method in interface space.maxus.flare.ui.compose.ContainerSlot.Builder

Sets the empty item provider for this container

empty(Material) - Static method in class space.maxus.flare.item.Items

Constructs an ItemStack with empty name and lore of provided Material

emptyBuilder(String, String) - Static method in interface space.maxus.flare.ui.compose.ContainerSlot

Returns item builder for empty container slot item

emptyBuilder(Material, float, boolean) - Static method in interface space.maxus.flare.ui.compose.ProgressBar

Returns an item builder for an empty progress bar part

emptyItem(String, String) - Static method in interface space.maxus.flare.ui.compose.ContainerSlot

Returns item provider for empty container slot item

emptyProvider(ReactiveState<Float>, Material, boolean) - Static method in interface space.maxus.flare.ui.compose.ProgressBar

Returns an item builder for an empty progress bar part

enable(Frame) - Method in class space.maxus.flare.ui.page.DefaultPagination

enable(Frame) - Method in interface space.maxus.flare.ui.page.Pagination

Enables pagination for current frame.

enumeration() - Method in interface space.maxus.flare.ui.compose.Selection

Lists all possible values in this selection

equals(Object) - Method in class space.maxus.flare.item.ReactiveItemProvider

equals(Object) - Method in class space.maxus.flare.item.StillItemProvider

equals(Object) - Method in class space.maxus.flare.ui.compose.complex.Modal.ModalFrame

equals(Object) - Method in record class space.maxus.flare.ui.compose.complex.Modal.ModalProps

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in class space.maxus.flare.ui.frames.SimpleFrame

equals(Object) - Method in class space.maxus.flare.ui.PackedComposable

equals(Object) - Method in class space.maxus.flare.ui.page.PageFrame

equals(Object) - Method in record class space.maxus.flare.ui.page.PageFrame.Props

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in class space.maxus.flare.ui.ReactiveInventoryHolder

equals(Object) - Method in class space.maxus.flare.ui.space.Rect

equals(Object) - Method in class space.maxus.flare.ui.space.SetSpace

equals(Object) - Method in class space.maxus.flare.ui.space.Slot

equals(Object) - Method in class space.maxus.flare.util.CompoundValidator

equals(Object) - Method in class space.maxus.flare.util.MinMaxPair

equals(Object) - Method in class space.maxus.flare.util.SafeComputable.Wrapper

equals(Object) - Method in class space.maxus.flare.util.SimpleInvBoundPrompt

execute(Runnable) - Static method in class space.maxus.flare.util.FlareUtil

Executes a task on the general flare executor service

executeNTimesAsync(Runnable, int, long) - Static method in class space.maxus.flare.util.FlareUtil

Executes a task asynchronously using Bukkit scheduler.

executor(int) - Static method in class space.maxus.flare.util.FlareUtil

Constructs a new executor service with the given number of threads

extraInformation(String) - Method in class space.maxus.flare.ui.compose.complex.Modals.YesNoModal.YesNoModalBuilder

F

filterPut(ContainerSlot.ContainerPredicate) - Method in interface space.maxus.flare.ui.compose.ContainerSlot.Builder

Sets the put filter for this container

filterTake(ContainerSlot.ContainerPredicate) - Method in interface space.maxus.flare.ui.compose.ContainerSlot.Builder

Sets the take filter for this container

fireDrag(Map<Slot, ItemStack>, InventoryDragEvent) - Method in class space.maxus.flare.ui.Frame

fireGenericClick(Slot, InventoryClickEvent) - Method in class space.maxus.flare.ui.Frame

fireLeftClick(Slot, InventoryClickEvent) - Method in class space.maxus.flare.ui.Frame

fireRightClick(Slot, InventoryClickEvent) - Method in class space.maxus.flare.ui.Frame

fireShiftClick(Slot, InventoryClickEvent) - Method in class space.maxus.flare.ui.Frame

fireShiftRequest(ItemStack, InventoryClickEvent) - Method in class space.maxus.flare.ui.Frame

fitIn(ComposableSpace) - Method in interface space.maxus.flare.ui.compose.complex.Composition

FIVE_BY_NINE - Enum constant in enum class space.maxus.flare.ui.Dimensions

5x9

Flare - Class in space.maxus.flare

Flare() - Constructor for class space.maxus.flare.Flare

FlareUtil - Class in space.maxus.flare.util

A utility class containing different utilities for Flare

FlareUtil.AcquiringException - Exception in space.maxus.flare.util

Thrown inside of FlareUtil.acquireThrowing(Callable) to indicate an error was encountered while acquiring a value

formatFloat(float) - Static method in class space.maxus.flare.util.FlareUtil

Formats a float to a string

formatter(Computable<E, String>) - Method in interface space.maxus.flare.ui.compose.Selection.Builder

Sets the formatter.

forwardButton(ItemProvider) - Method in interface space.maxus.flare.ui.compose.complex.PaginationDisplay.Builder

Sets the forward button item provider

FOUR_BY_NINE - Enum constant in enum class space.maxus.flare.ui.Dimensions

4x9

Frame - Class in space.maxus.flare.ui

The super class to all Flare frames.

Frame() - Constructor for class space.maxus.flare.ui.Frame

fullBuilder(Material, float, boolean) - Static method in interface space.maxus.flare.ui.compose.ProgressBar

Returns an item builder for a full progress bar part

fullProvider(ReactiveState<Float>, Material, boolean) - Static method in interface space.maxus.flare.ui.compose.ProgressBar

Returns an item builder for a full progress bar part

FunctionComposable<P> - Class in space.maxus.flare.ui.compose

FunctionComposable(P) - Constructor for class space.maxus.flare.ui.compose.FunctionComposable

G

genericClass() - Static method in class space.maxus.flare.util.FlareUtil

Attempts to get a class for a generic type parameter

genericClick(Slot, InventoryClickEvent) - Method in class space.maxus.flare.ui.Frame

Called every time this frame is clicked.

genericClick(Slot, InventoryClickEvent) - Method in class space.maxus.flare.ui.frames.PaginatedFrame

genericClick(Slot, InventoryClickEvent) - Method in class space.maxus.flare.ui.page.PageFrame

genericErrorItem - Static variable in class space.maxus.flare.item.Items

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

Scheduled to be removed when local error handling is implemented (approx. 1.1.0)

get() - Method in class space.maxus.flare.react.ReactiveState

Gets the value of this state.

getColumn() - Method in class space.maxus.flare.ui.space.Slot

getColumns() - Method in enum class space.maxus.flare.ui.Dimensions

Amount of columns in these dimensions

getComposable() - Method in class space.maxus.flare.ui.PackedComposable

The composable itself

getComposed() - Method in class space.maxus.flare.ui.compose.FunctionComposable

getComputable() - Method in class space.maxus.flare.item.ReactiveItemProvider

getComputable() - Method in class space.maxus.flare.util.SafeComputable.Wrapper

getCurrent() - Method in class space.maxus.flare.item.ReactiveItemProvider

getCurrentValue() - Method in class space.maxus.flare.react.MemoizedReactiveComputable

getDimensions() - Method in class space.maxus.flare.ui.Frame

Gets the dimensions of this frame's inventory

getDimensions() - Method in class space.maxus.flare.ui.frames.PaginatedFrame

getDimensions() - Method in class space.maxus.flare.ui.frames.ParamFrame

getDimensions() - Method in class space.maxus.flare.ui.frames.ParamPaginatedFrame

getDimensions() - Method in class space.maxus.flare.ui.frames.SimpleFrame

getFrame() - Method in interface space.maxus.flare.ui.compose.complex.Modal

Returns the frame of this modal

getFrame() - Method in class space.maxus.flare.ui.ReactiveInventoryHolder

getGenericErrorItem() - Static method in class space.maxus.flare.item.Items

Deprecated.

Scheduled to be removed when local error handling is implemented (approx. 1.1.0)

getHolder() - Method in class space.maxus.flare.ui.Frame

Gets the Flare InventoryHolder for this frame

getHolder() - Method in class space.maxus.flare.ui.frames.PaginatedFrame

getHolder() - Method in class space.maxus.flare.ui.frames.ParamFrame

getHolder() - Method in class space.maxus.flare.ui.frames.SimpleFrame

getInstance() - Static method in class space.maxus.flare.Flare

getInventory() - Method in class space.maxus.flare.ui.ReactiveInventoryHolder

getInventory() - Method in class space.maxus.flare.util.SimpleInvBoundPrompt

getInventoryNoRender() - Method in class space.maxus.flare.ui.ReactiveInventoryHolder

getIsClosing() - Method in class space.maxus.flare.ui.compose.complex.Modal.ModalFrame

getItem() - Method in interface space.maxus.flare.ui.compose.ContainerSlot

Gets the item inside this container

getMax() - Method in class space.maxus.flare.util.MinMaxPair

The bigger value

getMetrics() - Static method in class space.maxus.flare.Flare

getMin() - Method in class space.maxus.flare.util.MinMaxPair

The smaller value

getNms() - Static method in class space.maxus.flare.Flare

getOptional() - Method in class space.maxus.flare.react.ReactiveState

Gets the value of this state as an optional.

getOrNull() - Method in class space.maxus.flare.react.ReactiveState

Gets the value of this state or null.

getPage(int) - Method in class space.maxus.flare.ui.page.DefaultPagination

getPage(int) - Method in interface space.maxus.flare.ui.page.Pagination

Gets the page with provided number

getPagination() - Method in interface space.maxus.flare.ui.compose.complex.PaginationDisplay

Gets the current pagination

getPagination() - Method in interface space.maxus.flare.ui.compose.complex.Tabulation

Returns bound pagination

getPagination() - Method in class space.maxus.flare.ui.frames.PaginatedFrame

getPagination() - Method in class space.maxus.flare.ui.frames.ParamPaginatedFrame

getPagination() - Method in interface space.maxus.flare.ui.page.PaginationProxy

Gets the pagination of this structure

getParent() - Method in interface space.maxus.flare.text.ReactiveComponent

Gets parent text component that will be mutated on state change

getParent() - Method in class space.maxus.flare.ui.compose.complex.Modal.ModalFrame

The parent modal used

getPasses() - Method in class space.maxus.flare.util.CompoundValidator

getPeriod() - Method in interface space.maxus.flare.ui.compose.Slideshow

Returns the period between the slides switching

getProgress() - Method in interface space.maxus.flare.ui.compose.ProgressBar

Gets current bar progress

getPrompt() - Method in interface space.maxus.flare.ui.compose.TextInput

Returns the default prompt

getPrompt() - Method in class space.maxus.flare.util.SimpleInvBoundPrompt

getPromptText(ConversationContext) - Method in class space.maxus.flare.util.SimpleInvBoundPrompt

getPromptText(ConversationContext) - Method in class space.maxus.flare.util.ValidatingInvBoundPrompt

getProvider() - Method in interface space.maxus.flare.ui.compose.ProviderRendered

Gets the provider for rendering

getRow() - Method in class space.maxus.flare.ui.space.Slot

getRows() - Method in enum class space.maxus.flare.ui.Dimensions

Amount of rows in these dimensions

getSelected() - Method in interface space.maxus.flare.ui.compose.Selection

Returns the selected value

getSelfReference() - Method in class space.maxus.flare.ui.ComposableReactiveState

Reference to the related composable.

getSize() - Method in class space.maxus.flare.ui.ReactiveInventoryHolder

getSlides() - Method in interface space.maxus.flare.ui.compose.Slideshow

Returns all possible slides on this slideshow

getSlots() - Method in class space.maxus.flare.ui.space.SetSpace

getSpace() - Method in class space.maxus.flare.ui.PackedComposable

Space for the composable

getStack() - Method in class space.maxus.flare.item.StillItemProvider

getSubscriberList() - Method in interface space.maxus.flare.react.ReactiveNotifier

Returns this notifier's subscriber list

getSubscriberList() - Method in class space.maxus.flare.react.ReactiveState

getText() - Method in interface space.maxus.flare.ui.compose.TextInput

Returns current text value

getTextState() - Method in class space.maxus.flare.util.SimpleInvBoundPrompt

getTitle() - Method in class space.maxus.flare.ui.Frame

Gets the default title of this frame.

getTitle() - Method in class space.maxus.flare.ui.page.PageFrame

getTotalSize() - Method in enum class space.maxus.flare.ui.Dimensions

Total size of these dimensions in slots

getValidator() - Method in interface space.maxus.flare.ui.compose.TextInput

Returns the input validator

getViewer() - Method in class space.maxus.flare.ui.Frame

Viewer currently inside this frame.

glint() - Method in class space.maxus.flare.item.ItemStackBuilder

Adds enchantment glint to this item.

goBack() - Method in class space.maxus.flare.ui.Frame

Goes to the previous frame or does nothing if it is null.

GoBackButton - Interface in space.maxus.flare.ui.compose

A button that takes player to previously opened frame.

goBackItem(HumanEntity) - Static method in interface space.maxus.flare.ui.compose.GoBackButton

Returns a default go back item

goBackItemBuilder(Frame) - Static method in interface space.maxus.flare.ui.compose.GoBackButton

Returns the default builder for go back button

H

handle(ItemStack, InventoryClickEvent) - Method in interface space.maxus.flare.ui.compose.ContainerSlot.ContainerEvent

handleClick(InventoryClickEvent) - Method in class space.maxus.flare.ui.compose.FunctionComposable

handleLeftClick(InventoryClickEvent) - Method in class space.maxus.flare.ui.compose.FunctionComposable

handleRightClick(InventoryClickEvent) - Method in class space.maxus.flare.ui.compose.FunctionComposable

handleShiftFrom(InventoryClickEvent) - Method in class space.maxus.flare.ui.compose.FunctionComposable

handleShiftInto(ItemStack, InventoryClickEvent) - Method in class space.maxus.flare.ui.compose.FunctionComposable

hashCode() - Method in class space.maxus.flare.item.ReactiveItemProvider

hashCode() - Method in class space.maxus.flare.item.StillItemProvider

hashCode() - Method in class space.maxus.flare.ui.compose.complex.Modal.ModalFrame

hashCode() - Method in record class space.maxus.flare.ui.compose.complex.Modal.ModalProps

Returns a hash code value for this object.

hashCode() - Method in class space.maxus.flare.ui.frames.SimpleFrame

hashCode() - Method in class space.maxus.flare.ui.PackedComposable

hashCode() - Method in class space.maxus.flare.ui.page.PageFrame

hashCode() - Method in record class space.maxus.flare.ui.page.PageFrame.Props

Returns a hash code value for this object.

hashCode() - Method in class space.maxus.flare.ui.ReactiveInventoryHolder

hashCode() - Method in class space.maxus.flare.ui.space.Rect

hashCode() - Method in class space.maxus.flare.ui.space.SetSpace

hashCode() - Method in class space.maxus.flare.ui.space.Slot

hashCode() - Method in class space.maxus.flare.util.CompoundValidator

hashCode() - Method in class space.maxus.flare.util.MinMaxPair

hashCode() - Method in class space.maxus.flare.util.SafeComputable.Wrapper

hashCode() - Method in class space.maxus.flare.util.SimpleInvBoundPrompt

head(String) - Static method in class space.maxus.flare.item.Items

Constructs a new player head item with provided skin Base64 string.

head(String, Consumer<SkullMeta>) - Static method in class space.maxus.flare.item.Items

Constructs a new player head item with provided skin Base64 string and additional meta.

headSkin(String) - Method in class space.maxus.flare.item.ItemStackBuilder

Sets this item's head skin to the provided skin.

HEX - Static variable in class space.maxus.flare.util.Validators

Validates that a string is a parsable hex code

hideAllFlags() - Method in class space.maxus.flare.item.ItemStackBuilder

Adds all ItemFlags to this item, essentially hiding all extra data from lore.

hideFlags(ItemFlag...) - Method in class space.maxus.flare.item.ItemStackBuilder

Adds certain provided item flags to this item

holder - Variable in class space.maxus.flare.ui.frames.PaginatedFrame

holder - Variable in class space.maxus.flare.ui.frames.ParamFrame

holder - Variable in class space.maxus.flare.ui.frames.ParamPaginatedFrame

holder - Variable in class space.maxus.flare.ui.frames.SimpleFrame

I

inherit(ReactiveInventoryHolder) - Method in class space.maxus.flare.ui.ReactiveInventoryHolder

init() - Method in class space.maxus.flare.ui.Frame

Called once inside the constructor

init() - Method in class space.maxus.flare.ui.frames.ParamFrame

init() - Method in class space.maxus.flare.ui.frames.SimpleFrame

init() - Method in class space.maxus.flare.ui.page.PageFrame

initData() - Method in record class space.maxus.flare.ui.page.PageFrame.Props

Returns the value of the initData record component.

initializer() - Method in record class space.maxus.flare.ui.compose.complex.Modal.ModalProps

Returns the value of the initializer record component.

initializer() - Method in record class space.maxus.flare.ui.page.PageFrame.Props

Returns the value of the initializer record component.

initializer(Consumer<Modal.ModalFrame>) - Method in interface space.maxus.flare.ui.compose.complex.Modal.Builder

Sets the modal frame initializer

initialText(String) - Method in interface space.maxus.flare.ui.compose.TextInput.Builder

Sets the initial text value (defaults to empty string)

initTitle() - Method in record class space.maxus.flare.ui.page.PageFrame.Props

Returns the value of the initTitle record component.

injectRoot(Frame) - Method in interface space.maxus.flare.ui.Composable

Injects frame into this component, the frame can then be retrieved from Composable.root()

injectRoot(Frame) - Method in class space.maxus.flare.ui.compose.FunctionComposable

injectRoot(Frame) - Method in class space.maxus.flare.ui.compose.RootReferencing

inputItem(ReactiveState<String>, String, String) - Static method in interface space.maxus.flare.ui.compose.TextInput

Returns an item provider for a text input

inputItemBuilder(String, String, String) - Static method in interface space.maxus.flare.ui.compose.TextInput

Returns an item builder for a text input

inside(ComposableSpace) - Method in interface space.maxus.flare.ui.Composable

Fits this composable inside the provided space, essentially returning a pair of this component and the space in the form of a PackedComposable.

inside(ComposableSpace) - Method in interface space.maxus.flare.ui.compose.complex.Composition

inside(ComposableSpace) - Method in class space.maxus.flare.ui.compose.FunctionComposable

inside(ComposableSpace) - Method in class space.maxus.flare.ui.compose.RootReferencing

inside(ComposableSpace) - Method in interface space.maxus.flare.ui.ComposableLike

Positions itself inside a space, essentially returning a PackedComposable

INTEGER - Static variable in class space.maxus.flare.util.Validators

Validates that a string is a parsable integer

into(ReactiveState<T>) - Method in interface space.maxus.flare.ui.Composable

Sets provided ReactiveState value to this Composable reference.

isChecked() - Method in interface space.maxus.flare.ui.compose.Checkbox

Gets whether the checkbox is checked.

isChecked(boolean) - Method in interface space.maxus.flare.ui.compose.Checkbox.Builder

Sets whether the checkbox is toggled

isClosing - Variable in class space.maxus.flare.ui.compose.complex.Modal.ModalFrame

isDirty - Variable in class space.maxus.flare.ui.Frame

Whether this frame is dirty.

isDisabled() - Method in interface space.maxus.flare.ui.compose.Disable

Returns whether the element is disabled

isDisabled(boolean) - Method in interface space.maxus.flare.ui.compose.Checkbox.Builder

Sets whether the checkbox is disabled

isDisabled(boolean) - Method in interface space.maxus.flare.ui.compose.Selection.Builder

Sets the disabled state of selection

isInputValid(ConversationContext, String) - Method in class space.maxus.flare.util.ValidatingInvBoundPrompt

isNotDisabled() - Method in interface space.maxus.flare.ui.compose.Disable

Returns whether the element is not disabled

isNullOrAir(ItemStack) - Static method in class space.maxus.flare.util.FlareUtil

Checks if a stack is null or air

isPlaceholderApiSupported() - Static method in class space.maxus.flare.Flare

isValid(String) - Method in class space.maxus.flare.util.CompoundValidator

isValid(String) - Method in interface space.maxus.flare.util.Validator

Ensures that input is valid

item(ReactiveState<V>, Computable<V, ItemStack>) - Static method in class space.maxus.flare.react.Reactive

Creates a reactive item provider from a state and a provider.

item(ItemStack) - Method in interface space.maxus.flare.ui.compose.ContainerSlot.Builder

Sets the item inside this container

item(ItemProvider) - Method in interface space.maxus.flare.ui.compose.Selection.Builder

Sets the item provider.

ItemProvider - Interface in space.maxus.flare.item

A functional interface that is used to represent items within Flare.

Items - Class in space.maxus.flare.item

A utility class for manipulations with items inside Flare

ItemStackBuilder - Class in space.maxus.flare.item

An ItemStack Builder, which is a wrapper around an ItemStack that contains multiple convenience methods for constructing ItemStacks.

ItemStackBuilder(Material, Player) - Constructor for class space.maxus.flare.item.ItemStackBuilder

Constructs a new ItemStackBuilder for the given Material.

itemState() - Method in interface space.maxus.flare.ui.compose.ContainerSlot

Returns the reactive state of an item inside this container

itemState() - Method in interface space.maxus.flare.ui.compose.Slideshow

Returns the reactive state of the currently selected item provider

K

keyFromComposable(Map<K, Composable>, Composable) - Static method in class space.maxus.flare.util.FlareUtil

keyFromValue(Map<K, V>, V) - Static method in class space.maxus.flare.util.FlareUtil

Attempts to find key from value inside a map

L

leftClick(InventoryClickEvent) - Method in interface space.maxus.flare.ui.Composable

Called when this component is left clicked inside interface

leftClick(InventoryClickEvent) - Method in interface space.maxus.flare.ui.compose.complex.Composition

leftClick(InventoryClickEvent) - Method in class space.maxus.flare.ui.compose.FunctionComposable

leftClick(Slot, InventoryClickEvent) - Method in class space.maxus.flare.ui.Frame

Called when this frame is left clicked

leftClick(Slot, InventoryClickEvent) - Method in class space.maxus.flare.ui.frames.PaginatedFrame

leftClick(Slot, InventoryClickEvent) - Method in class space.maxus.flare.ui.page.PageFrame

load() - Method in class space.maxus.flare.ui.page.PageFrame

logger() - Static method in class space.maxus.flare.Flare

lore(String) - Method in class space.maxus.flare.item.ItemStackBuilder

Sets lore of the item to the provided lore via Items.loreMeta(java.lang.String)

lore(List<Component>) - Method in class space.maxus.flare.item.ItemStackBuilder

Sets this item's lore to provided component list

loreMeta(String) - Static method in class space.maxus.flare.item.Items

Returns a consumer that will set the lore of item

loreMeta(String, Player) - Static method in class space.maxus.flare.item.Items

Returns a consumer that will set the lore of item

M

map2setIntersect(Map<K, V>, Set<K>) - Static method in class space.maxus.flare.util.FlareUtil

Finds an intersection between map keys and provided set, returning part of map with matched keys

markDirty() - Method in interface space.maxus.flare.ui.Composable

Marks this component dirty, meaning its area will be redrawn next tick.

markDirty() - Method in class space.maxus.flare.ui.compose.FunctionComposable

markDirty() - Method in class space.maxus.flare.ui.compose.RootReferencing

markDirty() - Method in class space.maxus.flare.ui.Frame

Marks this whole frame as dirty, meaning it will be re-rendered on next tick

markDirty(Composable) - Method in class space.maxus.flare.ui.Frame

Marks the provided composable's space as dirty, meaning it will be re-rendered on next tick

markDirty(ComposableSpace) - Method in class space.maxus.flare.ui.Frame

Marks the provided space in this composable as dirty, meaning it will be re-rendered on next tick

matching(String) - Static method in interface space.maxus.flare.util.Validator

Constructs a validator that matches based on a Regular Expression

matching(Pattern) - Static method in interface space.maxus.flare.util.Validator

Constructs a validator that matches based on a compiled Regular Expression

memoize(Computable<I, O>) - Static method in class space.maxus.flare.util.FlareUtil

Memoizes a computable

MemoizedReactiveComputable<I,O> - Class in space.maxus.flare.react

A `Computable`, that uses a `Memoizer` to cache its results based on reactive state.

MemoizedReactiveComputable(Memoizer<I, O>) - Constructor for class space.maxus.flare.react.MemoizedReactiveComputable

MINI_MESSAGE - Static variable in class space.maxus.flare.util.FlareUtil

Flare MiniMessage instance.

MinMaxPair<A extends Comparable<A>> - Class in space.maxus.flare.util

A pair which sorts two values by their ordering via Comparable

MinMaxPair(A, A) - Constructor for class space.maxus.flare.util.MinMaxPair

Constructs a min-max pair of two unordered elements

Modal - Interface in space.maxus.flare.ui.compose.complex

A modal is a composable that opens an inner frame on click.

Modal.Builder - Interface in space.maxus.flare.ui.compose.complex

A builder for modals

Modal.ModalFrame - Class in space.maxus.flare.ui.compose.complex

The modal frame

Modal.ModalProps - Record Class in space.maxus.flare.ui.compose.complex

ModalFrame(Modal.ModalProps) - Constructor for class space.maxus.flare.ui.compose.complex.Modal.ModalFrame

ModalHandler - Class in space.maxus.flare.handlers

Handles Modal-related logic for Flare

ModalHandler() - Constructor for class space.maxus.flare.handlers.ModalHandler

ModalProps(Modal, Dimensions, String, Consumer<Modal.ModalFrame>) - Constructor for record class space.maxus.flare.ui.compose.complex.Modal.ModalProps

Creates an instance of a ModalProps record class.

Modals - Class in space.maxus.flare.ui.compose.complex

Contains certain utility modals

Modals.YesNoModal - Class in space.maxus.flare.ui.compose.complex

A Yes/No modal

Modals.YesNoModal.YesNoModalBuilder - Class in space.maxus.flare.ui.compose.complex

N

name(String) - Method in class space.maxus.flare.item.ItemStackBuilder

Sets this item name to provided name

name(String) - Method in class space.maxus.flare.ui.compose.complex.Modals.YesNoModal.YesNoModalBuilder

nextPage(Player) - Method in interface space.maxus.flare.ui.page.Pagination

Switches to the next page for the viewer

nextPage(Player) - Method in interface space.maxus.flare.ui.page.PaginationProxy

Switches to the next page for the viewer

nextPageIdx() - Method in class space.maxus.flare.ui.page.DefaultPagination

nextPageIdx() - Method in interface space.maxus.flare.ui.page.Pagination

Increments atomic counter and returns the index of the next page

noop() - Static method in interface space.maxus.flare.ui.compose.Button.ClickHandler

A no-op click handler

notify(V) - Method in class space.maxus.flare.react.SubscriberList

Notifies all listeners of a change

O

of(int, int) - Static method in class space.maxus.flare.ui.space.Slot

Constructs a new slot from row and column

of(Collection<E>, ItemProvider, E) - Static method in interface space.maxus.flare.ui.compose.Selection

Constructs a new selection

of(ItemProvider, Dimensions, Consumer<Modal.ModalFrame>) - Static method in interface space.maxus.flare.ui.compose.complex.Modal

Constructs a new modal

of(ContainerSlot.ContainerEvent, ContainerSlot.ContainerEvent) - Static method in interface space.maxus.flare.ui.compose.ContainerSlot

Constructs a new container slot with handlers

of(Validator.Checker) - Static method in interface space.maxus.flare.util.Validator

Constructs a validator based on a manual checker

of(Collection<E>, Computable<E, String>) - Static method in interface space.maxus.flare.ui.compose.Selection

Constructs a new selection

of(Collection<E>, ItemProvider) - Static method in interface space.maxus.flare.ui.compose.Selection

Constructs a new selection

of(Collection<E>, ItemProvider, int) - Static method in interface space.maxus.flare.ui.compose.Selection

Constructs a new selection

of(List<ItemProvider>, int) - Static method in interface space.maxus.flare.ui.compose.Slideshow

Constructs a new slideshow out of a list of items

of(List<ItemProvider>, int, boolean) - Static method in interface space.maxus.flare.ui.compose.Slideshow

Constructs a new slideshow out of a list of items

of(ItemStack) - Static method in interface space.maxus.flare.ui.compose.Placeholder

Constructs a new placeholder with a still item provider of this item

of(ItemProvider) - Static method in interface space.maxus.flare.ui.compose.Placeholder

Constructs a new placeholder for an item provider

of(ItemProvider) - Static method in interface space.maxus.flare.ui.compose.TextInput

Constructs a new text input with an item provider

of(ItemProvider, boolean) - Static method in interface space.maxus.flare.ui.compose.TextInput

Constructs a new text input with an item provider

of(ItemProvider, ItemProvider) - Static method in interface space.maxus.flare.ui.compose.Checkbox

Creates a new Checkbox with the given checked and unchecked item providers.

of(ItemProvider, ItemProvider) - Static method in interface space.maxus.flare.ui.compose.ProgressBar

Constructs a progress bar with full and empty item providers

of(ItemProvider, ItemProvider, float) - Static method in interface space.maxus.flare.ui.compose.ProgressBar

Constructs a progress bar with full and empty item providers and base progress

of(ItemProvider, ItemProvider, boolean) - Static method in interface space.maxus.flare.ui.compose.Checkbox

Creates a new Checkbox with the given checked and unchecked item providers.

of(ItemProvider, Button.ClickHandler) - Static method in interface space.maxus.flare.ui.compose.Button

Creates a new button

of(PackedComposable...) - Static method in interface space.maxus.flare.ui.compose.complex.Composition

Constructs a composition out of an array of packed composables

of(Pagination<?>) - Static method in interface space.maxus.flare.ui.compose.complex.PaginationDisplay

Creates a new pagination display

of(Pagination<?>) - Static method in interface space.maxus.flare.ui.compose.complex.Tabulation

Constructs a new tabulation

of(Pagination<?>, int) - Static method in interface space.maxus.flare.ui.compose.complex.PaginationDisplay

Creates a new pagination display

of(Pagination<?>, int) - Static method in interface space.maxus.flare.ui.compose.complex.Tabulation

Constructs a new tabulation

of(Pagination<?>, Computable<Pair<Integer, Frame>, ItemStack>, Computable<Pair<Integer, Frame>, ItemStack>, int) - Static method in interface space.maxus.flare.ui.compose.complex.Tabulation

Constructs a new tabulation

of(Slot, Slot) - Static method in class space.maxus.flare.ui.space.Rect

Constructs a new Rect from starting and ending slots.

ofRaw(int) - Static method in class space.maxus.flare.ui.space.Slot

Constructs a new slot from raw coordinate

onAccept(Runnable) - Method in class space.maxus.flare.ui.compose.complex.Modals.YesNoModal.YesNoModalBuilder

onClick(InventoryClickEvent) - Method in class space.maxus.flare.handlers.ClickHandler

onClick(Button.ClickHandler) - Method in interface space.maxus.flare.ui.compose.Button.Builder

Sets the click handler

onClick(PageFrame.SimpleClickHandler) - Method in class space.maxus.flare.ui.page.PageFrame

Adds a generic click handler

onClickCancelling(BiConsumer<Button, InventoryClickEvent>) - Method in interface space.maxus.flare.ui.compose.Button.Builder

Sets the click handler that cancels event

onClose() - Method in class space.maxus.flare.ui.Frame

Called when this frame is closed.

onClose() - Method in class space.maxus.flare.ui.frames.PaginatedFrame

onDecline(Runnable) - Method in class space.maxus.flare.ui.compose.complex.Modals.YesNoModal.YesNoModalBuilder

onDisable() - Method in class space.maxus.flare.Flare

onDrag(InventoryDragEvent) - Method in class space.maxus.flare.handlers.ClickHandler

onDrag(PageFrame.DragHandler) - Method in class space.maxus.flare.ui.page.PageFrame

Adds a drag event handler

onEnable() - Method in class space.maxus.flare.Flare

onLeftClick(Button.ClickHandler) - Method in interface space.maxus.flare.ui.compose.Button.Builder

Sets the left click handler

onLeftClick(PageFrame.BooleanReturningClickHandler) - Method in class space.maxus.flare.ui.page.PageFrame

Adds a left click handler

onLeftClickCancelling(BiConsumer<Button, InventoryClickEvent>) - Method in interface space.maxus.flare.ui.compose.Button.Builder

Sets the left click handler that cancels event

onOpen(Player) - Method in class space.maxus.flare.ui.Frame

Called when this frame is opened to the player

onOpen(Player) - Method in class space.maxus.flare.ui.frames.PaginatedFrame

onPut(ContainerSlot.ContainerEvent) - Method in interface space.maxus.flare.ui.compose.ContainerSlot.Builder

Sets the put handler for this container

onRightClick(Button.ClickHandler) - Method in interface space.maxus.flare.ui.compose.Button.Builder

Sets the right click handler

onRightClick(PageFrame.BooleanReturningClickHandler) - Method in class space.maxus.flare.ui.page.PageFrame

Adds a right click handler

onRightClickCancelling(BiConsumer<Button, InventoryClickEvent>) - Method in interface space.maxus.flare.ui.compose.Button.Builder

Sets the right click handler that cancels event

onShiftClick(Button.ClickHandler) - Method in interface space.maxus.flare.ui.compose.Button.Builder

Sets the shift click handler

onShiftClick(PageFrame.BooleanReturningClickHandler) - Method in class space.maxus.flare.ui.page.PageFrame

Adds a shift click handler

onShiftClickCancelling(BiConsumer<Button, InventoryClickEvent>) - Method in interface space.maxus.flare.ui.compose.Button.Builder

Sets the shift click handler that cancels event

onStateChange(I) - Method in class space.maxus.flare.react.MemoizedReactiveComputable

onStateChange(V) - Method in class space.maxus.flare.item.ReactiveItemProvider

onStateChange(V) - Method in interface space.maxus.flare.react.ReactiveSubscriber

Called whenever value inside a reactive state changes

onTake(ContainerSlot.ContainerEvent) - Method in interface space.maxus.flare.ui.compose.ContainerSlot.Builder

Sets the take handler for this container

onTextChange(ReactiveSubscriber<String>) - Method in interface space.maxus.flare.ui.compose.TextInput

Adds a handler to text change

open(Frame, Player) - Static method in class space.maxus.flare.Flare

open(Player) - Method in class space.maxus.flare.ui.Frame

Opens this frame for the provided player

open(Player) - Method in class space.maxus.flare.ui.page.DefaultPagination

open(Player) - Method in interface space.maxus.flare.ui.page.Pagination

Opens this pagination to player

P

PackedComposable - Class in space.maxus.flare.ui

A data class containing composable and space in which it will be placed

PackedComposable(ComposableSpace, Composable) - Constructor for class space.maxus.flare.ui.PackedComposable

padLore() - Method in class space.maxus.flare.item.ItemStackBuilder

Adds an empty line to this lore

page() - Method in record class space.maxus.flare.ui.page.PageFrame.Props

Returns the value of the page record component.

pageCount() - Method in class space.maxus.flare.ui.page.DefaultPagination

pageCount() - Method in interface space.maxus.flare.ui.page.Pagination

Gets the current count of pages

PageFrame - Class in space.maxus.flare.ui.page

A Frame implementation used within DefaultPagination

PageFrame(PageFrame.Props) - Constructor for class space.maxus.flare.ui.page.PageFrame

PageFrame.BooleanReturningClickHandler - Interface in space.maxus.flare.ui.page

PageFrame.DragHandler - Interface in space.maxus.flare.ui.page

PageFrame.Props - Record Class in space.maxus.flare.ui.page

PageFrame.SimpleClickHandler - Interface in space.maxus.flare.ui.page

pageNumber(Frame, int, boolean, Player) - Static method in interface space.maxus.flare.ui.compose.complex.PaginationDisplay

Returns the item builder for page select button

PaginatedFrame - Class in space.maxus.flare.ui.frames

PaginatedFrame is a simple frame that supports pagination.

PaginatedFrame() - Constructor for class space.maxus.flare.ui.frames.PaginatedFrame

PaginatedFrame(Dimensions) - Constructor for class space.maxus.flare.ui.frames.PaginatedFrame

pagination - Variable in class space.maxus.flare.ui.frames.PaginatedFrame

pagination - Variable in class space.maxus.flare.ui.frames.ParamPaginatedFrame

Pagination<P> - Interface in space.maxus.flare.ui.page

A pagination is used to include multiple sub-frames (pages) inside a single frame

PaginationDisplay - Interface in space.maxus.flare.ui.compose.complex

Pagination display is used to display pagination state.

PaginationDisplay.Builder - Interface in space.maxus.flare.ui.compose.complex

A pagination display builder

PaginationProxy - Interface in space.maxus.flare.ui.page

A proxy interface for better accessibility.

ParamFrame<P> - Class in space.maxus.flare.ui.frames

A simple frame that can take in extra props.

ParamFrame(P) - Constructor for class space.maxus.flare.ui.frames.ParamFrame

ParamFrame(P, Dimensions) - Constructor for class space.maxus.flare.ui.frames.ParamFrame

ParamPaginatedFrame<P> - Class in space.maxus.flare.ui.frames

ParamPaginatedFrame is a simple frame that supports pagination and takes in props.

ParamPaginatedFrame(P) - Constructor for class space.maxus.flare.ui.frames.ParamPaginatedFrame

ParamPaginatedFrame(P, Dimensions) - Constructor for class space.maxus.flare.ui.frames.ParamPaginatedFrame

parent - Variable in class space.maxus.flare.ui.compose.complex.Modal.ModalFrame

The parent modal used

partitionString(String) - Static method in class space.maxus.flare.util.FlareUtil

Partitions a string into chunks of size ~30 characters

partitionString(String, int) - Static method in class space.maxus.flare.util.FlareUtil

Partitions a string into chunks of roughly size length

pause() - Method in class space.maxus.flare.util.PausingTask

Pauses this task with memory effects of VarHandle.setRelease(java.lang.Object...)

PausingTask - Class in space.maxus.flare.util

Represents a bukkit runnable that can be paused and resumed

PausingTask(Runnable) - Constructor for class space.maxus.flare.util.PausingTask

peekPrevious() - Method in class space.maxus.flare.ui.page.DefaultPagination

peekPrevious() - Method in interface space.maxus.flare.ui.page.Pagination

Peeks the previous frame in this pagination

peekPrevious(HumanEntity) - Static method in class space.maxus.flare.ui.PlayerFrameStateManager

Placeholder - Interface in space.maxus.flare.ui.compose

A placeholder is a slot that can not be interacted with.

PlayerFrameStateManager - Class in space.maxus.flare.ui

Utility class + event handler for frame states

PlayerFrameStateManager() - Constructor for class space.maxus.flare.ui.PlayerFrameStateManager

points() - Method in interface space.maxus.flare.ui.space.ComposableSpace

Returns the first and last points of this space.

points() - Method in class space.maxus.flare.ui.space.Rect

points() - Method in class space.maxus.flare.ui.space.SetSpace

points() - Method in class space.maxus.flare.ui.space.Slot

preInit(P) - Method in class space.maxus.flare.ui.frames.ParamFrame

preInit(P) - Method in class space.maxus.flare.ui.frames.ParamPaginatedFrame

previousPage(Player) - Method in interface space.maxus.flare.ui.page.Pagination

Switches to the previous page for the viewer

previousPage(Player) - Method in interface space.maxus.flare.ui.page.PaginationProxy

Switches to the previous page for the viewer

ProgressBar - Interface in space.maxus.flare.ui.compose

A progress bar is a dynamic component that renders progress inside itself.

progressState() - Method in interface space.maxus.flare.ui.compose.ProgressBar

Returns the current progress state

prompt(String) - Method in interface space.maxus.flare.ui.compose.TextInput.Builder

Sets the default prompt

promptState() - Method in interface space.maxus.flare.ui.compose.TextInput

Returns the prompt reactive state

props - Variable in class space.maxus.flare.ui.compose.FunctionComposable

props - Variable in class space.maxus.flare.ui.frames.ParamFrame

props - Variable in class space.maxus.flare.ui.frames.ParamPaginatedFrame

Props(int, String, Dimensions, Map<ComposableSpace, Composable>, Consumer<PageFrame>) - Constructor for record class space.maxus.flare.ui.page.PageFrame.Props

Creates an instance of a Props record class.

provide() - Method in interface space.maxus.flare.item.ItemProvider

Provides an item stack.

provide() - Method in class space.maxus.flare.item.ItemStackBuilder

provide() - Method in class space.maxus.flare.item.ReactiveItemProvider

provide() - Method in class space.maxus.flare.item.StillItemProvider

ProviderRendered - Interface in space.maxus.flare.ui.compose

An interface for components that are implicitly rendered by an item provider

R

rawSlot() - Method in class space.maxus.flare.ui.space.Slot

Gets the raw coordinate of this slot

reactive(Computable<V, ItemStack>) - Static method in interface space.maxus.flare.item.ItemProvider

Constructs a reactive item provider that returns a stack based on provider.

reactive(Computable<T, Component>) - Static method in interface space.maxus.flare.text.ReactiveComponent

Constructs a new non-subscribed empty reactive component

Reactive - Class in space.maxus.flare.react

A utility class for reactivity within Flare.

reactiveBuild(Computable<V, ItemStackBuilder>) - Static method in interface space.maxus.flare.item.ItemProvider

Constructs a reactive item provider that returns a stack based on provider.

ReactiveComponent<V> - Interface in space.maxus.flare.text

A reactive component can be subscribed to a ReactiveState, and will recalculate itself based on state change.

ReactiveException - Exception in space.maxus.flare.react

An exception that happens during a reactive execution.

ReactiveException() - Constructor for exception space.maxus.flare.react.ReactiveException

ReactiveException(String) - Constructor for exception space.maxus.flare.react.ReactiveException

ReactiveException(String, Throwable) - Constructor for exception space.maxus.flare.react.ReactiveException

ReactiveException(Throwable) - Constructor for exception space.maxus.flare.react.ReactiveException

ReactiveInventoryHolder - Class in space.maxus.flare.ui

A Flare reactive inventory holder that is implemented for Flare inventories

ReactiveInventoryHolder(Frame, Callable<Player>, int) - Constructor for class space.maxus.flare.ui.ReactiveInventoryHolder

ReactiveItemProvider<V> - Class in space.maxus.flare.item

An item provider that depends on value of reactive state

ReactiveItemProvider(Computable<V, ItemStack>) - Constructor for class space.maxus.flare.item.ReactiveItemProvider

ReactiveNotifier<V> - Interface in space.maxus.flare.react

An interface for objects that can notify subscribers of changes.

ReactiveState<V> - Class in space.maxus.flare.react

A ReactiveState is a thread-safe wrapper over a value, that can be hooked to, so you can listen to value updates.

ReactiveState() - Constructor for class space.maxus.flare.react.ReactiveState

Constructs a reactive state with no value

ReactiveState(V) - Constructor for class space.maxus.flare.react.ReactiveState

Constructs a reactive state with the given value

ReactiveSubscriber<V> - Interface in space.maxus.flare.react

A subscriber to a reactive state.

ReactivityProvider - Interface in space.maxus.flare.react

ReactivityProvider is an interface that provides access to some utility hooks

Rect - Class in space.maxus.flare.ui.space

A Rect is a ComposableSpace inside a Rectangle defined by first and last points.

Rect(Slot, Slot) - Constructor for class space.maxus.flare.ui.space.Rect

Constructs a new rect with starting and ending slot

reduceBoolStream(Stream<Boolean>, BinaryOperator<Boolean>) - Static method in class space.maxus.flare.util.FlareUtil

Reduces a java stream of Booleans to a single boolean

refreshTitle() - Method in class space.maxus.flare.ui.Frame

Refreshes this title for current viewer.

render() - Method in class space.maxus.flare.ui.Frame

Renders this frame to current inventory

renderAt(Slot) - Method in interface space.maxus.flare.ui.Composable

Renders this component at the provided slot.

renderAt(Slot) - Method in class space.maxus.flare.ui.compose.FunctionComposable

renderAt(Slot) - Method in interface space.maxus.flare.ui.compose.ProviderRendered

renderBarText(float, int, boolean) - Static method in class space.maxus.flare.util.FlareUtil

Renders a progress bar component

renderPart(ComposableSpace) - Method in class space.maxus.flare.ui.Frame

Re-renders part of this frame included inside the provided space

restore() - Method in interface space.maxus.flare.ui.Composable

Restores this composable to its previous state.

restorePreviousState(Player) - Method in class space.maxus.flare.ui.Frame

restoreSnapshot(HumanEntity) - Static method in class space.maxus.flare.ui.PlayerFrameStateManager

resume() - Method in class space.maxus.flare.util.PausingTask

Resumes this task with memory effects of VarHandle.setRelease(java.lang.Object...)

rightClick(InventoryClickEvent) - Method in interface space.maxus.flare.ui.Composable

Called when this component is right clicked inside interface

rightClick(InventoryClickEvent) - Method in interface space.maxus.flare.ui.compose.complex.Composition

rightClick(InventoryClickEvent) - Method in class space.maxus.flare.ui.compose.FunctionComposable

rightClick(Slot, InventoryClickEvent) - Method in class space.maxus.flare.ui.Frame

Called when this frame is right clicked

rightClick(Slot, InventoryClickEvent) - Method in class space.maxus.flare.ui.frames.PaginatedFrame

rightClick(Slot, InventoryClickEvent) - Method in class space.maxus.flare.ui.page.PageFrame

root - Variable in class space.maxus.flare.ui.compose.RootReferencing

The root frame

root() - Method in interface space.maxus.flare.ui.Composable

Returns the frame this component belongs to

root() - Method in class space.maxus.flare.ui.compose.FunctionComposable

root() - Method in class space.maxus.flare.ui.compose.RootReferencing

RootReferencing - Class in space.maxus.flare.ui.compose

An abstract class for component implementations that automatically handles root frame injection

RootReferencing() - Constructor for class space.maxus.flare.ui.compose.RootReferencing

ROW_FIVE - Static variable in class space.maxus.flare.ui.space.Slot

ROW_FIVE_SLOT_EIGHT - Static variable in class space.maxus.flare.ui.space.Slot

ROW_FIVE_SLOT_FIVE - Static variable in class space.maxus.flare.ui.space.Slot

ROW_FIVE_SLOT_FOUR - Static variable in class space.maxus.flare.ui.space.Slot

ROW_FIVE_SLOT_NINE - Static variable in class space.maxus.flare.ui.space.Slot

ROW_FIVE_SLOT_ONE - Static variable in class space.maxus.flare.ui.space.Slot

ROW_FIVE_SLOT_SEVEN - Static variable in class space.maxus.flare.ui.space.Slot

ROW_FIVE_SLOT_SIX - Static variable in class space.maxus.flare.ui.space.Slot

ROW_FIVE_SLOT_THREE - Static variable in class space.maxus.flare.ui.space.Slot

ROW_FIVE_SLOT_TWO - Static variable in class space.maxus.flare.ui.space.Slot

ROW_FOUR - Static variable in class space.maxus.flare.ui.space.Slot

ROW_FOUR_SLOT_EIGHT - Static variable in class space.maxus.flare.ui.space.Slot

ROW_FOUR_SLOT_FIVE - Static variable in class space.maxus.flare.ui.space.Slot

ROW_FOUR_SLOT_FOUR - Static variable in class space.maxus.flare.ui.space.Slot

ROW_FOUR_SLOT_NINE - Static variable in class space.maxus.flare.ui.space.Slot

ROW_FOUR_SLOT_ONE - Static variable in class space.maxus.flare.ui.space.Slot

ROW_FOUR_SLOT_SEVEN - Static variable in class space.maxus.flare.ui.space.Slot

ROW_FOUR_SLOT_SIX - Static variable in class space.maxus.flare.ui.space.Slot

ROW_FOUR_SLOT_THREE - Static variable in class space.maxus.flare.ui.space.Slot

ROW_FOUR_SLOT_TWO - Static variable in class space.maxus.flare.ui.space.Slot

ROW_ONE - Static variable in class space.maxus.flare.ui.space.Slot

ROW_ONE_SLOT_EIGHT - Static variable in class space.maxus.flare.ui.space.Slot

ROW_ONE_SLOT_FIVE - Static variable in class space.maxus.flare.ui.space.Slot

ROW_ONE_SLOT_FOUR - Static variable in class space.maxus.flare.ui.space.Slot

ROW_ONE_SLOT_NINE - Static variable in class space.maxus.flare.ui.space.Slot

ROW_ONE_SLOT_ONE - Static variable in class space.maxus.flare.ui.space.Slot

ROW_ONE_SLOT_SEVEN - Static variable in class space.maxus.flare.ui.space.Slot

ROW_ONE_SLOT_SIX - Static variable in class space.maxus.flare.ui.space.Slot

ROW_ONE_SLOT_THREE - Static variable in class space.maxus.flare.ui.space.Slot

ROW_ONE_SLOT_TWO - Static variable in class space.maxus.flare.ui.space.Slot

ROW_SIX - Static variable in class space.maxus.flare.ui.space.Slot

ROW_SIX_SLOT_EIGHT - Static variable in class space.maxus.flare.ui.space.Slot

ROW_SIX_SLOT_FIVE - Static variable in class space.maxus.flare.ui.space.Slot

ROW_SIX_SLOT_FOUR - Static variable in class space.maxus.flare.ui.space.Slot

ROW_SIX_SLOT_NINE - Static variable in class space.maxus.flare.ui.space.Slot

ROW_SIX_SLOT_ONE - Static variable in class space.maxus.flare.ui.space.Slot

ROW_SIX_SLOT_SEVEN - Static variable in class space.maxus.flare.ui.space.Slot

ROW_SIX_SLOT_SIX - Static variable in class space.maxus.flare.ui.space.Slot

ROW_SIX_SLOT_THREE - Static variable in class space.maxus.flare.ui.space.Slot

ROW_SIX_SLOT_TWO - Static variable in class space.maxus.flare.ui.space.Slot

ROW_THREE - Static variable in class space.maxus.flare.ui.space.Slot

ROW_THREE_SLOT_EIGHT - Static variable in class space.maxus.flare.ui.space.Slot

ROW_THREE_SLOT_FIVE - Static variable in class space.maxus.flare.ui.space.Slot

ROW_THREE_SLOT_FOUR - Static variable in class space.maxus.flare.ui.space.Slot

ROW_THREE_SLOT_NINE - Static variable in class space.maxus.flare.ui.space.Slot

ROW_THREE_SLOT_ONE - Static variable in class space.maxus.flare.ui.space.Slot

ROW_THREE_SLOT_SEVEN - Static variable in class space.maxus.flare.ui.space.Slot

ROW_THREE_SLOT_SIX - Static variable in class space.maxus.flare.ui.space.Slot

ROW_THREE_SLOT_THREE - Static variable in class space.maxus.flare.ui.space.Slot

ROW_THREE_SLOT_TWO - Static variable in class space.maxus.flare.ui.space.Slot

ROW_TWO - Static variable in class space.maxus.flare.ui.space.Slot

ROW_TWO_SLOT_EIGHT - Static variable in class space.maxus.flare.ui.space.Slot

ROW_TWO_SLOT_FIVE - Static variable in class space.maxus.flare.ui.space.Slot

ROW_TWO_SLOT_FOUR - Static variable in class space.maxus.flare.ui.space.Slot

ROW_TWO_SLOT_NINE - Static variable in class space.maxus.flare.ui.space.Slot

ROW_TWO_SLOT_ONE - Static variable in class space.maxus.flare.ui.space.Slot

ROW_TWO_SLOT_SEVEN - Static variable in class space.maxus.flare.ui.space.Slot

ROW_TWO_SLOT_SIX - Static variable in class space.maxus.flare.ui.space.Slot

ROW_TWO_SLOT_THREE - Static variable in class space.maxus.flare.ui.space.Slot

ROW_TWO_SLOT_TWO - Static variable in class space.maxus.flare.ui.space.Slot

run() - Method in class space.maxus.flare.util.PausingTask

S

SafeComputable<I,O> - Interface in space.maxus.flare.util

Represents a computable that handles any errors inside itself

SafeComputable.ComputeInterruptionException - Exception in space.maxus.flare.util

Thrown when error occurs inside SafeComputable

SafeComputable.Wrapper<I,O> - Class in space.maxus.flare.util

safeCompute(I) - Method in interface space.maxus.flare.util.SafeComputable

Safely computes the input, handling any errors inside itself, only throwing a SafeComputable.ComputeInterruptionException if the thread is interrupted

safeCompute(I) - Method in class space.maxus.flare.util.SafeComputable.Wrapper

saveSnapshot(HumanEntity, Frame) - Static method in class space.maxus.flare.ui.PlayerFrameStateManager

selected(int) - Method in interface space.maxus.flare.ui.compose.Selection.Builder

Sets the currently selected item index

selectedFrame() - Method in interface space.maxus.flare.ui.compose.complex.PaginationDisplay

Returns the reactive state of the selected page frame

selectedFrame() - Method in interface space.maxus.flare.ui.compose.complex.Tabulation

Returns selected page frame state

selectedIndex() - Method in interface space.maxus.flare.ui.compose.complex.PaginationDisplay

Returns the reactive state of the selected page index

selectedIndex() - Method in interface space.maxus.flare.ui.compose.complex.Tabulation

Returns selected page index state

selectedIndex(int) - Method in interface space.maxus.flare.ui.compose.complex.PaginationDisplay.Builder

Sets the currently selected page index

selectedItem(E) - Method in interface space.maxus.flare.ui.compose.Selection.Builder

Sets the currently selected item

selectedItemBuilder(int, Frame) - Static method in interface space.maxus.flare.ui.compose.complex.Tabulation

Returns the selected item builder

selectedPage(SafeComputable<Pair<Integer, Frame>, ItemStack>) - Method in interface space.maxus.flare.ui.compose.complex.PaginationDisplay.Builder

Sets the selected page item builder

selectedState() - Method in interface space.maxus.flare.ui.compose.Selection

Returns the selected value reactive state

Selection<E> - Interface in space.maxus.flare.ui.compose

A selection is a component that houses a list of values.

Selection.Builder<E> - Interface in space.maxus.flare.ui.compose

The selection builder

selector(String, String, List<E>, ReactiveState<E>, Computable<E, String>) - Static method in interface space.maxus.flare.ui.compose.Selection

Returns a reactive selector item provider with certain settings

selectorBuilder(String, String, List<E>, E, Computable<E, String>) - Static method in interface space.maxus.flare.ui.compose.Selection

Returns a selector item builder with certain settings

selectorBuilder(String, String, List<E>, E, Computable<E, String>, Player) - Static method in interface space.maxus.flare.ui.compose.Selection

Returns a selector item builder with certain settings

selectorLore(List<E>, E, Computable<E, String>) - Static method in interface space.maxus.flare.ui.compose.Selection

Builds lore list for a selection

self() - Method in record class space.maxus.flare.ui.compose.complex.Modal.ModalProps

Returns the value of the self record component.

selfInventory() - Method in class space.maxus.flare.ui.Frame

Gets the inventory of this frame.

selfInventory() - Method in class space.maxus.flare.ui.frames.PaginatedFrame

selfInventory() - Method in class space.maxus.flare.ui.frames.ParamFrame

selfInventory() - Method in class space.maxus.flare.ui.frames.ParamPaginatedFrame

selfInventory() - Method in class space.maxus.flare.ui.frames.SimpleFrame

set(V) - Method in class space.maxus.flare.react.ReactiveState

Sets the value of this state

set(V) - Method in class space.maxus.flare.ui.ComposableReactiveState

setChecked(boolean) - Method in interface space.maxus.flare.ui.compose.Checkbox

Sets whether the checkbox is checked.

setCurrent(ItemStack) - Method in class space.maxus.flare.item.ReactiveItemProvider

setDimensions(Dimensions) - Method in class space.maxus.flare.ui.frames.ParamPaginatedFrame

setDisabled(boolean) - Method in interface space.maxus.flare.ui.compose.Disable

Sets whether the element is disabled

setFrame(Frame) - Method in class space.maxus.flare.ui.ReactiveInventoryHolder

setHolder(ReactiveInventoryHolder) - Method in class space.maxus.flare.ui.frames.PaginatedFrame

setHolder(ReactiveInventoryHolder) - Method in class space.maxus.flare.ui.frames.ParamFrame

setHolder(ReactiveInventoryHolder) - Method in class space.maxus.flare.ui.frames.SimpleFrame

setHolder(ReactiveInventoryHolder) - Method in class space.maxus.flare.ui.Frame

Sets the holder for this frame This is an internal method, it is only used for frame-switching

setItem(ItemStack) - Method in interface space.maxus.flare.ui.compose.ContainerSlot

Sets the item inside this container

setOpt(Optional<V>) - Method in class space.maxus.flare.react.ReactiveState

Sets the value of this state to the given optional value or null

setPage(int) - Method in class space.maxus.flare.ui.page.DefaultPagination

setPage(int) - Method in interface space.maxus.flare.ui.page.Pagination

Sets current page number

setProgress(float) - Method in interface space.maxus.flare.ui.compose.ProgressBar

Sets the bar progress

setPrompt(String) - Method in interface space.maxus.flare.ui.compose.TextInput

Sets the default prompt

setSelected(int) - Method in interface space.maxus.flare.ui.compose.Selection

Sets the selected value

setSelected(E) - Method in interface space.maxus.flare.ui.compose.Selection

Sets the selected value

SetSpace - Class in space.maxus.flare.ui.space

A pre-defined set of slots

SetSpace(Set<Slot>) - Constructor for class space.maxus.flare.ui.space.SetSpace

setText(String) - Method in interface space.maxus.flare.ui.compose.TextInput

Sets current text

setTitle(Player, String) - Method in class space.maxus.flare.ui.Frame

Sets the title of this frame and broadcasts it to the provided viewer

setTitle(Player, String) - Method in class space.maxus.flare.ui.page.PageFrame

shiftClick(Slot, InventoryClickEvent) - Method in class space.maxus.flare.ui.Frame

Called when this frame is shift clicked

shiftClick(Slot, InventoryClickEvent) - Method in class space.maxus.flare.ui.frames.PaginatedFrame

shiftClick(Slot, InventoryClickEvent) - Method in class space.maxus.flare.ui.page.PageFrame

shiftFrom(InventoryClickEvent) - Method in interface space.maxus.flare.ui.Composable

Called when this component is shift clicked inside interface

shiftFrom(InventoryClickEvent) - Method in interface space.maxus.flare.ui.compose.complex.Composition

shiftFrom(InventoryClickEvent) - Method in class space.maxus.flare.ui.compose.FunctionComposable

shiftInto(ItemStack, InventoryClickEvent) - Method in interface space.maxus.flare.ui.Composable

Called when this component is attempted to put items into by shift click.

shiftInto(ItemStack, InventoryClickEvent) - Method in interface space.maxus.flare.ui.compose.complex.Composition

shiftInto(ItemStack, InventoryClickEvent) - Method in class space.maxus.flare.ui.compose.FunctionComposable

shiftRequest(ItemStack, InventoryClickEvent) - Method in class space.maxus.flare.ui.Frame

Called when this frame is attempted to put items into by shift click.

shiftRequest(ItemStack, InventoryClickEvent) - Method in class space.maxus.flare.ui.frames.PaginatedFrame

SimpleFrame - Class in space.maxus.flare.ui.frames

A simple implementation of Frame

SimpleFrame() - Constructor for class space.maxus.flare.ui.frames.SimpleFrame

SimpleFrame(Dimensions) - Constructor for class space.maxus.flare.ui.frames.SimpleFrame

SimpleInvBoundPrompt - Class in space.maxus.flare.util

SimpleInvBoundPrompt(String, ReactiveState<String>, Inventory) - Constructor for class space.maxus.flare.util.SimpleInvBoundPrompt

SIX_BY_NINE - Enum constant in enum class space.maxus.flare.ui.Dimensions

6x9

Slideshow - Interface in space.maxus.flare.ui.compose

A slideshow is a periodically changing component.

Slot - Class in space.maxus.flare.ui.space

A single slot inside a frame

Slot(int, int) - Constructor for class space.maxus.flare.ui.space.Slot

slots() - Method in interface space.maxus.flare.ui.space.ComposableSpace

Enumerates all slots inside this space

slots() - Method in class space.maxus.flare.ui.space.Rect

slots() - Method in class space.maxus.flare.ui.space.SetSpace

slots() - Method in class space.maxus.flare.ui.space.Slot

space.maxus.flare - package space.maxus.flare

space.maxus.flare.handlers - package space.maxus.flare.handlers

space.maxus.flare.item - package space.maxus.flare.item

space.maxus.flare.react - package space.maxus.flare.react

space.maxus.flare.text - package space.maxus.flare.text

space.maxus.flare.ui - package space.maxus.flare.ui

space.maxus.flare.ui.compose - package space.maxus.flare.ui.compose

space.maxus.flare.ui.compose.complex - package space.maxus.flare.ui.compose.complex

space.maxus.flare.ui.frames - package space.maxus.flare.ui.frames

space.maxus.flare.ui.page - package space.maxus.flare.ui.page

space.maxus.flare.ui.space - package space.maxus.flare.ui.space

space.maxus.flare.util - package space.maxus.flare.util

still(ItemStackBuilder) - Static method in interface space.maxus.flare.item.ItemProvider

Constructs a static item provider that returns the same stack all the time.

still(ItemStack) - Static method in interface space.maxus.flare.item.ItemProvider

Constructs a static item provider that returns the same stack all the time.

StillItemProvider - Class in space.maxus.flare.item

An item provider that constantly returns the same stack.

StillItemProvider(ItemStack) - Constructor for class space.maxus.flare.item.StillItemProvider

subscribe(ReactiveSubscriber<V>) - Method in class space.maxus.flare.react.SubscriberList

Adds a listener to this list

subscribe(S) - Method in interface space.maxus.flare.react.ReactiveNotifier

Subscribes a listener to this notifier

SubscriberList<V> - Class in space.maxus.flare.react

A thread-safe container for multiple ReactiveSubscribers

SubscriberList() - Constructor for class space.maxus.flare.react.SubscriberList

subscribeUpdate(S) - Method in class space.maxus.flare.react.ReactiveState

Subscribes a listener to this state, additionally populating it with current value

switchFrame(Frame) - Method in class space.maxus.flare.ui.Frame

Switches this frame to another frame without reopening inventory.

switchPage(int) - Method in interface space.maxus.flare.ui.compose.complex.PaginationDisplay

Switches to another page index

switchPage(int) - Method in interface space.maxus.flare.ui.compose.complex.Tabulation

Switches current page to the given page

switchPage(Player, int) - Method in class space.maxus.flare.ui.page.DefaultPagination

switchPage(Player, int) - Method in interface space.maxus.flare.ui.page.Pagination

Switches page for viewer to certain index

switchPage(Player, int) - Method in interface space.maxus.flare.ui.page.PaginationProxy

Switches page for viewer to certain index

T

Tabulation - Interface in space.maxus.flare.ui.compose.complex

Tabulation is used to display pagination state.

text(ReactiveState<V>, Computable<V, Component>) - Static method in class space.maxus.flare.react.Reactive

Creates a reactive component from a state and a producer.

text(String) - Static method in class space.maxus.flare.util.FlareUtil

Parses a string into a MiniMessage component

text(String, Player) - Static method in class space.maxus.flare.util.FlareUtil

Parses a sstring into a MiniMessage component with PlaceholderAPI support

TextInput - Interface in space.maxus.flare.ui.compose

A text input is a component that can handle user input.

TextInput.Builder - Interface in space.maxus.flare.ui.compose

The builder for text input

textState() - Method in interface space.maxus.flare.ui.compose.TextInput

Returns the input text reactive state

THREE_BY_NINE - Enum constant in enum class space.maxus.flare.ui.Dimensions

3x9

THREE_BY_THREE - Enum constant in enum class space.maxus.flare.ui.Dimensions

3x3
These dimensions are experimental, and may not work as expected.

title() - Method in record class space.maxus.flare.ui.compose.complex.Modal.ModalProps

Returns the value of the title record component.

title(String) - Method in interface space.maxus.flare.ui.compose.complex.Modal.Builder

Sets the title of the modal frame

toggle() - Method in interface space.maxus.flare.ui.compose.Checkbox

Toggles the checkbox.

toString() - Method in class space.maxus.flare.item.ReactiveItemProvider

toString() - Method in class space.maxus.flare.item.StillItemProvider

toString() - Method in class space.maxus.flare.react.ReactiveState

toString() - Method in class space.maxus.flare.react.SubscriberList

toString() - Method in class space.maxus.flare.ui.compose.complex.Modal.ModalFrame

toString() - Method in record class space.maxus.flare.ui.compose.complex.Modal.ModalProps

Returns a string representation of this record class.

toString() - Method in class space.maxus.flare.ui.compose.complex.Modals.YesNoModal.YesNoModalBuilder

toString() - Method in class space.maxus.flare.ui.PackedComposable

toString() - Method in record class space.maxus.flare.ui.page.PageFrame.Props

Returns a string representation of this record class.

toString() - Method in class space.maxus.flare.ui.page.PageFrame

toString() - Method in class space.maxus.flare.ui.ReactiveInventoryHolder

toString() - Method in class space.maxus.flare.ui.space.Rect

toString() - Method in class space.maxus.flare.ui.space.SetSpace

toString() - Method in class space.maxus.flare.ui.space.Slot

toString() - Method in class space.maxus.flare.util.CompoundValidator

toString() - Method in class space.maxus.flare.util.MinMaxPair

toString() - Method in class space.maxus.flare.util.PausingTask

toString() - Method in class space.maxus.flare.util.SafeComputable.Wrapper

toString() - Method in class space.maxus.flare.util.SimpleInvBoundPrompt

trueClick(Button, InventoryClickEvent) - Method in interface space.maxus.flare.ui.compose.Button.CancellingClickHandler

type(Material) - Method in class space.maxus.flare.item.ItemStackBuilder

Changes item type without fully wiping its meta

U

uncheckedBuilder(String, String) - Static method in interface space.maxus.flare.ui.compose.Checkbox

Standard item builder for checked checkbox

uncheckedItem(ItemProvider) - Method in interface space.maxus.flare.ui.compose.Checkbox.Builder

Sets the unchecked item provider for this checkbox

uncheckedItem(String, String) - Static method in interface space.maxus.flare.ui.compose.Checkbox

Standard item provider for unchecked checkbox

unselectedItemBuilder(int, Frame) - Static method in interface space.maxus.flare.ui.compose.complex.Tabulation

Returns the unselected item builder

unselectedPage(SafeComputable<Pair<Integer, Frame>, ItemStack>) - Method in interface space.maxus.flare.ui.compose.complex.PaginationDisplay.Builder

Sets the unselected page item builder

unsubscribe(ReactiveSubscriber<V>) - Method in class space.maxus.flare.react.SubscriberList

Removes a listener from this list

unsubscribe(S) - Method in interface space.maxus.flare.react.ReactiveNotifier

Unsubscribes a listener from this notifier

useBoundState(V) - Method in interface space.maxus.flare.react.ReactivityProvider

Constructs a new ReactiveState bound to this object
**Experimental**: This is an experimental hook, and it may change or be removed in the future

useBoundState(V) - Method in class space.maxus.flare.ui.Frame

useContext(T) - Method in class space.maxus.flare.ui.Frame

Sets a global context for this frame and its children components

useMemo(ReactiveState<I>, Computable<I, O>) - Method in interface space.maxus.flare.react.ReactivityProvider

Memoizes a Computable, so it is only recalculated on state change.

usePaginationDisplay(ComposableSpace) - Method in interface space.maxus.flare.ui.page.PaginationProxy

Configures a PaginationDisplay inside all page frames

usePaginationDisplay(ComposableSpace, Callable<PaginationDisplay>) - Method in interface space.maxus.flare.ui.page.PaginationProxy

Configures a PaginationDisplay inside all page frames

useState(V) - Method in interface space.maxus.flare.react.ReactivityProvider

Constructs a new ReactiveState

useState(V) - Method in class space.maxus.flare.ui.compose.FunctionComposable

useState(V) - Method in class space.maxus.flare.ui.Frame

useTabulation(ComposableSpace) - Method in interface space.maxus.flare.ui.page.PaginationProxy

Configures a Tabulation inside all page frames

useTabulation(ComposableSpace, Callable<Tabulation>) - Method in interface space.maxus.flare.ui.page.PaginationProxy

Configures a Tabulation inside all page frames

useTitle(String) - Method in class space.maxus.flare.ui.page.PageFrame

Sets the default title of this page

useUnboundState(V) - Method in interface space.maxus.flare.react.ReactivityProvider

Constructs a new ReactiveState that is **explicitly** not bound to this object

useUnboundState(V) - Method in class space.maxus.flare.ui.compose.FunctionComposable

V

valid(String) - Method in interface space.maxus.flare.util.Validator.Checker

Checks if a string is valid

validate(Validator) - Method in interface space.maxus.flare.ui.compose.TextInput.Builder

Adds a validator for text input

ValidatingInvBoundPrompt - Class in space.maxus.flare.util

ValidatingInvBoundPrompt(Validator, String, ReactiveState<String>, Inventory) - Constructor for class space.maxus.flare.util.ValidatingInvBoundPrompt

Validator - Interface in space.maxus.flare.util

An interface that is used to validate text input

Validator.Checker - Interface in space.maxus.flare.util

A functional interface that is used to check if a string is valid

Validators - Class in space.maxus.flare.util

Contains several pre-made utility validators

valueOf(String) - Static method in enum class space.maxus.flare.ui.Dimensions

Returns the enum constant of this class with the specified name.

values() - Static method in enum class space.maxus.flare.ui.Dimensions

Returns an array containing the constants of this enum class, in the order they are declared.

viewer() - Method in interface space.maxus.flare.ui.Composable

Gets the current viewer of this composable

W

withLore(Material, String) - Static method in class space.maxus.flare.item.Items

Constructs a new item stack with provided lore

withMeta(Material, Consumer<ItemMeta>) - Static method in class space.maxus.flare.item.Items

Constructs a new item with provided material and meta.

withName(Material, String) - Static method in class space.maxus.flare.item.Items

Constructs a new item stack with provided lore

withName(Material, String, Player) - Static method in class space.maxus.flare.item.Items

Constructs a new item stack with provided lore

withTypedMeta(Material, Consumer<M>) - Static method in class space.maxus.flare.item.Items

Constructs a new item with provided material and meta of certain type.

wrap(Computable<I, O>) - Static method in interface space.maxus.flare.util.SafeComputable

Wrapper(Computable<I, O>) - Constructor for class space.maxus.flare.util.SafeComputable.Wrapper

A B C D E F G H I K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form