Package space.maxus.flare.ui.frames

Class SimpleFrame

java.lang.Object

space.maxus.flare.ui.Frame

space.maxus.flare.ui.frames.SimpleFrame

All Implemented Interfaces:

ReactivityProvider

public abstract class SimpleFrame
extends Frame

A simple implementation of Frame

Field Summary

Fields

Modifier and Type	Field	Description
protected final @NotNull Dimensions	dimensions
protected @NotNull ReactiveInventoryHolder	holder

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

composed, isDirty

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SimpleFrame()
	SimpleFrame(@NotNull Dimensions dimensions)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
@NotNull Dimensions	getDimensions()	Gets the dimensions of this frame's inventory
@NotNull ReactiveInventoryHolder	getHolder()	Gets the Flare InventoryHolder for this frame
int	hashCode()
abstract void	init()	Called once inside the constructor
@NotNull org.bukkit.inventory.Inventory	selfInventory()	Gets the inventory of this frame.
void	setHolder(@NotNull ReactiveInventoryHolder holder)	Sets the holder for this frame This is an internal method, it is only used for frame-switching

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

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

Methods inherited from class java.lang.Object

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

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

useMemo, useUnboundState

Field Details

dimensions

@NotNull
protected final @NotNull Dimensions dimensions

holder

@NotNull
protected @NotNull ReactiveInventoryHolder holder

Constructor Details

SimpleFrame

protected SimpleFrame()

SimpleFrame

public SimpleFrame(@NotNull
 @NotNull Dimensions dimensions)

Method Details

init

public abstract void init()

Description copied from class: Frame

Called once inside the constructor

Specified by:

init in class Frame

selfInventory

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

Description copied from class: Frame

Gets the inventory of this frame.

Specified by:

selfInventory in class Frame

Returns:

the inventory of this frame.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDimensions

@NotNull
public @NotNull Dimensions getDimensions()

Description copied from class: Frame

Gets the dimensions of this frame's inventory

Specified by:

getDimensions in class Frame

Returns:

the dimensions of this frame's inventory

getHolder

@NotNull
public @NotNull ReactiveInventoryHolder getHolder()

Description copied from class: Frame

Gets the Flare InventoryHolder for this frame

Specified by:

getHolder in class Frame

Returns:

Flare InventoryHolder

setHolder

public void setHolder(@NotNull
 @NotNull ReactiveInventoryHolder holder)

Description copied from class: Frame

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

Specified by:

setHolder in class Frame

Parameters:

holder - Holder to be set