me.devnatan.inventoryframework.component

Class ItemComponent

java.lang.Object

me.devnatan.inventoryframework.component.ItemComponent

All Implemented Interfaces:

Component, InteractionHandler, VirtualView

public class ItemComponent
extends java.lang.Object
implements Component, InteractionHandler

Constructor Summary

Constructors

Constructor and Description

ItemComponent(VirtualView root, int position, java.lang.Object stack, boolean cancelOnClick, boolean closeOnClick, java.util.function.Predicate<? extends IFContext> displayCondition, java.util.function.Consumer<? super IFSlotRenderContext> renderHandler, java.util.function.Consumer<? super IFSlotContext> updateHandler, java.util.function.Consumer<? super IFSlotClickContext> clickHandler, java.util.Set<State<?>> watching, boolean isManagedExternally, boolean updateOnClick, boolean isVisible, Ref<Component> reference)

Method Summary

Modifier and Type	Method and Description
void	clear(@NotNull IFContext context) Clears this component from the given context.
void	clicked(@NotNull Component component, @NotNull IFSlotClickContext context) Called when a component is clicked.
boolean	equals(java.lang.Object o)
void	forceUpdate() Forces this component to be updated.
java.util.function.Consumer<? super IFSlotClickContext>	getClickHandler()
@NotNull InteractionHandler	getInteractionHandler() The interaction handler for this component.
java.lang.String	getKey() This is an internal inventory-framework API that should not be used from outside of this library.
int	getPosition() The current position of this component relative to its root view.
Ref<Component>	getReference() Returns the reference assigned to this component.
java.util.function.Consumer<? super IFSlotRenderContext>	getRenderHandler()
@NotNull VirtualView	getRoot() The root of this component.
java.lang.Object	getStack()
java.util.function.Consumer<? super IFSlotContext>	getUpdateHandler()
java.util.Set<State<?>>	getWatching()
@UnmodifiableView java.util.Set<State<?>>	getWatchingStates() An unmodifiable set of all states that this component is watching.
int	hashCode()
void	hide() Hides this component.
boolean	intersects(@NotNull Component other) If this component are intersects with other component.
boolean	isCancelOnClick()
boolean	isCloseOnClick()
boolean	isContainedWithin(int position) Checks if this component is in a specific position.
boolean	isManagedExternally() This is an internal inventory-framework API that should not be used from outside of this library.
boolean	isUpdateOnClick()
boolean	isVisible() If this component can be seen, it is used in interaction treatments to ensure that the viewer does not interact with hidden components.
void	render(@NotNull IFSlotRenderContext context) Renders this component to the given context.
void	setVisible(boolean visible) Sets the visibility state of this component.
boolean	shouldRender(IFContext context)
void	show() Shows this component.
java.lang.String	toString()
void	update() Updates this component.
void	updated(@NotNull IFSlotRenderContext context) Called when this component is updated in the given context.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

intersects

Constructor Detail

ItemComponent

public ItemComponent(VirtualView root,
                     int position,
                     java.lang.Object stack,
                     boolean cancelOnClick,
                     boolean closeOnClick,
                     java.util.function.Predicate<? extends IFContext> displayCondition,
                     java.util.function.Consumer<? super IFSlotRenderContext> renderHandler,
                     java.util.function.Consumer<? super IFSlotContext> updateHandler,
                     java.util.function.Consumer<? super IFSlotClickContext> clickHandler,
                     java.util.Set<State<?>> watching,
                     boolean isManagedExternally,
                     boolean updateOnClick,
                     boolean isVisible,
                     Ref<Component> reference)

Method Detail

getKey

public java.lang.String getKey()

Description copied from interface: Component

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

Specified by:

getKey in interface Component

getRoot

@NotNull
public @NotNull VirtualView getRoot()

Description copied from interface: Component

The root of this component.

Specified by:

getRoot in interface Component

Returns:

The root of this component.

getPosition

public int getPosition()

Description copied from interface: Component

The current position of this component relative to its root view.

Specified by:

getPosition in interface Component

Returns:

The current position of this component.

getStack

public java.lang.Object getStack()

isCancelOnClick

public boolean isCancelOnClick()

isCloseOnClick

public boolean isCloseOnClick()

isUpdateOnClick

public boolean isUpdateOnClick()

shouldRender

public boolean shouldRender(IFContext context)

Specified by:

shouldRender in interface Component

getRenderHandler

public java.util.function.Consumer<? super IFSlotRenderContext> getRenderHandler()

getUpdateHandler

public java.util.function.Consumer<? super IFSlotContext> getUpdateHandler()

getClickHandler

public java.util.function.Consumer<? super IFSlotClickContext> getClickHandler()

getWatching

public java.util.Set<State<?>> getWatching()

isContainedWithin

public boolean isContainedWithin(int position)

Description copied from interface: Component

Checks if this component is in a specific position.

Specified by:

isContainedWithin in interface Component

Parameters:

position - The position.

Returns:

If this component is contained in the given position.

intersects

public boolean intersects(@NotNull
                          @NotNull Component other)

Description copied from interface: Component

If this component are intersects with other component.

Specified by:

intersects in interface Component

Parameters:

other - The other component.

Returns:

If both this and other component intersects in area.

getInteractionHandler

@NotNull
public @NotNull InteractionHandler getInteractionHandler()

Description copied from interface: Component

The interaction handler for this component.

Specified by:

getInteractionHandler in interface Component

Returns:

The interaction handler for this component.

render

public void render(@NotNull
                   @NotNull IFSlotRenderContext context)

Description copied from interface: Component

Renders this component to the given context.

Specified by:

render in interface Component

Parameters:

context - The context that this component will be rendered on.

updated

public void updated(@NotNull
                    @NotNull IFSlotRenderContext context)

Description copied from interface: Component

Called when this component is updated in the given context.

Specified by:

updated in interface Component

Parameters:

context - The update context.

clear

public void clear(@NotNull
                  @NotNull IFContext context)

Description copied from interface: Component

Clears this component from the given context.

Specified by:

clear in interface Component

Parameters:

context - The context that this component will be cleared from.

update

public void update()

Description copied from interface: Component

Updates this component.

Specified by:

update in interface Component

getWatchingStates

public @UnmodifiableView java.util.Set<State<?>> getWatchingStates()

Description copied from interface: Component

An unmodifiable set of all states that this component is watching.

Specified by:

getWatchingStates in interface Component

Returns:

All states that this component is watching.

clicked

public void clicked(@NotNull
                    @NotNull Component component,
                    @NotNull
                    @NotNull IFSlotClickContext context)

Description copied from interface: InteractionHandler

Called when a component is clicked.

Specified by:

clicked in interface InteractionHandler

Parameters:

component - The clicked component.

context - The click context.

isVisible

public boolean isVisible()

Description copied from interface: Component

If this component can be seen, it is used in interaction treatments to ensure that the viewer does not interact with hidden components.

Specified by:

isVisible in interface Component

Returns:

If this component is visible.

setVisible

public void setVisible(boolean visible)

Description copied from interface: Component

Sets the visibility state of this component.

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

Specified by:

setVisible in interface Component

Parameters:

visible - If this component is visible.

isManagedExternally

public boolean isManagedExternally()

Description copied from interface: Component

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

Specified by:

isManagedExternally in interface Component

getReference

public Ref<Component> getReference()

Description copied from interface: Component

Returns the reference assigned to this component.

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.

Specified by:

getReference in interface Component

forceUpdate

public void forceUpdate()

Description copied from interface: Component

Forces this component to be updated.

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.

Specified by:

forceUpdate in interface Component

hide

public void hide()

Description copied from interface: Component

Hides this component.

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.

Specified by:

hide in interface Component

show

public void show()

Description copied from interface: Component

Shows this component.

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.

Specified by:

show in interface Component

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object