me.devnatan.inventoryframework.context

Interface IFOpenContext

All Superinterfaces:

ComponentContainer, IFConfinedContext, IFContext, java.lang.Iterable<Component>, StateValueHost, VirtualView

public interface IFOpenContext
extends IFConfinedContext

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.

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletableFuture<java.lang.Void>	getAsyncOpenJob() The task that will run before this context transitions from opening to rendering context.
ViewContainer	getContainer() This is an internal inventory-framework API that should not be used from outside of this library.
ViewConfig	getModifiedConfig() This is an internal inventory-framework API that should not be used from outside of this library.
boolean	isCancelled() Whether opening the container to the viewer has been cancelled.
@NotNull ViewConfigBuilder	modifyConfig() Allows access and change the current configuration specifically to that context.
void	setCancelled(boolean cancelled) Cancels the opening of this context's container to the viewer.
void	setContainer(ViewContainer container) This is an internal inventory-framework API that should not be used from outside of this library.
void	waitUntil(@NotNull java.util.concurrent.CompletableFuture<java.lang.Void> task) Waits for a task to run before ending this opening context and transitioning to the rendering context.

Methods inherited from interface me.devnatan.inventoryframework.context.IFConfinedContext

back, back, canBack, closeForPlayer, getViewer, openForPlayer, openForPlayer, resetTitleForPlayer, updateTitleForPlayer

Methods inherited from interface me.devnatan.inventoryframework.context.IFContext

addComponent, addViewer, closeForEveryone, getComponentsAt, getConfig, getId, getIndexedViewers, getInitialData, getInitialTitle, getRoot, getViewers, isActive, isShared, openForEveryone, openForEveryone, removeComponent, removeViewer, renderComponent, resetTitleForEveryone, setActive, setInitialData, update, updateComponent, updateTitleForEveryone

Methods inherited from interface me.devnatan.inventoryframework.state.StateValueHost

getInternalStateValue, getRawStateValue, getStateValues, getUninitializedStateValue, initializeState, updateState, watchState

Methods inherited from interface me.devnatan.inventoryframework.component.ComponentContainer

getComponents, getInternalComponents

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getAsyncOpenJob

@ApiStatus.Internal
java.util.concurrent.CompletableFuture<java.lang.Void> getAsyncOpenJob()

The task that will run before this context transitions from opening to rendering context.

This is an internal inventory-framework API that should not be used from outside of this library. No compatibility guarantees are provided.

Returns:

The task that will run before this context gets completed.

waitUntil

void waitUntil(@NotNull
               @NotNull java.util.concurrent.CompletableFuture<java.lang.Void> task)

Waits for a task to run before ending this opening context and transitioning to the rendering context.

This transition represents the opening of this context's container to the player viewing it.

Parameters:

task - The task that will be waited for.

isCancelled

boolean isCancelled()

Whether opening the container to the viewer has been cancelled.

Returns:

If true the container will not be displayed to the player.

setCancelled

void setCancelled(boolean cancelled)

Cancels the opening of this context's container to the viewer.

Parameters:

cancelled - If true, the container will not open for the player.

modifyConfig

@NotNull
@NotNull ViewConfigBuilder modifyConfig()

Allows access and change the current configuration specifically to that context.

By default, all contexts inherit their root configuration but context configuration always takes precedence over root.

Returns:

The current context configuration.

getModifiedConfig

@ApiStatus.Internal
ViewConfig getModifiedConfig()

This is an internal inventory-framework API that should not be used from outside of this library. No compatibility guarantees are provided.

getContainer

@ApiStatus.Internal
ViewContainer getContainer()

This is an internal inventory-framework API that should not be used from outside of this library. No compatibility guarantees are provided.

setContainer

@ApiStatus.Internal
void setContainer(ViewContainer container)

This is an internal inventory-framework API that should not be used from outside of this library. No compatibility guarantees are provided.