me.devnatan.inventoryframework.context

Interface IFConfinedContext

All Superinterfaces:

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

All Known Subinterfaces:

IFCloseContext, IFOpenContext, IFRenderContext, IFSlotClickContext, IFSlotRenderContext

public interface IFConfinedContext
extends IFContext

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.

Method Summary

Modifier and Type	Method and Description
void	back() Goes back to the previous view, does nothing if there's no views to back to.
void	back(java.lang.Object initialData) Goes back to the previous view, does nothing if there's no views to back to.
boolean	canBack() Verifies if there's any view to back to.
void	closeForPlayer() Closes this context's container for the player in the current scope of execution.
Viewer	getViewer() The viewer in current scope of execution.
void	openForPlayer(@NotNull java.lang.Class<? extends RootView> other) Opens a new view only for the player that is in the current scope of execution.
void	openForPlayer(@NotNull java.lang.Class<? extends RootView> other, java.lang.Object initialData) Opens a new view only for the player that is in the current scope of execution with an initially defined data.
void	resetTitleForPlayer() Resets the container title only for the player current scope of execution to the initially defined title.
void	updateTitleForPlayer(@NotNull java.lang.String title) Updates the container title only for the player current scope of execution.

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

getViewer

Viewer getViewer()

The viewer in current scope of execution.

Returns:

The Viewer in the current scope of execution.

closeForPlayer

void closeForPlayer()

Closes this context's container for the player in the current scope of execution.

openForPlayer

void openForPlayer(@NotNull
                   @NotNull java.lang.Class<? extends RootView> other)

Opens a new view only for the player that is in the current scope of execution.

This context will be immediately invalidated if there are no viewers left after opening.

Parameters:

other - The view to be opened.

openForPlayer

void openForPlayer(@NotNull
                   @NotNull java.lang.Class<? extends RootView> other,
                   java.lang.Object initialData)

Opens a new view only for the player that is in the current scope of execution with an initially defined data.

This context will be immediately invalidated if there are no viewers left after opening.

Parameters:

other - The view to be opened.

initialData - The initial context data.

updateTitleForPlayer

void updateTitleForPlayer(@NotNull
                          @NotNull java.lang.String title)

Updates the container title only for the player current scope of execution.

This should not be used before the container is opened, if you need to set the __initial title__ use IFOpenContext.modifyConfig() on open handler instead.

This method is version dependant, so it may be that your server version is not yet supported, if you try to use this method and fail (can fail silently), report it to the library developers to add support to your version.

Parameters:

title - The new container title.

resetTitleForPlayer

void resetTitleForPlayer()

Resets the container title only for the player current scope of execution to the initially defined title. Must be used after updateTitleForPlayer(String) to take effect.

back

@ApiStatus.Experimental
void back()

Goes back to the previous view, does nothing if there's no views to back to.

Only works if, from the previous view, the current view was opened using openForEveryone or openForPlayer.

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.

See Also:

Navigating between Views on Wiki

back

@ApiStatus.Experimental
void back(java.lang.Object initialData)

Goes back to the previous view, does nothing if there's no views to back to.

Only works if, from the previous view, the current view was opened using openForEveryone or openForPlayer.

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.

Parameters:

initialData - The initial data.

See Also:

Navigating between Views on Wiki

canBack

@ApiStatus.Experimental
boolean canBack()

Verifies if there's any view to back to.

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.

Returns:

If there's any view to back to.

See Also:

back()