me.devnatan.inventoryframework.context

Interface IFContext

All Superinterfaces:

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

All Known Subinterfaces:

IFCloseContext, IFConfinedContext, IFOpenContext, IFRenderContext, IFSlotClickContext, IFSlotContext, IFSlotRenderContext

public interface IFContext
extends VirtualView, StateValueHost, ComponentContainer

Method Summary

Modifier and Type	Method and Description
void	addComponent(@NotNull Component component) Adds a new component to this context.
void	addViewer(@NotNull Viewer viewer) Adds a new viewer to this context.
void	closeForEveryone() Closes this context's container to all viewers who are viewing it.
java.util.List<Component>	getComponentsAt(int position) Gets the component that is at a certain position.
@NotNull ViewConfig	getConfig() The configuration for this context.
@NotNull java.util.UUID	getId() An unique id for this context.
@NotNull java.util.Map<java.lang.String,Viewer>	getIndexedViewers() A Map containing all viewers in that context.
java.lang.Object	getInitialData() Data defined when a context is created, usually this is data set when the context is opened for a viewer.
@NotNull java.lang.String	getInitialTitle() The initial title of this context, that is, even if it has been changed, it will return the title that has been initially defined.
@NotNull RootView	getRoot() View root from which this context originated.
@NotNull @UnmodifiableView java.util.List<Viewer>	getViewers() An unmodifiable copy of all viewers that are tied to this context.
boolean	isActive() This is an internal inventory-framework API that should not be used from outside of this library.
boolean	isShared() 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.
void	openForEveryone(@NotNull java.lang.Class<? extends RootView> other) Opens a new view for all viewers in that context.
void	openForEveryone(@NotNull java.lang.Class<? extends RootView> other, java.lang.Object initialData) Opens a new view for all viewers in that context with an initially defined data.
void	removeComponent(@NotNull Component component) Removes a component from this context.
void	removeViewer(@NotNull Viewer viewer) Removes a new viewer to this context.
void	renderComponent(@NotNull Component component) Renders a component in this context.
void	resetTitleForEveryone() Updates the container title to all viewers in this context, to the initially defined title.
void	setActive(boolean active) This is an internal inventory-framework API that should not be used from outside of this library.
void	setInitialData(java.lang.Object initialData) 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.
void	update() Updates all components for all viewers in this context.
void	updateComponent(@NotNull Component component, boolean force) Updates a component in this context.
void	updateTitleForEveryone(@NotNull java.lang.String title) Updates the container title for everyone that's viewing it.

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

getId

@ApiStatus.Internal
 @NotNull
@NotNull java.util.UUID getId()

An unique id for this 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 unique identifier for this context.

getConfig

@NotNull
@NotNull ViewConfig getConfig()

The configuration for this context.

By default, contexts inherit their root configuration.

Returns:

The configuration for this context.

getViewers

@NotNull
@NotNull @UnmodifiableView java.util.List<Viewer> getViewers()

An unmodifiable copy of all viewers that are tied to this context.

Returns:

All view of all viewers.

getIndexedViewers

@NotNull
 @ApiStatus.Internal
@NotNull java.util.Map<java.lang.String,Viewer> getIndexedViewers()

A Map containing all viewers in that context.

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

Returns:

A Map containing all viewers in that context.

addViewer

@ApiStatus.Internal
void addViewer(@NotNull
                                   @NotNull Viewer viewer)

Adds a new viewer to this context.

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

Parameters:

viewer - The viewer that'll be added.

removeViewer

@ApiStatus.Internal
void removeViewer(@NotNull
                                      @NotNull Viewer viewer)

Removes a new viewer to this context.

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

Parameters:

viewer - The viewer that'll be removed.

getRoot

@NotNull
@NotNull RootView getRoot()

View root from which this context originated.

Returns:

The root of this context.

getInitialTitle

@NotNull
@NotNull java.lang.String getInitialTitle()

The initial title of this context, that is, even if it has been changed, it will return the title that has been initially defined.

Returns:

The initial title of this context, the current title of this view.

getComponentsAt

@ApiStatus.Internal
java.util.List<Component> getComponentsAt(int position)

Gets the component that is at a certain position.

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

Parameters:

position - The position.

Returns:

The component in the given position or null.

addComponent

@ApiStatus.Internal
void addComponent(@NotNull
                                      @NotNull Component component)

Adds a new component to this context.

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

Parameters:

component - The component to be added.

removeComponent

@ApiStatus.Internal
void removeComponent(@NotNull
                                         @NotNull Component component)

Removes a component from this context.

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

Parameters:

component - The component to be removed.

renderComponent

@ApiStatus.Internal
void renderComponent(@NotNull
                                         @NotNull Component component)

Renders a component in this context.

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

Parameters:

component - The component to be rendered.

updateComponent

@ApiStatus.Internal
void updateComponent(@NotNull
                                         @NotNull Component component,
                                         boolean force)

Updates a component in this context.

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

Parameters:

component - The component to be updated.

force - If update should be forced.

update

void update()

Updates all components for all viewers in this context.

getInitialData

java.lang.Object getInitialData()

Data defined when a context is created, usually this is data set when the context is opened for a viewer.

Returns:

The initial context data.

setInitialData

@ApiStatus.Internal
void setInitialData(java.lang.Object initialData)

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.

isShared

@ApiStatus.Experimental
boolean isShared()

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.

updateTitleForEveryone

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

Updates the container title for everyone that's viewing it.

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.

resetTitleForEveryone

void resetTitleForEveryone()

Updates the container title to all viewers in this context, to the initially defined title. Must be used after updateTitleForEveryone(String) to take effect.

closeForEveryone

void closeForEveryone()

Closes this context's container to all viewers who are viewing it.

openForEveryone

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

Opens a new view for all viewers in that context.

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

Parameters:

other - The view to be opened.

openForEveryone

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

Opens a new view for all viewers in that context 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 data.

isActive

@ApiStatus.Internal
boolean isActive()

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

setActive

@ApiStatus.Internal
void setActive(boolean active)

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