me.devnatan.inventoryframework

Interface Viewer

@ApiStatus.Internal
public interface Viewer

Method Summary

Modifier and Type	Method and Description
void	close() Closes the current container that this viewer is currently viewing.
@NotNull IFRenderContext	getActiveContext() This is an internal inventory-framework API that should not be used from outside of this library.
@NotNull java.lang.String	getId() Unique identifier for this viewer used for indexing.
long	getLastInteractionInMillis() This is an internal inventory-framework API that should not be used from outside of this library.
IFRenderContext	getPreviousContext() This is an internal inventory-framework API that should not be used from outside of this library.
@NotNull ViewContainer	getSelfContainer() An implementation of ViewContainer for the container of this viewer.
boolean	isBlockedByInteractionDelay() If this viewer is waiting for view's interaction delay to be able to interact again.
boolean	isTransitioning() This is an internal inventory-framework API that should not be used from outside of this library.
void	open(@NotNull ViewContainer container) Opens a container to this viewer.
void	setActiveContext(@NotNull IFRenderContext context) This is an internal inventory-framework API that should not be used from outside of this library.
void	setLastInteractionInMillis(long lastInteractionInMillis) Updates the value that holds the timestamp of the last interaction of this viewer.
void	setPreviousContext(IFRenderContext context) This is an internal inventory-framework API that should not be used from outside of this library.
void	setTransitioning(boolean transitioning) This is an internal inventory-framework API that should not be used from outside of this library.
void	unsetPreviousContext() This is an internal inventory-framework API that should not be used from outside of this library.

Method Detail

getId

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

Unique identifier for this viewer used for indexing.

Returns:

A unique identifier for this viewer.

open

void open(@NotNull
          @NotNull ViewContainer container)

Opens a container to this viewer.

Parameters:

container - The container that'll be opened.

close

void close()

Closes the current container that this viewer is currently viewing.

getSelfContainer

@NotNull
@NotNull ViewContainer getSelfContainer()

An implementation of ViewContainer for the container of this viewer.

Returns:

The container of this viewer.

getActiveContext

@ApiStatus.Internal
 @NotNull
@NotNull IFRenderContext getActiveContext()

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

setActiveContext

@ApiStatus.Internal
void setActiveContext(@NotNull
                                          @NotNull IFRenderContext context)

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

getLastInteractionInMillis

@ApiStatus.Internal
long getLastInteractionInMillis()

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

setLastInteractionInMillis

@ApiStatus.Internal
void setLastInteractionInMillis(long lastInteractionInMillis)

Updates the value that holds the timestamp of the last interaction of this viewer.

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

Parameters:

lastInteractionInMillis - Timestamp of the last interaction.

isBlockedByInteractionDelay

@ApiStatus.Experimental
boolean isBlockedByInteractionDelay()

If this viewer is waiting for view's interaction delay to be able to interact again.

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 this viewer cannot interact now.

isTransitioning

@ApiStatus.Internal
boolean isTransitioning()

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

setTransitioning

@ApiStatus.Internal
void setTransitioning(boolean transitioning)

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

getPreviousContext

@ApiStatus.Internal
IFRenderContext getPreviousContext()

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

setPreviousContext

@ApiStatus.Internal
void setPreviousContext(IFRenderContext context)

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

unsetPreviousContext

@ApiStatus.Internal
void unsetPreviousContext()

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