me.devnatan.inventoryframework.context

Interface IFCloseContext

All Superinterfaces:

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

public interface IFCloseContext
extends IFConfinedContext

Method Summary

Modifier and Type	Method and Description
@NotNull ViewContainer	getContainer() The container of this context.
IFRenderContext	getParent() This is an internal inventory-framework API that should not be used from outside of this library.
boolean	isCancelled() Cancellation state of that context.
void	setCancelled(boolean cancelled) Cancels or not this 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

getParent

@ApiStatus.Internal
IFRenderContext getParent()

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

isCancelled

boolean isCancelled()

Cancellation state of that context.

Returns:

If that context was cancelled.

setCancelled

void setCancelled(boolean cancelled)

Cancels or not this context.

The side effect of canceling a close context is determined by the current platform.

NOOP (does nothing) if close context cancellation is not supported.

Parameters:

cancelled - If this context should be cancelled.

getContainer

@NotNull
@NotNull ViewContainer getContainer()

The container of this context.

Returns:

The container of this context.