me.devnatan.inventoryframework.component

Interface Component

All Superinterfaces:

VirtualView

All Known Subinterfaces:

ComponentComposition, Pagination

All Known Implementing Classes:

ItemComponent

public interface Component
extends VirtualView

A component represents one or more items within a VirtualView.

Method Summary

Modifier and Type	Method and Description
void	clear(@NotNull IFContext context) Clears this component from the given context.
void	forceUpdate() Forces this component to be updated.
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.
@NotNull VirtualView	getRoot() The root of this component.
@UnmodifiableView java.util.Set<State<?>>	getWatchingStates() An unmodifiable set of all states that this component is watching.
void	hide() Hides this component.
boolean	intersects(@NotNull Component other) If this component are intersects with other component.
static boolean	intersects(@NotNull Component component, @NotNull Component other) Checks if two components area intersects with each other.
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	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.
void	update() Updates this component.
void	updated(@NotNull IFSlotRenderContext context) Called when this component is updated in the given context.

Method Detail

getKey

@ApiStatus.Internal
java.lang.String getKey()

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

getRoot

@NotNull
@NotNull VirtualView getRoot()

The root of this component.

Returns:

The root of this component.

getPosition

int getPosition()

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

Returns:

The current position of this component.

isContainedWithin

boolean isContainedWithin(int position)

Checks if this component is in a specific position.

Parameters:

position - The position.

Returns:

If this component is contained in the given position.

intersects

boolean intersects(@NotNull
                   @NotNull Component other)

If this component are intersects with other component.

Parameters:

other - The other component.

Returns:

If both this and other component intersects in area.

getInteractionHandler

InteractionHandler getInteractionHandler()

The interaction handler for this component.

Returns:

The interaction handler for this component.

render

void render(@NotNull
            @NotNull IFSlotRenderContext context)

Renders this component to the given context.

Parameters:

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

updated

void updated(@NotNull
             @NotNull IFSlotRenderContext context)

Called when this component is updated in the given context.

Parameters:

context - The update context.

clear

void clear(@NotNull
           @NotNull IFContext context)

Clears this component from the given context.

Parameters:

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

getWatchingStates

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

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

Returns:

All states that this component is watching.

isVisible

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.

Returns:

If this component is visible.

setVisible

@ApiStatus.Internal
void setVisible(boolean visible)

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.

Parameters:

visible - If this component is visible.

isManagedExternally

@ApiStatus.Internal
boolean isManagedExternally()

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

shouldRender

boolean shouldRender(IFContext context)

update

void update()

Updates this component.

intersects

static boolean intersects(@NotNull
                          @NotNull Component component,
                          @NotNull
                          @NotNull Component other)

Checks if two components area intersects with each other.

Parameters:

component - The component A.

other - The component B.

Returns:

If component B area conflicts with area of component A.

getReference

@ApiStatus.Experimental
Ref<Component> getReference()

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.

forceUpdate

@ApiStatus.Experimental
void forceUpdate()

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.

show

@ApiStatus.Experimental
void show()

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.

hide

@ApiStatus.Experimental
void hide()

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.