Skip navigation links
A B C D E F G H I J L M N O P R S T U V W 

A

AbstractStateValue - Class in me.devnatan.inventoryframework.state
This is an internal inventory-framework API that should not be used from outside of this library.
AbstractStateValue(State<?>) - Constructor for class me.devnatan.inventoryframework.state.AbstractStateValue
 
accept(C, B, int, V) - Method in interface me.devnatan.inventoryframework.component.PaginationValueConsumer
Performs this operation on the given arguments.
addComponent(Component) - Method in interface me.devnatan.inventoryframework.context.IFContext
Adds a new component to this context.
addLayoutSlot(LayoutSlot) - Method in interface me.devnatan.inventoryframework.context.IFRenderContext
This is an internal inventory-framework API that should not be used from outside of this library.
addPhase(PipelinePhase) - Method in class me.devnatan.inventoryframework.pipeline.Pipeline
 
addViewer(Viewer) - Method in interface me.devnatan.inventoryframework.context.IFContext
Adds a new viewer to this context.
advance() - Method in interface me.devnatan.inventoryframework.component.Pagination
Advances to the next page if available.
ANVIL - Static variable in class me.devnatan.inventoryframework.ViewType
 
apply(ViewConfigBuilder, IFContext) - Method in interface me.devnatan.inventoryframework.ViewConfig.Modifier
Applies this modifier to a given configuration.
assign(Object) - Method in interface me.devnatan.inventoryframework.Ref
This is an internal inventory-framework API that should not be used from outside of this library.

B

back() - Method in interface me.devnatan.inventoryframework.component.Pagination
Backs to the previous page if available.
back() - Method in interface me.devnatan.inventoryframework.context.IFConfinedContext
Goes back to the previous view, does nothing if there's no views to back to.
back(Object) - Method in interface me.devnatan.inventoryframework.context.IFConfinedContext
Goes back to the previous view, does nothing if there's no views to back to.
BEACON - Static variable in class me.devnatan.inventoryframework.ViewType
 
BLAST_FURNACE - Static variable in class me.devnatan.inventoryframework.ViewType
 
BREWING_STAND - Static variable in class me.devnatan.inventoryframework.ViewType
 
build() - Method in class me.devnatan.inventoryframework.component.PaginationStateBuilder
Builds a pagination state based on this builder values.
build() - Method in class me.devnatan.inventoryframework.ViewConfigBuilder
 
buildComputedAsyncPaginationState(Function<Context, CompletableFuture<List<T>>>) - Method in interface me.devnatan.inventoryframework.state.StateAccess
Creates a new unmodifiable computed pagination state builder with asynchronous data source.
buildComputedPaginationState(Function<Context, List<? super T>>) - Method in interface me.devnatan.inventoryframework.state.StateAccess
Creates a new unmodifiable dynamic pagination state builder.
buildLazyAsyncPaginationState(Function<Context, CompletableFuture<List<T>>>) - Method in interface me.devnatan.inventoryframework.state.StateAccess
Creates a new unmodifiable lazy pagination state builder with asynchronous data source.
buildLazyPaginationState(Supplier<List<? super T>>) - Method in interface me.devnatan.inventoryframework.state.StateAccess
Creates a new unmodifiable lazy pagination state builder.
buildLazyPaginationState(Function<Context, List<? super T>>) - Method in interface me.devnatan.inventoryframework.state.StateAccess
Creates a new unmodifiable lazy pagination state builder.
buildPaginationState(List<? super T>) - Method in interface me.devnatan.inventoryframework.state.StateAccess
Creates a new unmodifiable static pagination state builder.

C

canAdvance() - Method in interface me.devnatan.inventoryframework.component.Pagination
Checks for pages to advance.
canBack() - Method in interface me.devnatan.inventoryframework.component.Pagination
Checks for pages to back.
canBack() - Method in interface me.devnatan.inventoryframework.context.IFConfinedContext
Verifies if there's any view to back to.
cancel() - Method in interface me.devnatan.inventoryframework.internal.Job
Cancels this job if started.
CANCEL_ON_CLICK - Static variable in class me.devnatan.inventoryframework.ViewConfig
 
CANCEL_ON_DRAG - Static variable in class me.devnatan.inventoryframework.ViewConfig
 
CANCEL_ON_DROP - Static variable in class me.devnatan.inventoryframework.ViewConfig
 
CANCEL_ON_PICKUP - Static variable in class me.devnatan.inventoryframework.ViewConfig
 
cancelOnClick() - Method in interface me.devnatan.inventoryframework.component.ComponentBuilder
Determines whether an actor's click interaction event under this component should be canceled.
cancelOnClick() - Method in class me.devnatan.inventoryframework.ViewConfigBuilder
 
cancelOnDrag() - Method in class me.devnatan.inventoryframework.ViewConfigBuilder
Cancels any item drag into the view.
cancelOnDrop() - Method in class me.devnatan.inventoryframework.ViewConfigBuilder
Cancels any item drops by the player while the view is open.
cancelOnPickup() - Method in class me.devnatan.inventoryframework.ViewConfigBuilder
Cancels any item pickup by the player while the view is open.
canPlayerInteractOn(int) - Method in class me.devnatan.inventoryframework.ViewType
 
changeTitle(String, Viewer) - Method in interface me.devnatan.inventoryframework.ViewContainer
 
CHEST - Static variable in class me.devnatan.inventoryframework.ViewType
 
clear(IFContext) - Method in interface me.devnatan.inventoryframework.component.Component
Clears this component from the given context.
clear(IFContext) - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
clear() - Method in interface me.devnatan.inventoryframework.context.IFSlotRenderContext
Clears this slot from the current context.
CLICK - Static variable in class me.devnatan.inventoryframework.pipeline.StandardPipelinePhases
Called when a click is detected in a context.
clicked(Component, IFSlotClickContext) - Method in interface me.devnatan.inventoryframework.component.InteractionHandler
Called when a component is clicked.
clicked(Component, IFSlotClickContext) - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
CLOSE - Static variable in class me.devnatan.inventoryframework.pipeline.StandardPipelinePhases
Called when a context is closed for a viewer.
close() - Method in interface me.devnatan.inventoryframework.ViewContainer
 
close(Viewer) - Method in interface me.devnatan.inventoryframework.ViewContainer
 
close() - Method in interface me.devnatan.inventoryframework.Viewer
Closes the current container that this viewer is currently viewing.
closeForEveryone() - Method in interface me.devnatan.inventoryframework.context.IFContext
Closes this context's container to all viewers who are viewing it.
closeForPlayer() - Method in interface me.devnatan.inventoryframework.context.IFConfinedContext
Closes this context's container for the player in the current scope of execution.
closeOnClick() - Method in interface me.devnatan.inventoryframework.component.ComponentBuilder
Closes the current container when an actor interacts with this component.
Component - Interface in me.devnatan.inventoryframework.component
A component represents one or more items within a VirtualView.
ComponentBuilder<S extends ComponentBuilder<S,C>,C extends IFContext> - Interface in me.devnatan.inventoryframework.component
Builder base for any Component implementation.
ComponentComposition - Interface in me.devnatan.inventoryframework.component
A component whose is composed of multiple components.
ComponentContainer - Interface in me.devnatan.inventoryframework.component
 
ComponentFactory - Interface in me.devnatan.inventoryframework.component
Factory for Component interface.
computedAsyncPaginationState(Function<Context, CompletableFuture<List<T>>>, PaginationValueConsumer<Context, ItemBuilder, T>) - Method in interface me.devnatan.inventoryframework.state.StateAccess
Creates a new unmodifiable computed pagination state with asynchronous data source.
computedPaginationState(Function<Context, List<? super T>>, PaginationValueConsumer<Context, ItemBuilder, T>) - Method in interface me.devnatan.inventoryframework.state.StateAccess
Creates a new unmodifiable computed pagination state.
computedState(Function<Context, T>) - Method in interface me.devnatan.inventoryframework.state.StateAccess
Creates an immutable computed state.
computedState(Supplier<T>) - Method in interface me.devnatan.inventoryframework.state.StateAccess
Creates an immutable computed state.
copy() - Method in interface me.devnatan.inventoryframework.component.ComponentBuilder
Returns a copy of this component builder.
CRAFTING_TABLE - Static variable in class me.devnatan.inventoryframework.ViewType
 
create() - Method in interface me.devnatan.inventoryframework.component.ComponentFactory
Creates a new component.
create(Pagination, int, int, V) - Method in interface me.devnatan.inventoryframework.component.PaginationElementFactory
 
create(StateValueHost, State<?>) - Method in interface me.devnatan.inventoryframework.state.StateValueFactory
Creates a new value for the given host and state.
createCloseContext(Viewer, IFRenderContext) - Method in class me.devnatan.inventoryframework.internal.ElementFactory
Creates a new close context for the current platform.
createComponentBuilder(VirtualView) - Method in class me.devnatan.inventoryframework.internal.ElementFactory
Creates a new platform builder instance.
createContainer(IFContext) - Method in class me.devnatan.inventoryframework.internal.ElementFactory
Create a new current platform container for the specified context.
createOpenContext(RootView, Viewer, List<Viewer>, Object) - Method in class me.devnatan.inventoryframework.internal.ElementFactory
 
createOption(String, T) - Static method in class me.devnatan.inventoryframework.ViewConfig
 
createRenderContext(UUID, RootView, ViewConfig, ViewContainer, Map<String, Viewer>, Viewer, Object) - Method in class me.devnatan.inventoryframework.internal.ElementFactory
 
createSlotClickContext(int, Viewer, ViewContainer, Component, Object) - Method in class me.devnatan.inventoryframework.internal.ElementFactory
 
createSlotRenderContext(int, IFRenderContext, Viewer) - Method in class me.devnatan.inventoryframework.internal.ElementFactory
 
createUninitializedRoot() - Method in class me.devnatan.inventoryframework.internal.ElementFactory
Creates a new root view for the current platform.
createViewer(Object, IFRenderContext) - Method in class me.devnatan.inventoryframework.internal.ElementFactory
 
currentPage() - Method in interface me.devnatan.inventoryframework.component.Pagination
The current page number.
currentPageIndex() - Method in interface me.devnatan.inventoryframework.component.Pagination
The index of the current page.

D

debug(Supplier<String>, Object...) - Static method in class me.devnatan.inventoryframework.IFDebug
Prints a message if debug is enabled.
debug(String, Object...) - Static method in class me.devnatan.inventoryframework.IFDebug
Prints a message if debug is enabled.
debug(String) - Method in interface me.devnatan.inventoryframework.logging.Logger
 
decrement(StateValueHost) - Method in interface me.devnatan.inventoryframework.state.MutableIntState
Decrements the current state value by 1.
defaultValue() - Method in interface me.devnatan.inventoryframework.ViewConfig.Option
 
DISPENSER - Static variable in class me.devnatan.inventoryframework.ViewType
 
displayIf(BooleanSupplier) - Method in interface me.devnatan.inventoryframework.component.ComponentBuilder
Only shows the component if a given condition is satisfied.
displayIf(Predicate<C>) - Method in interface me.devnatan.inventoryframework.component.ComponentBuilder
Only shows the component if a given condition is satisfied.
DROPPER - Static variable in class me.devnatan.inventoryframework.ViewType
 

E

elementFactory(PaginationValueConsumer<Context, Builder, V>) - Method in class me.devnatan.inventoryframework.component.PaginationStateBuilder
Sets the item factory for pagination.
ElementFactory - Class in me.devnatan.inventoryframework.internal
Element creation factory for the current platform.
ElementFactory() - Constructor for class me.devnatan.inventoryframework.internal.ElementFactory
 
equals(Object) - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
equals(Object) - Method in class me.devnatan.inventoryframework.internal.LayoutSlot
 
equals(Object) - Method in class me.devnatan.inventoryframework.ViewConfig
 
equals(Object) - Method in class me.devnatan.inventoryframework.ViewType
 
error(String) - Method in interface me.devnatan.inventoryframework.logging.Logger
 
execute(S) - Method in class me.devnatan.inventoryframework.pipeline.Pipeline
 
execute(PipelinePhase, S) - Method in class me.devnatan.inventoryframework.pipeline.Pipeline
 
execute(S) - Method in class me.devnatan.inventoryframework.pipeline.PipelineContext
 

F

factory() - Method in interface me.devnatan.inventoryframework.state.State
The value factory of this state.
Feature<C,R,F> - Interface in me.devnatan.inventoryframework.feature
A feature is a module that is installed in the runtime and acts independently of the rest of the platform.
Feature.Keys - Class in me.devnatan.inventoryframework.feature
 
FeatureInstaller<P> - Interface in me.devnatan.inventoryframework.feature
A feature installer stores information about installed features, installs features and ensures that they are not initialized multiple times.
FILLED_RESERVED_CHAR - Static variable in class me.devnatan.inventoryframework.internal.LayoutSlot
 
finish() - Method in class me.devnatan.inventoryframework.pipeline.PipelineContext
Finishes current pipeline execution
FIRST_RENDER - Static variable in class me.devnatan.inventoryframework.pipeline.StandardPipelinePhases
Called when a context is going to be rendered.
forceUpdate() - Method in interface me.devnatan.inventoryframework.component.Component
Forces this component to be updated.
forceUpdate() - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
forceUpdate() - Method in interface me.devnatan.inventoryframework.component.Pagination
Forces the pagination to update everything internally ignoring everything, including lazy data source to be computed again.
FURNACE - Static variable in class me.devnatan.inventoryframework.ViewType
 

G

get() - Method in class me.devnatan.inventoryframework.state.AbstractStateValue
 
get(StateValueHost) - Method in interface me.devnatan.inventoryframework.state.State
Gets the current value for this state defined in the specified host.
get() - Method in interface me.devnatan.inventoryframework.state.StateValue
The current state value.
getActiveContext() - Method in interface me.devnatan.inventoryframework.Viewer
This is an internal inventory-framework API that should not be used from outside of this library.
getAsyncOpenJob() - Method in interface me.devnatan.inventoryframework.context.IFOpenContext
The task that will run before this context transitions from opening to rendering context.
getAvailableSlotFactory() - Method in interface me.devnatan.inventoryframework.context.IFRenderContext
This is an internal inventory-framework API that should not be used from outside of this library.
getCharacter() - Method in class me.devnatan.inventoryframework.internal.LayoutSlot
 
getClickedContainer() - Method in interface me.devnatan.inventoryframework.context.IFSlotClickContext
 
getClickedSlot() - Method in interface me.devnatan.inventoryframework.context.IFSlotClickContext
 
getClickHandler() - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
getClickIdentifier() - Method in interface me.devnatan.inventoryframework.context.IFSlotClickContext
The click identifier, available only in cases where the library does not cover all types of clicks, so you can discover the type of click through its identifier.
getColumns() - Method in class me.devnatan.inventoryframework.ViewType
 
getColumnsCount() - Method in interface me.devnatan.inventoryframework.ViewContainer
The amount of vertical lines present in the container.
getComponent() - Method in interface me.devnatan.inventoryframework.context.IFSlotClickContext
 
getComponentFactories() - Method in interface me.devnatan.inventoryframework.context.IFRenderContext
This is an internal inventory-framework API that should not be used from outside of this library.
getComponents() - Method in interface me.devnatan.inventoryframework.component.ComponentContainer
All components in this container.
getComponentsAt(int) - Method in interface me.devnatan.inventoryframework.context.IFContext
Gets the component that is at a certain position.
getConfig() - Method in interface me.devnatan.inventoryframework.context.IFContext
The configuration for this context.
getConfig() - Method in interface me.devnatan.inventoryframework.RootView
The configuration for this view.
getContainer() - Method in interface me.devnatan.inventoryframework.context.IFCloseContext
The container of this context.
getContainer() - Method in interface me.devnatan.inventoryframework.context.IFOpenContext
This is an internal inventory-framework API that should not be used from outside of this library.
getContainer() - Method in interface me.devnatan.inventoryframework.context.IFRenderContext
The container of this context.
getContainer() - Method in interface me.devnatan.inventoryframework.context.IFSlotContext
The container of this context.
getElementFactory() - Method in interface me.devnatan.inventoryframework.RootView
The ElementFactory for this view.
getFactory() - Method in class me.devnatan.inventoryframework.internal.LayoutSlot
 
getFirstSlot() - Method in interface me.devnatan.inventoryframework.ViewContainer
Returns the position of the first slot of this container.
getId() - Method in interface me.devnatan.inventoryframework.context.IFContext
An unique id for this context.
getId() - Method in class me.devnatan.inventoryframework.state.AbstractStateValue
 
getId() - Method in interface me.devnatan.inventoryframework.state.StateValue
The id of this state on its current host.
getId() - Method in interface me.devnatan.inventoryframework.Viewer
Unique identifier for this viewer used for indexing.
getIdentifier() - Method in class me.devnatan.inventoryframework.ViewType
 
getIndexedViewers() - Method in interface me.devnatan.inventoryframework.context.IFContext
A Map containing all viewers in that context.
getInitialData() - Method in interface me.devnatan.inventoryframework.context.IFContext
Data defined when a context is created, usually this is data set when the context is opened for a viewer.
getInitialTitle() - Method in interface me.devnatan.inventoryframework.context.IFContext
The initial title of this context, that is, even if it has been changed, it will return the title that has been initially defined.
getInstalledFeatures() - Method in interface me.devnatan.inventoryframework.feature.FeatureInstaller
All the features that have already been installed through this installer.
getInteractionDelayInMillis() - Method in class me.devnatan.inventoryframework.ViewConfig
 
getInteractionDelayInMillis() - Method in class me.devnatan.inventoryframework.ViewConfigBuilder
 
getInteractionHandler() - Method in interface me.devnatan.inventoryframework.component.Component
The interaction handler for this component.
getInteractionHandler() - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
getInternalComponents() - Method in interface me.devnatan.inventoryframework.component.ComponentContainer
This is an internal inventory-framework API that should not be used from outside of this library.
getInternalContexts() - Method in interface me.devnatan.inventoryframework.RootView
All contexts linked to this view.
getInternalStateValue(State<?>) - Method in interface me.devnatan.inventoryframework.state.StateValueHost
This is an internal inventory-framework API that should not be used from outside of this library.
getKey() - Method in interface me.devnatan.inventoryframework.component.Component
This is an internal inventory-framework API that should not be used from outside of this library.
getKey() - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
getLastInteractionInMillis() - Method in interface me.devnatan.inventoryframework.Viewer
This is an internal inventory-framework API that should not be used from outside of this library.
getLastSlot() - Method in interface me.devnatan.inventoryframework.ViewContainer
Returns the position of the last slot of this container.
getLayout() - Method in class me.devnatan.inventoryframework.ViewConfig
 
getLayout() - Method in class me.devnatan.inventoryframework.ViewConfigBuilder
 
getLayoutSlots() - Method in interface me.devnatan.inventoryframework.context.IFRenderContext
This is an internal inventory-framework API that should not be used from outside of this library.
getLayoutTarget() - Method in interface me.devnatan.inventoryframework.component.Pagination
Layout target character that determines the boundary positions that this component should be rendered.
getLayoutTarget() - Method in class me.devnatan.inventoryframework.component.PaginationStateBuilder
 
getLogger() - Method in class me.devnatan.inventoryframework.internal.ElementFactory
 
getMaxSize() - Method in class me.devnatan.inventoryframework.ViewType
 
getMetadata() - Method in interface me.devnatan.inventoryframework.RootView
 
getModifiedConfig() - Method in interface me.devnatan.inventoryframework.context.IFOpenContext
This is an internal inventory-framework API that should not be used from outside of this library.
getModifiers() - Method in class me.devnatan.inventoryframework.ViewConfig
 
getModifiers() - Method in class me.devnatan.inventoryframework.ViewConfigBuilder
 
getName() - Method in class me.devnatan.inventoryframework.pipeline.PipelinePhase
The pipeline phase name.
getOptions() - Method in class me.devnatan.inventoryframework.ViewConfig
 
getOptions() - Method in class me.devnatan.inventoryframework.ViewConfigBuilder
 
getOptionValue(ViewConfig.Option<T>) - Method in class me.devnatan.inventoryframework.ViewConfig
 
getPageSwitchHandler() - Method in class me.devnatan.inventoryframework.component.PaginationStateBuilder
 
getPaginationElementFactory() - Method in class me.devnatan.inventoryframework.component.PaginationStateBuilder
 
getParent() - Method in interface me.devnatan.inventoryframework.context.IFCloseContext
This is an internal inventory-framework API that should not be used from outside of this library.
getParent() - Method in interface me.devnatan.inventoryframework.context.IFSlotContext
The parent context of this context.
getPhase() - Method in class me.devnatan.inventoryframework.pipeline.PipelineContext
 
getPipeline() - Method in interface me.devnatan.inventoryframework.RootView
The execution pipeline for this view.
getPlatform() - Method in interface me.devnatan.inventoryframework.feature.FeatureInstaller
The platform of this installer.
getPosition() - Method in interface me.devnatan.inventoryframework.component.Component
The current position of this component relative to its root view.
getPosition() - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
getPositions() - Method in class me.devnatan.inventoryframework.internal.LayoutSlot
 
getPrefix() - Method in interface me.devnatan.inventoryframework.logging.Logger
 
getPreviousContext() - Method in interface me.devnatan.inventoryframework.Viewer
This is an internal inventory-framework API that should not be used from outside of this library.
getRawStateValue(State<?>) - Method in interface me.devnatan.inventoryframework.state.StateValueHost
Returns the internal value of a state.
getReference() - Method in interface me.devnatan.inventoryframework.component.Component
Returns the reference assigned to this component.
getReference() - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
getRenderHandler() - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
getResult() - Method in interface me.devnatan.inventoryframework.context.IFSlotRenderContext
 
getResultSlots() - Method in class me.devnatan.inventoryframework.ViewType
 
getRoot() - Method in interface me.devnatan.inventoryframework.component.Component
The root of this component.
getRoot() - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
getRoot() - Method in interface me.devnatan.inventoryframework.context.IFContext
View root from which this context originated.
getRows() - Method in class me.devnatan.inventoryframework.ViewType
 
getRowsCount() - Method in interface me.devnatan.inventoryframework.ViewContainer
The amount of horizontal lines present in the container.
getScheduledUpdateJob() - Method in interface me.devnatan.inventoryframework.RootView
This is an internal inventory-framework API that should not be used from outside of this library.
getSelfContainer() - Method in interface me.devnatan.inventoryframework.Viewer
An implementation of ViewContainer for the container of this viewer.
getSize() - Method in class me.devnatan.inventoryframework.ViewConfig
 
getSize() - Method in class me.devnatan.inventoryframework.ViewConfigBuilder
 
getSize() - Method in interface me.devnatan.inventoryframework.ViewContainer
The number of slots in this container.
getSlot() - Method in interface me.devnatan.inventoryframework.context.IFSlotContext
Returns the slot position of this context in the current container.
getSlotsCount() - Method in interface me.devnatan.inventoryframework.ViewContainer
The number of slot indexes in this container (available or not).
getSourceProvider() - Method in class me.devnatan.inventoryframework.component.PaginationStateBuilder
 
getStack() - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
getState() - Method in class me.devnatan.inventoryframework.state.AbstractStateValue
 
getState() - Method in interface me.devnatan.inventoryframework.state.StateValue
The state who holds this value.
getStateValues() - Method in interface me.devnatan.inventoryframework.state.StateValueHost
This is an internal inventory-framework API that should not be used from outside of this library.
getTitle() - Method in class me.devnatan.inventoryframework.ViewConfig
 
getTitle() - Method in class me.devnatan.inventoryframework.ViewConfigBuilder
 
getTitle() - Method in interface me.devnatan.inventoryframework.ViewContainer
 
getTitle(Viewer) - Method in interface me.devnatan.inventoryframework.ViewContainer
 
getType() - Method in class me.devnatan.inventoryframework.ViewConfig
 
getType() - Method in class me.devnatan.inventoryframework.ViewConfigBuilder
 
getType() - Method in interface me.devnatan.inventoryframework.ViewContainer
The type of this container.
getUninitializedStateValue(long) - Method in interface me.devnatan.inventoryframework.state.StateValueHost
This is an internal inventory-framework API that should not be used from outside of this library.
getUniqueId() - Method in interface me.devnatan.inventoryframework.RootView
The unique identifier of this view.
getUpdateHandler() - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
getUpdateIntervalInTicks() - Method in class me.devnatan.inventoryframework.ViewConfig
 
getUpdateIntervalInTicks() - Method in class me.devnatan.inventoryframework.ViewConfigBuilder
 
getViewer() - Method in interface me.devnatan.inventoryframework.context.IFConfinedContext
The viewer in current scope of execution.
getViewers() - Method in interface me.devnatan.inventoryframework.context.IFContext
An unmodifiable copy of all viewers that are tied to this context.
getWatching() - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
getWatchingStates() - Method in interface me.devnatan.inventoryframework.component.Component
An unmodifiable set of all states that this component is watching.
getWatchingStates() - Method in class me.devnatan.inventoryframework.component.ItemComponent
 

H

hasChanged() - Method in interface me.devnatan.inventoryframework.context.IFSlotRenderContext
Checks if the item in this context has been changed.
hashCode() - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
hashCode() - Method in class me.devnatan.inventoryframework.internal.LayoutSlot
 
hashCode() - Method in class me.devnatan.inventoryframework.ViewConfig
 
hashCode() - Method in class me.devnatan.inventoryframework.ViewType
 
hasItem(int) - Method in interface me.devnatan.inventoryframework.ViewContainer
Returns whether a container slot is filled by an item.
hasPage(int) - Method in interface me.devnatan.inventoryframework.component.Pagination
Checks if a page exists.
hasPhase(PipelinePhase) - Method in class me.devnatan.inventoryframework.pipeline.Pipeline
 
hide() - Method in interface me.devnatan.inventoryframework.component.Component
Hides this component.
hide() - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
hideIf(BooleanSupplier) - Method in interface me.devnatan.inventoryframework.component.ComponentBuilder
Hides the component if a given condition is satisfied.
hideIf(Predicate<C>) - Method in interface me.devnatan.inventoryframework.component.ComponentBuilder
Hides the component if a given condition is satisfied.
HOPPER - Static variable in class me.devnatan.inventoryframework.ViewType
 

I

ids - Static variable in interface me.devnatan.inventoryframework.state.State
 
IFCloseContext - Interface in me.devnatan.inventoryframework.context
 
IFConfinedContext - Interface in me.devnatan.inventoryframework.context
A confined context is a context derivation wholly subordinated to a parent context that represents a closed scope of execution containing only one viewer, that is, when a player interacts with an item and throws a click event a subordinate confined context with that player as Viewer of a IFSlotClickContext is launched.
IFContext - Interface in me.devnatan.inventoryframework.context
 
IFDebug - Class in me.devnatan.inventoryframework
This is an internal inventory-framework API that should not be used from outside of this library.
IFOpenContext - Interface in me.devnatan.inventoryframework.context
This context is created before the container is opened, it is used for cancellation by previously defined data also can be used to change the title and size of the container before the rendering intent.
IFRenderContext - Interface in me.devnatan.inventoryframework.context
 
IFSlotClickContext - Interface in me.devnatan.inventoryframework.context
The click context represents an interaction between the actor and the container, even if an item is not present, it stores information about the click, and it's origin.
IFSlotContext - Interface in me.devnatan.inventoryframework.context
Represents a context in which there is a specific slot related to it, the main context encompasses the entire container in an actor's view, the ViewSlotContext encapsulates a context for just one slot of a container.
IFSlotRenderContext - Interface in me.devnatan.inventoryframework.context
 
IllegalStateModificationException - Exception in me.devnatan.inventoryframework.state
 
IllegalStateModificationException(String) - Constructor for exception me.devnatan.inventoryframework.state.IllegalStateModificationException
 
increment(StateValueHost) - Method in interface me.devnatan.inventoryframework.state.MutableIntState
Increments the current state value by 1.
inheritFrom(ViewConfigBuilder) - Method in class me.devnatan.inventoryframework.ViewConfigBuilder
Inherits all configuration from another ViewConfigBuilder value.
INIT - Static variable in class me.devnatan.inventoryframework.pipeline.StandardPipelinePhases
Called when a root is initialized for the first time.
InitializationException - Exception in me.devnatan.inventoryframework.exception
Called when a function that changes the nature of the view is called after its initialization.
InitializationException() - Constructor for exception me.devnatan.inventoryframework.exception.InitializationException
 
initializeState(long, StateValue) - Method in interface me.devnatan.inventoryframework.state.StateValueHost
Initializes the value of a state in this value host.
initialState() - Method in interface me.devnatan.inventoryframework.state.StateAccess
Creates a mutable lazy state whose value is always computed from the initial data set by its StateValueHost.
initialState(String) - Method in interface me.devnatan.inventoryframework.state.StateAccess
Creates a mutable lazy state whose value is always computed from the initial data set by its StateValueHost.
InitOnly - Annotation Type in me.devnatan.inventoryframework.internal
Marks a method that can be called only before view initialization, otherwise it will throw a InitializationException.
insertPhaseAfter(PipelinePhase, PipelinePhase) - Method in class me.devnatan.inventoryframework.pipeline.Pipeline
 
insertPhaseBefore(PipelinePhase, PipelinePhase) - Method in class me.devnatan.inventoryframework.pipeline.Pipeline
 
install(F, UnaryOperator<C>) - Method in interface me.devnatan.inventoryframework.feature.Feature
Initializes and installs everything that must be installed within this feature using the platform and configuration factory as providers.
install(Feature<C, R, P>, UnaryOperator<C>) - Method in interface me.devnatan.inventoryframework.feature.FeatureInstaller
Installs a feature.
interactionDelay(Duration) - Method in class me.devnatan.inventoryframework.ViewConfigBuilder
Waits a fixed delay before any player interaction.
InteractionHandler - Interface in me.devnatan.inventoryframework.component
 
intercept(PipelinePhase, PipelineInterceptor<? extends S>) - Method in class me.devnatan.inventoryframework.pipeline.Pipeline
 
intercept(PipelineContext<S>, S) - Method in interface me.devnatan.inventoryframework.pipeline.PipelineInterceptor
 
internalId() - Method in interface me.devnatan.inventoryframework.state.State
Returns the internal unique id of this state.
intersects(Component) - Method in interface me.devnatan.inventoryframework.component.Component
If this component are intersects with other component.
intersects(Component, Component) - Static method in interface me.devnatan.inventoryframework.component.Component
Checks if two components area intersects with each other.
intersects(Component) - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
InvalidatedContextException - Exception in me.devnatan.inventoryframework.exception
 
InvalidatedContextException(String, Throwable) - Constructor for exception me.devnatan.inventoryframework.exception.InvalidatedContextException
 
INVALIDATION - Static variable in class me.devnatan.inventoryframework.pipeline.StandardPipelinePhases
A context is invalidated, or considered invalidated, when there are no more viewers in it.
InvalidLayoutException - Exception in me.devnatan.inventoryframework.exception
 
InvalidLayoutException(String) - Constructor for exception me.devnatan.inventoryframework.exception.InvalidLayoutException
 
InventoryFrameworkException - Exception in me.devnatan.inventoryframework
 
InventoryFrameworkException() - Constructor for exception me.devnatan.inventoryframework.InventoryFrameworkException
 
InventoryFrameworkException(String) - Constructor for exception me.devnatan.inventoryframework.InventoryFrameworkException
 
InventoryFrameworkException(Throwable) - Constructor for exception me.devnatan.inventoryframework.InventoryFrameworkException
 
InventoryFrameworkException(String, Throwable) - Constructor for exception me.devnatan.inventoryframework.InventoryFrameworkException
 
InventoryModificationException - Exception in me.devnatan.inventoryframework.exception
Thrown when a method explicitly needs to specify that it will directly modify the view's container when executed, that method is overridden by implementations whose direct modification of the container is not allowed, throwing an exception.
InventoryModificationException(String) - Constructor for exception me.devnatan.inventoryframework.exception.InventoryModificationException
 
isActive() - Method in interface me.devnatan.inventoryframework.context.IFContext
This is an internal inventory-framework API that should not be used from outside of this library.
isAligned() - Method in class me.devnatan.inventoryframework.ViewType
 
isAsync() - Method in interface me.devnatan.inventoryframework.component.Pagination
Asynchronous pagination can have a mix of all others static, lazy and computed types of pagination source, that is: Have a CompletableFuture as source? Then it's static. Have a Function or Supplier as source? Type will be defined by implementation.
isAsync() - Method in class me.devnatan.inventoryframework.component.PaginationStateBuilder
 
isBlockedByInteractionDelay() - Method in interface me.devnatan.inventoryframework.Viewer
If this viewer is waiting for view's interaction delay to be able to interact again.
isCancelled() - Method in interface me.devnatan.inventoryframework.context.IFCloseContext
Cancellation state of that context.
isCancelled() - Method in interface me.devnatan.inventoryframework.context.IFOpenContext
Whether opening the container to the viewer has been cancelled.
isCancelled() - Method in interface me.devnatan.inventoryframework.context.IFSlotClickContext
If the click was cancelled.
isCancelled() - Method in interface me.devnatan.inventoryframework.context.IFSlotRenderContext
 
isCancelOnClick() - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
isCloseOnClick() - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
isComputed() - Method in interface me.devnatan.inventoryframework.component.Pagination
Computed pagination usually have a Function-like as source provider and this provider is called each time this component is updated or the page is changed so the current as a whole will always be the result of the source provider, regardless the current page.
isComputed() - Method in class me.devnatan.inventoryframework.component.PaginationStateBuilder
 
isContainedWithin(int) - Method in interface me.devnatan.inventoryframework.component.Component
Checks if this component is in a specific position.
isContainedWithin(int) - Method in interface me.devnatan.inventoryframework.component.ComponentComposition
Checks if any component of that composition is in a specific position.
isContainedWithin(int) - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
isContainedWithin(int) - Method in interface me.devnatan.inventoryframework.component.ItemComponentBuilder
 
isDebugEnabled() - Static method in class me.devnatan.inventoryframework.IFDebug
Returns if debug is enabled.
isDefinedByTheUser() - Method in class me.devnatan.inventoryframework.internal.LayoutSlot
 
isEntityContainer() - Method in interface me.devnatan.inventoryframework.ViewContainer
 
isExtendable() - Method in class me.devnatan.inventoryframework.ViewType
 
isFirstPage() - Method in interface me.devnatan.inventoryframework.component.Pagination
Checks if the current page is the first page (at index 0).
isForceUpdate() - Method in interface me.devnatan.inventoryframework.context.IFSlotRenderContext
This is an internal inventory-framework API that should not be used from outside of this library.
isKeyboardClick() - Method in interface me.devnatan.inventoryframework.context.IFSlotClickContext
If the click source came from a keyboard, e.g.
isLastPage() - Method in interface me.devnatan.inventoryframework.component.Pagination
Checks if the current page is the last page (at Pagination.lastPage()).
isLazy() - Method in interface me.devnatan.inventoryframework.component.Pagination
Lazy pagination usually have a Function as source provider and this provider is only called again to set the current internal source when an explicit update is called.
isLeftClick() - Method in interface me.devnatan.inventoryframework.context.IFSlotClickContext
If the click was using the left mouse button.
isLoading() - Method in interface me.devnatan.inventoryframework.component.Pagination
If the pagination data is being loaded.
isManagedExternally() - Method in interface me.devnatan.inventoryframework.component.Component
This is an internal inventory-framework API that should not be used from outside of this library.
isManagedExternally() - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
isMiddleClick() - Method in interface me.devnatan.inventoryframework.context.IFSlotClickContext
If the click was using the middle mouse button, commonly known as the scroll button.
isOnEntityContainer() - Method in interface me.devnatan.inventoryframework.context.IFSlotContext
Whether this context originated from an interaction coming from the actor's container and not from the view's container.
isOptionSet(ViewConfig.Option<T>) - Method in class me.devnatan.inventoryframework.ViewConfig
 
isOptionSet(ViewConfig.Option<T>, T) - Method in class me.devnatan.inventoryframework.ViewConfig
 
isOutsideClick() - Method in interface me.devnatan.inventoryframework.context.IFSlotClickContext
If the click did not occur within any containers.
isProxied() - Method in interface me.devnatan.inventoryframework.ViewContainer
 
isRendered() - Method in interface me.devnatan.inventoryframework.context.IFRenderContext
This is an internal inventory-framework API that should not be used from outside of this library.
isResultSlot(int) - Method in class me.devnatan.inventoryframework.ViewType
 
isRightClick() - Method in interface me.devnatan.inventoryframework.context.IFSlotClickContext
If the click was using the right mouse button.
isShared() - Method in interface me.devnatan.inventoryframework.context.IFContext
This API is experimental and is not subject to the general compatibility guarantees such API may be changed or may be removed completely in any further release.
isShiftClick() - Method in interface me.devnatan.inventoryframework.context.IFSlotClickContext
If the click was accompanied by a click holding the keyboard shift button.
isStarted() - Method in interface me.devnatan.inventoryframework.internal.Job
Whether the job has already started or not.
isStatic() - Method in interface me.devnatan.inventoryframework.component.Pagination
Static pagination is a type of pagination that usually have a Collection or something else as source provider and this source provider is called only on first render to set the current source as a whole, and never called again on the entire Pagination lifecycle.
isSupportedItem(Object) - Method in interface me.devnatan.inventoryframework.ViewContainer
 
isTitleAsComponentSupported() - Static method in class me.devnatan.inventoryframework.ViewConfigBuilder
 
isTransitioning() - Method in interface me.devnatan.inventoryframework.Viewer
This is an internal inventory-framework API that should not be used from outside of this library.
isTransitiveInitialData() - Method in class me.devnatan.inventoryframework.ViewConfig
 
isTransitiveInitialData() - Method in class me.devnatan.inventoryframework.ViewConfigBuilder
 
isUpdateOnClick() - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
isVisible() - Method in interface me.devnatan.inventoryframework.component.Component
If this component can be seen, it is used in interaction treatments to ensure that the viewer does not interact with hidden components.
isVisible() - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
ItemComponent - Class in me.devnatan.inventoryframework.component
 
ItemComponent(VirtualView, int, Object, boolean, boolean, Predicate<? extends IFContext>, Consumer<? super IFSlotRenderContext>, Consumer<? super IFSlotContext>, Consumer<? super IFSlotClickContext>, Set<State<?>>, boolean, boolean, boolean, Ref<Component>) - Constructor for class me.devnatan.inventoryframework.component.ItemComponent
 
ItemComponentBuilder<Self extends ItemComponentBuilder<Self,Context>,Context extends IFContext> - Interface in me.devnatan.inventoryframework.component
 
itemFactory(BiConsumer<Builder, V>) - Method in class me.devnatan.inventoryframework.component.PaginationStateBuilder
Sets the item factory for pagination.

J

Job - Interface in me.devnatan.inventoryframework.internal
 

L

lastPage() - Method in interface me.devnatan.inventoryframework.component.Pagination
The number of the last page.
lastPageIndex() - Method in interface me.devnatan.inventoryframework.component.Pagination
The index of the last page.
layout(String...) - Method in class me.devnatan.inventoryframework.ViewConfigBuilder
Defines the layout that will be used.
LAYOUT_RESOLUTION - Static variable in class me.devnatan.inventoryframework.pipeline.StandardPipelinePhases
 
LAYOUTS - Static variable in class me.devnatan.inventoryframework.feature.Feature.Keys
Layouts feature key.
LayoutSlot - Class in me.devnatan.inventoryframework.internal
 
LayoutSlot(char, IntFunction<ComponentFactory>, int[]) - Constructor for class me.devnatan.inventoryframework.internal.LayoutSlot
 
layoutTarget(char) - Method in class me.devnatan.inventoryframework.component.PaginationStateBuilder
Defines a target character in the layout whose pagination will be rendered.
lazyAsyncPaginationState(Function<Context, CompletableFuture<List<T>>>, PaginationValueConsumer<Context, ItemBuilder, T>) - Method in interface me.devnatan.inventoryframework.state.StateAccess
Creates a new unmodifiable lazy pagination state with asynchronous data source.
lazyPaginationState(Function<Context, List<? super T>>, PaginationValueConsumer<Context, ItemBuilder, T>) - Method in interface me.devnatan.inventoryframework.state.StateAccess
Creates a new unmodifiable lazy pagination state.
lazyPaginationState(Supplier<List<? super T>>, PaginationValueConsumer<Context, ItemBuilder, T>) - Method in interface me.devnatan.inventoryframework.state.StateAccess
Creates a new unmodifiable lazy pagination state.
lazyState(Function<Context, T>) - Method in interface me.devnatan.inventoryframework.state.StateAccess
Creates an immutable lazy state.
lazyState(Supplier<T>) - Method in interface me.devnatan.inventoryframework.state.StateAccess
Creates an immutable lazy state.
Logger - Interface in me.devnatan.inventoryframework.logging
 
loop() - Method in interface me.devnatan.inventoryframework.internal.Job
Internal loop.

M

matchesItem(int, Object, boolean) - Method in interface me.devnatan.inventoryframework.ViewContainer
 
maxSize() - Method in class me.devnatan.inventoryframework.ViewConfigBuilder
 
me.devnatan.inventoryframework - package me.devnatan.inventoryframework
 
me.devnatan.inventoryframework.component - package me.devnatan.inventoryframework.component
 
me.devnatan.inventoryframework.context - package me.devnatan.inventoryframework.context
 
me.devnatan.inventoryframework.exception - package me.devnatan.inventoryframework.exception
 
me.devnatan.inventoryframework.feature - package me.devnatan.inventoryframework.feature
 
me.devnatan.inventoryframework.internal - package me.devnatan.inventoryframework.internal
 
me.devnatan.inventoryframework.logging - package me.devnatan.inventoryframework.logging
 
me.devnatan.inventoryframework.pipeline - package me.devnatan.inventoryframework.pipeline
 
me.devnatan.inventoryframework.state - package me.devnatan.inventoryframework.state
 
merge(ViewConfig) - Method in class me.devnatan.inventoryframework.ViewConfig
Merges other config into this configuration.
modifyConfig() - Method in interface me.devnatan.inventoryframework.context.IFOpenContext
Allows access and change the current configuration specifically to that context.
MutableIntState - Interface in me.devnatan.inventoryframework.state
 
MutableState<T> - Interface in me.devnatan.inventoryframework.state
Mutable variation of a State that the value can be changed.
mutableState(T) - Method in interface me.devnatan.inventoryframework.state.StateAccess
Creates a mutable state with an initial value.
mutableState(int) - Method in interface me.devnatan.inventoryframework.state.StateAccess
Creates a mutable state with an initial value.

N

name() - Method in interface me.devnatan.inventoryframework.feature.Feature
The name of this feature.
name() - Method in interface me.devnatan.inventoryframework.ViewConfig.Option
 
next() - Static method in interface me.devnatan.inventoryframework.state.State
Generates a new state id.
nextPage() - Method in interface me.devnatan.inventoryframework.component.Pagination
The number of the next page.
nextPageIndex() - Method in interface me.devnatan.inventoryframework.component.Pagination
The index of the next page.
nextTick(Runnable) - Method in interface me.devnatan.inventoryframework.RootView
Runs a task in the next tick.
normalize(int) - Method in class me.devnatan.inventoryframework.ViewType
Normalizes the specified parameter to conform to container constraints and does not exceed or fail in an attempt to set the container size, e.g.: if player provides inventory rows count instead of the full inventory size, it will return the inventory size.

O

onPageSwitch(BiConsumer<Context, Pagination>) - Method in class me.devnatan.inventoryframework.component.PaginationStateBuilder
Handles the page switching action.
OPEN - Static variable in class me.devnatan.inventoryframework.pipeline.StandardPipelinePhases
Called when a context is about to open.
open(Viewer) - Method in interface me.devnatan.inventoryframework.ViewContainer
 
open(ViewContainer) - Method in interface me.devnatan.inventoryframework.Viewer
Opens a container to this viewer.
openForEveryone(Class<? extends RootView>) - Method in interface me.devnatan.inventoryframework.context.IFContext
Opens a new view for all viewers in that context.
openForEveryone(Class<? extends RootView>, Object) - Method in interface me.devnatan.inventoryframework.context.IFContext
Opens a new view for all viewers in that context with an initially defined data.
openForPlayer(Class<? extends RootView>) - Method in interface me.devnatan.inventoryframework.context.IFConfinedContext
Opens a new view only for the player that is in the current scope of execution.
openForPlayer(Class<? extends RootView>, Object) - Method in interface me.devnatan.inventoryframework.context.IFConfinedContext
Opens a new view only for the player that is in the current scope of execution with an initially defined data.
options(ViewConfig.Option<?>...) - Method in class me.devnatan.inventoryframework.ViewConfigBuilder
 

P

Pagination - Interface in me.devnatan.inventoryframework.component
Pagination is a host to multiple components that can be paginated, essentially it is a ComponentComposition divided into sections called pages.
PAGINATION - Static variable in class me.devnatan.inventoryframework.feature.Feature.Keys
Pagination feature key.
PaginationElementFactory<V> - Interface in me.devnatan.inventoryframework.component
 
paginationState(List<? super T>, PaginationValueConsumer<Context, ItemBuilder, T>) - Method in interface me.devnatan.inventoryframework.state.StateAccess
Creates a new immutable pagination with static data source.
PaginationStateBuilder<Context extends IFContext,Builder extends ItemComponentBuilder<Builder,Context> & ComponentFactory,V> - Class in me.devnatan.inventoryframework.component
 
PaginationStateBuilder(ElementFactory, Object, Function<PaginationStateBuilder<Context, Builder, V>, State<Pagination>>, boolean, boolean) - Constructor for class me.devnatan.inventoryframework.component.PaginationStateBuilder
 
PaginationValueConsumer<C,B,V> - Interface in me.devnatan.inventoryframework.component
Represents a pagination element mapping operation that accepts three arguments and returns no result.
Pipeline<S> - Class in me.devnatan.inventoryframework.pipeline
The pipeline is a structure containing a sequence of functions (blocks/lambdas) that are called one after another, distributed in phases topologically ordered, with the ability to mutate the sequence and to call the remaining functions in the pipeline and then return to current block.
Pipeline(PipelinePhase...) - Constructor for class me.devnatan.inventoryframework.pipeline.Pipeline
 
PipelineContext<S> - Class in me.devnatan.inventoryframework.pipeline
 
PipelineContext(PipelinePhase, List<PipelineInterceptor<S>>) - Constructor for class me.devnatan.inventoryframework.pipeline.PipelineContext
 
PipelineInterceptor<S> - Interface in me.devnatan.inventoryframework.pipeline
 
PipelinePhase - Class in me.devnatan.inventoryframework.pipeline
Phases are groups of interceptors that can be ordered topologically, defining relationships between them.
PipelinePhase(String) - Constructor for class me.devnatan.inventoryframework.pipeline.PipelinePhase
 
PLAYER - Static variable in class me.devnatan.inventoryframework.ViewType
 
proceed() - Method in class me.devnatan.inventoryframework.pipeline.PipelineContext
 

R

Ref<E> - Interface in me.devnatan.inventoryframework
Ref's hold a reference of any element inside a IFContext.
referencedBy(Ref<Component>) - Method in interface me.devnatan.inventoryframework.component.ComponentBuilder
Assigns a reference to this component.
removeComponent(Component) - Method in interface me.devnatan.inventoryframework.context.IFContext
Removes a component from this context.
removeInterceptor(PipelinePhase, PipelineInterceptor<? extends S>) - Method in class me.devnatan.inventoryframework.pipeline.Pipeline
 
removeItem(int) - Method in interface me.devnatan.inventoryframework.ViewContainer
 
removeViewer(Viewer) - Method in interface me.devnatan.inventoryframework.context.IFContext
Removes a new viewer to this context.
render(IFSlotRenderContext) - Method in interface me.devnatan.inventoryframework.component.Component
Renders this component to the given context.
render(IFSlotRenderContext) - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
renderComponent(Component) - Method in interface me.devnatan.inventoryframework.context.IFContext
Renders a component in this context.
renderItem(int, Object) - Method in interface me.devnatan.inventoryframework.ViewContainer
 
resetTitleForEveryone() - Method in interface me.devnatan.inventoryframework.context.IFContext
Updates the container title to all viewers in this context, to the initially defined title.
resetTitleForPlayer() - Method in interface me.devnatan.inventoryframework.context.IFConfinedContext
Resets the container title only for the player current scope of execution to the initially defined title.
RootView - Interface in me.devnatan.inventoryframework
 

S

SCHEDULED_UPDATES - Static variable in class me.devnatan.inventoryframework.feature.Feature.Keys
Scheduled updates feature key.
scheduleJobInterval(RootView, long, Runnable) - Method in class me.devnatan.inventoryframework.internal.ElementFactory
 
scheduleUpdate(long) - Method in class me.devnatan.inventoryframework.ViewConfigBuilder
Schedules the view to update every fixed interval.
set(Object) - Method in class me.devnatan.inventoryframework.state.AbstractStateValue
 
set(T, StateValueHost) - Method in interface me.devnatan.inventoryframework.state.MutableState
Sets a new value for this state.
set(Object) - Method in interface me.devnatan.inventoryframework.state.StateValue
Sets the new state value.
setActive(boolean) - Method in interface me.devnatan.inventoryframework.context.IFContext
This is an internal inventory-framework API that should not be used from outside of this library.
setActiveContext(IFRenderContext) - Method in interface me.devnatan.inventoryframework.Viewer
This is an internal inventory-framework API that should not be used from outside of this library.
setCancelled(boolean) - Method in interface me.devnatan.inventoryframework.context.IFCloseContext
Cancels or not this context.
setCancelled(boolean) - Method in interface me.devnatan.inventoryframework.context.IFOpenContext
Cancels the opening of this context's container to the viewer.
setCancelled(boolean) - Method in interface me.devnatan.inventoryframework.context.IFSlotClickContext
Cancels the click.
setCancelled(boolean) - Method in interface me.devnatan.inventoryframework.context.IFSlotRenderContext
 
setChanged(boolean) - Method in interface me.devnatan.inventoryframework.context.IFSlotRenderContext
Marks this context as changed.
setConfig(ViewConfig) - Method in interface me.devnatan.inventoryframework.RootView
Sets the configuration for this view.
setContainer(ViewContainer) - Method in interface me.devnatan.inventoryframework.context.IFOpenContext
This is an internal inventory-framework API that should not be used from outside of this library.
setEnabled(boolean) - Static method in class me.devnatan.inventoryframework.IFDebug
Enables InventoryFramework debug.
setForceUpdate(boolean) - Method in interface me.devnatan.inventoryframework.context.IFSlotRenderContext
This is an internal inventory-framework API that should not be used from outside of this library.
setInitialData(Object) - Method in interface me.devnatan.inventoryframework.context.IFContext
This API is experimental and is not subject to the general compatibility guarantees such API may be changed or may be removed completely in any further release.
setLastInteractionInMillis(long) - Method in interface me.devnatan.inventoryframework.Viewer
Updates the value that holds the timestamp of the last interaction of this viewer.
setPreviousContext(IFRenderContext) - Method in interface me.devnatan.inventoryframework.Viewer
This is an internal inventory-framework API that should not be used from outside of this library.
setScheduledUpdateJob(Job) - Method in interface me.devnatan.inventoryframework.RootView
This is an internal inventory-framework API that should not be used from outside of this library.
setSlot(int) - Method in interface me.devnatan.inventoryframework.context.IFSlotContext
 
setTransitioning(boolean) - Method in interface me.devnatan.inventoryframework.Viewer
This is an internal inventory-framework API that should not be used from outside of this library.
setVisible(boolean) - Method in interface me.devnatan.inventoryframework.component.Component
Sets the visibility state of this component.
setVisible(boolean) - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
shouldRender(IFContext) - Method in interface me.devnatan.inventoryframework.component.Component
 
shouldRender(IFContext) - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
show() - Method in interface me.devnatan.inventoryframework.component.Component
Shows this component.
show() - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
SHULKER_BOX - Static variable in class me.devnatan.inventoryframework.ViewType
 
size(int) - Method in class me.devnatan.inventoryframework.ViewConfigBuilder
Defines the size of the container.
SlotFillExceededException - Exception in me.devnatan.inventoryframework.exception
 
SlotFillExceededException(String) - Constructor for exception me.devnatan.inventoryframework.exception.SlotFillExceededException
 
SMOKER - Static variable in class me.devnatan.inventoryframework.ViewType
 
splitSourceForPage(int, int, int, List<?>) - Static method in interface me.devnatan.inventoryframework.component.Pagination
Gets all elements in a given page index based of the specified source.
StandardPipelinePhases - Class in me.devnatan.inventoryframework.pipeline
Pipeline phases used internally by the framework.
start() - Method in interface me.devnatan.inventoryframework.internal.Job
Starts this job.
State<T> - Interface in me.devnatan.inventoryframework.state
States are just intermediate interfaces to a StateValueHost and a StateValue.
state(T) - Method in interface me.devnatan.inventoryframework.state.StateAccess
Creates an immutable state with an initial value.
StateAccess<Context extends IFContext,ItemBuilder extends ItemComponentBuilder<ItemBuilder,Context> & ComponentFactory> - Interface in me.devnatan.inventoryframework.state
 
StateException - Exception in me.devnatan.inventoryframework.state
 
StateException() - Constructor for exception me.devnatan.inventoryframework.state.StateException
 
StateException(String) - Constructor for exception me.devnatan.inventoryframework.state.StateException
 
StateException(String, Throwable) - Constructor for exception me.devnatan.inventoryframework.state.StateException
 
stateRegistered(State<?>, Object) - Method in interface me.devnatan.inventoryframework.state.StateWatcher
Called when a state is registered on a host.
stateUnregistered(State<?>, Object) - Method in interface me.devnatan.inventoryframework.state.StateWatcher
 
StateValue - Interface in me.devnatan.inventoryframework.state
Wrapper of the value of a State for a single StateValueHost.
StateValueFactory - Interface in me.devnatan.inventoryframework.state
 
stateValueGet(State<?>, StateValueHost, StateValue, Object) - Method in interface me.devnatan.inventoryframework.state.StateWatcher
Called when the value of a state on a specific host is obtained.
StateValueHost - Interface in me.devnatan.inventoryframework.state
StateHost is an entity capable of storing current data from multiple states.
stateValueSet(StateValueHost, StateValue, Object, Object) - Method in interface me.devnatan.inventoryframework.state.StateWatcher
Called when the value of a state on a host is set.
StateWatcher - Interface in me.devnatan.inventoryframework.state
 
switchTo(int) - Method in interface me.devnatan.inventoryframework.component.Pagination
Switches to a specific page index.

T

title(Object) - Method in class me.devnatan.inventoryframework.ViewConfigBuilder
Defines the title of the container.
toString() - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
toString() - Method in class me.devnatan.inventoryframework.internal.LayoutSlot
 
toString() - Method in class me.devnatan.inventoryframework.pipeline.PipelinePhase
 
toString() - Method in class me.devnatan.inventoryframework.state.AbstractStateValue
 
toString() - Method in class me.devnatan.inventoryframework.ViewConfig
 
toString() - Method in class me.devnatan.inventoryframework.ViewType
 
transitiveInitialData(boolean) - Method in class me.devnatan.inventoryframework.ViewConfigBuilder
When navigating between views data from "A" to "B" is not carried so trying to access some data from "A" in "B" will throw a NullPointerException.
type(ViewType) - Method in class me.devnatan.inventoryframework.ViewConfigBuilder
Defines the type of the container.

U

UnassignedReferenceException - Exception in me.devnatan.inventoryframework
 
UnassignedReferenceException() - Constructor for exception me.devnatan.inventoryframework.UnassignedReferenceException
 
UninitializedStateException - Exception in me.devnatan.inventoryframework.state
 
UninitializedStateException() - Constructor for exception me.devnatan.inventoryframework.state.UninitializedStateException
 
uninstall(F) - Method in interface me.devnatan.inventoryframework.feature.Feature
Uninstalls this feature, used to invalidate resources applied on installation.
uninstall(Feature<?, ?, P>) - Method in interface me.devnatan.inventoryframework.feature.FeatureInstaller
Uninstalls a feature.
UnknownReferenceException - Exception in me.devnatan.inventoryframework.exception
 
UnknownReferenceException(String, Throwable) - Constructor for exception me.devnatan.inventoryframework.exception.UnknownReferenceException
 
UnresolvedLayoutException - Exception in me.devnatan.inventoryframework.exception
 
UnresolvedLayoutException(String, Throwable) - Constructor for exception me.devnatan.inventoryframework.exception.UnresolvedLayoutException
 
unsetPreviousContext() - Method in interface me.devnatan.inventoryframework.Viewer
This is an internal inventory-framework API that should not be used from outside of this library.
UnsupportedOperationInSharedContextException - Exception in me.devnatan.inventoryframework
Thrown when an operation is called in a shared context, but it's not supported for some reason.
UnsupportedOperationInSharedContextException() - Constructor for exception me.devnatan.inventoryframework.UnsupportedOperationInSharedContextException
 
UnsupportedOperationInSharedContextException(String) - Constructor for exception me.devnatan.inventoryframework.UnsupportedOperationInSharedContextException
 
update() - Method in interface me.devnatan.inventoryframework.component.Component
Updates this component.
update() - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
update() - Method in interface me.devnatan.inventoryframework.context.IFContext
Updates all components for all viewers in this context.
UPDATE - Static variable in class me.devnatan.inventoryframework.pipeline.StandardPipelinePhases
Called when a context is going to be updated.
updateComponent(Component, boolean) - Method in interface me.devnatan.inventoryframework.context.IFContext
Updates a component in this context.
updated(IFSlotRenderContext) - Method in interface me.devnatan.inventoryframework.component.Component
Called when this component is updated in the given context.
updated(IFSlotRenderContext) - Method in class me.devnatan.inventoryframework.component.ItemComponent
 
updateOnClick() - Method in interface me.devnatan.inventoryframework.component.ComponentBuilder
Updates the current context when a player clicks on this component.
updateOnStateChange(State<?>) - Method in interface me.devnatan.inventoryframework.component.ComponentBuilder
Listens for value updates in the specified state.
updateOnStateChange(State<?>, State<?>...) - Method in interface me.devnatan.inventoryframework.component.ComponentBuilder
Listens for value updates in any of the specified states.
updateState(long, Object) - Method in interface me.devnatan.inventoryframework.state.StateValueHost
Updates the value of an initialized state in this value host.
updateTitleForEveryone(String) - Method in interface me.devnatan.inventoryframework.context.IFContext
Updates the container title for everyone that's viewing it.
updateTitleForPlayer(String) - Method in interface me.devnatan.inventoryframework.context.IFConfinedContext
Updates the container title only for the player current scope of execution.
use(ViewConfig.Modifier) - Method in class me.devnatan.inventoryframework.ViewConfigBuilder
Uses a modifier in this config.
use(ViewConfig.Modifier...) - Method in class me.devnatan.inventoryframework.ViewConfigBuilder
Uses a modifier in this config.

V

value(IFContext) - Method in interface me.devnatan.inventoryframework.Ref
Returns the value hold by this reference.
ViewConfig - Class in me.devnatan.inventoryframework
 
ViewConfig(Object, int, ViewType, Map<ViewConfig.Option<?>, Object>, String[], Set<ViewConfig.Modifier>, long, long, boolean) - Constructor for class me.devnatan.inventoryframework.ViewConfig
 
ViewConfig.Modifier - Interface in me.devnatan.inventoryframework
 
ViewConfig.Option<T> - Interface in me.devnatan.inventoryframework
 
ViewConfigBuilder - Class in me.devnatan.inventoryframework
 
ViewConfigBuilder() - Constructor for class me.devnatan.inventoryframework.ViewConfigBuilder
 
ViewContainer - Interface in me.devnatan.inventoryframework
 
Viewer - Interface in me.devnatan.inventoryframework
 
ViewType - Class in me.devnatan.inventoryframework
 
ViewType(String, int, int, int) - Constructor for class me.devnatan.inventoryframework.ViewType
 
ViewType(String, int, int, int, boolean) - Constructor for class me.devnatan.inventoryframework.ViewType
 
ViewType(String, int, int, int, boolean, int[]) - Constructor for class me.devnatan.inventoryframework.ViewType
 
ViewType(String, int, int, int, boolean, int[], boolean) - Constructor for class me.devnatan.inventoryframework.ViewType
 
VILLAGER_TRADING - Static variable in class me.devnatan.inventoryframework.ViewType
 
VirtualView - Interface in me.devnatan.inventoryframework
VirtualView is the basis for creating a view it contains the implementation with methods that are shared between regular views and contexts which are called "unified methods".

W

waitUntil(CompletableFuture<Void>) - Method in interface me.devnatan.inventoryframework.context.IFOpenContext
Waits for a task to run before ending this opening context and transitioning to the rendering context.
warn(String) - Method in interface me.devnatan.inventoryframework.logging.Logger
 
watch(State<?>...) - Method in interface me.devnatan.inventoryframework.component.ComponentBuilder
watchState(long, StateWatcher) - Method in interface me.devnatan.inventoryframework.state.StateValueHost
 
with(ViewConfig.Modifier) - Method in class me.devnatan.inventoryframework.ViewConfigBuilder
Adds a modifier to this config.
with(ViewConfig.Modifier...) - Method in class me.devnatan.inventoryframework.ViewConfigBuilder
Adds a modifier to this config.
withData(String, Object) - Method in interface me.devnatan.inventoryframework.component.ComponentBuilder
Adds a new user-defined property to this component.
withExternallyManaged(boolean) - Method in interface me.devnatan.inventoryframework.component.ComponentBuilder
This is an internal inventory-framework API that should not be used from outside of this library.
withFactory(IntFunction<ComponentFactory>) - Method in class me.devnatan.inventoryframework.internal.LayoutSlot
 
withSlot(int) - Method in interface me.devnatan.inventoryframework.component.ItemComponentBuilder
Sets the slot that the item will be positioned.
withSlot(int, int) - Method in interface me.devnatan.inventoryframework.component.ItemComponentBuilder
 
worksInCurrentPlatform() - Method in class me.devnatan.inventoryframework.internal.ElementFactory
 
A B C D E F G H I J L M N O P R S T U V W