Package me.devnatan.inventoryframework.context

Class SlotClickContext

java.lang.Object

me.devnatan.inventoryframework.state.DefaultStateValueHost

me.devnatan.inventoryframework.context.PlatformContext

me.devnatan.inventoryframework.context.SlotContext

me.devnatan.inventoryframework.context.SlotClickContext

All Implemented Interfaces:

Iterable<me.devnatan.inventoryframework.component.Component>, me.devnatan.inventoryframework.component.ComponentContainer, Context, me.devnatan.inventoryframework.context.IFConfinedContext, me.devnatan.inventoryframework.context.IFContext, me.devnatan.inventoryframework.context.IFSlotClickContext, me.devnatan.inventoryframework.context.IFSlotContext, me.devnatan.inventoryframework.state.StateValueHost, me.devnatan.inventoryframework.VirtualView

public class SlotClickContext
extends SlotContext
implements me.devnatan.inventoryframework.context.IFSlotClickContext

Field Summary

Fields

Modifier and Type	Field	Description
protected me.devnatan.inventoryframework.ViewConfig	config

Constructor Summary

Constructors

Constructor	Description
SlotClickContext(int slot, @NotNull me.devnatan.inventoryframework.context.IFRenderContext parent, @NotNull me.devnatan.inventoryframework.Viewer whoClicked, @NotNull me.devnatan.inventoryframework.ViewContainer clickedContainer, @Nullable me.devnatan.inventoryframework.component.Component clickedComponent, @NotNull org.bukkit.event.inventory.InventoryClickEvent clickOrigin, boolean combined)

Method Summary

Modifier and Type	Method	Description
final void	addViewer(me.devnatan.inventoryframework.Viewer arg0)
final void	closeForPlayer()
final @NotNull me.devnatan.inventoryframework.ViewContainer	getClickedContainer()
final int	getClickedSlot()
final String	getClickIdentifier()
@NotNull org.bukkit.event.inventory.InventoryClickEvent	getClickOrigin()	The event that triggered this context.
final me.devnatan.inventoryframework.component.Component	getComponent()
final String	getInitialTitle()
final org.bukkit.inventory.ItemStack	getItem()	The item that was clicked.
final Object	getPlatformEvent()
final @NotNull org.bukkit.entity.Player	getPlayer()	The player who clicked on the slot.
final me.devnatan.inventoryframework.Viewer	getViewer()
final List<me.devnatan.inventoryframework.Viewer>	getViewers()
final boolean	isCancelled()
final boolean	isCombined()
final boolean	isKeyboardClick()
final boolean	isLeftClick()
final boolean	isMiddleClick()
final boolean	isOnEntityContainer()
final boolean	isOutsideClick()
final boolean	isRightClick()
final boolean	isShared()
final boolean	isShiftClick()
final Iterator<me.devnatan.inventoryframework.component.Component>	iterator()
final void	openForPlayer(@NotNull Class<? extends me.devnatan.inventoryframework.RootView> other)
final void	openForPlayer(@NotNull Class<? extends me.devnatan.inventoryframework.RootView> other, Object initialData)
final void	removeViewer(me.devnatan.inventoryframework.Viewer arg0)
final void	resetTitleForPlayer()
final void	setCancelled(boolean cancelled)
(package private) final void	tryThrowDoNotWorkWithSharedContext()
(package private) final void	tryThrowDoNotWorkWithSharedContext(String arg0)
final void	updateTitleForPlayer(@NotNull String title)

Methods inherited from class me.devnatan.inventoryframework.context.SlotContext

addComponent, back, back, canBack, getAllPlayers, getComponents, getComponentsAt, getConfig, getContainer, getId, getIndexedViewers, getInitialData, getInternalComponents, getInternalStateValue, getParent, getRawStateValue, getRoot, getSlot, getTitle, getUninitializedStateValue, initializeState, isActive, isEndless, performClickInComponent, removeComponent, renderComponent, resetTitleForPlayer, setActive, setEndless, setInitialData, setSlot, update, updateComponent, updateState, updateTitleForPlayer, watchState

Methods inherited from class me.devnatan.inventoryframework.context.PlatformContext

closeForEveryone, getContainerOrThrow, getUpdatedTitle, openForEveryone, openForEveryone, resetTitleForEveryone, toString, updateTitleForEveryone

Methods inherited from class me.devnatan.inventoryframework.state.DefaultStateValueHost

getStateValues

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getComponents, getInternalComponents

Methods inherited from interface me.devnatan.inventoryframework.context.IFConfinedContext

back, back, canBack

Methods inherited from interface me.devnatan.inventoryframework.context.IFContext

addComponent, addViewer, closeForEveryone, getComponentsAt, getConfig, getId, getIndexedViewers, getInitialData, getInitialTitle, getRoot, getViewers, isActive, isEndless, isShared, openForEveryone, openForEveryone, performClickInComponent, removeComponent, removeViewer, renderComponent, resetTitleForEveryone, setActive, setEndless, setInitialData, update, updateComponent, updateTitleForEveryone

Methods inherited from interface me.devnatan.inventoryframework.context.IFSlotClickContext

isShiftLeftClick, isShiftRightClick

Methods inherited from interface me.devnatan.inventoryframework.context.IFSlotContext

getContainer, getParent, getSlot, setSlot

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface me.devnatan.inventoryframework.state.StateValueHost

getInternalStateValue, getRawStateValue, getStateValues, getUninitializedStateValue, initializeState, updateState, watchState

Field Details

config

protected me.devnatan.inventoryframework.ViewConfig config

Constructor Details

SlotClickContext

@Internal
public SlotClickContext(int slot,
 @NotNull
 @NotNull me.devnatan.inventoryframework.context.IFRenderContext parent,
 @NotNull
 @NotNull me.devnatan.inventoryframework.Viewer whoClicked,
 @NotNull
 @NotNull me.devnatan.inventoryframework.ViewContainer clickedContainer,
 @Nullable
 @Nullable me.devnatan.inventoryframework.component.Component clickedComponent,
 @NotNull
 @NotNull org.bukkit.event.inventory.InventoryClickEvent clickOrigin,
 boolean combined)

Method Details

getPlayer

@NotNull
public final @NotNull org.bukkit.entity.Player getPlayer()

The player who clicked on the slot.

Specified by:

getPlayer in interface Context

Returns:

A player in this interaction context.

getClickOrigin

@NotNull
public @NotNull org.bukkit.event.inventory.InventoryClickEvent getClickOrigin()

The event that triggered this context.

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

getItem

public final org.bukkit.inventory.ItemStack getItem()

The item that was clicked.

Specified by:

getItem in class SlotContext

getComponent

public final me.devnatan.inventoryframework.component.Component getComponent()

Specified by:

getComponent in interface me.devnatan.inventoryframework.context.IFSlotClickContext

getClickedContainer

@NotNull
public final @NotNull me.devnatan.inventoryframework.ViewContainer getClickedContainer()

Specified by:

getClickedContainer in interface me.devnatan.inventoryframework.context.IFSlotClickContext

isCancelled

public final boolean isCancelled()

Specified by:

isCancelled in interface me.devnatan.inventoryframework.context.IFSlotClickContext

setCancelled

public final void setCancelled(boolean cancelled)

Specified by:

setCancelled in interface me.devnatan.inventoryframework.context.IFSlotClickContext

getPlatformEvent

public final Object getPlatformEvent()

Specified by:

getPlatformEvent in interface me.devnatan.inventoryframework.context.IFSlotClickContext

getClickedSlot

public final int getClickedSlot()

Specified by:

getClickedSlot in interface me.devnatan.inventoryframework.context.IFSlotClickContext

isLeftClick

public final boolean isLeftClick()

Specified by:

isLeftClick in interface me.devnatan.inventoryframework.context.IFSlotClickContext

isRightClick

public final boolean isRightClick()

Specified by:

isRightClick in interface me.devnatan.inventoryframework.context.IFSlotClickContext

isMiddleClick

public final boolean isMiddleClick()

Specified by:

isMiddleClick in interface me.devnatan.inventoryframework.context.IFSlotClickContext

isShiftClick

public final boolean isShiftClick()

Specified by:

isShiftClick in interface me.devnatan.inventoryframework.context.IFSlotClickContext

isKeyboardClick

public final boolean isKeyboardClick()

Specified by:

isKeyboardClick in interface me.devnatan.inventoryframework.context.IFSlotClickContext

isOutsideClick

public final boolean isOutsideClick()

Specified by:

isOutsideClick in interface me.devnatan.inventoryframework.context.IFSlotClickContext

getClickIdentifier

public final String getClickIdentifier()

Specified by:

getClickIdentifier in interface me.devnatan.inventoryframework.context.IFSlotClickContext

isOnEntityContainer

public final boolean isOnEntityContainer()

Specified by:

isOnEntityContainer in interface me.devnatan.inventoryframework.context.IFSlotContext

getViewer

public final me.devnatan.inventoryframework.Viewer getViewer()

Specified by:

getViewer in interface me.devnatan.inventoryframework.context.IFConfinedContext

closeForPlayer

public final void closeForPlayer()

Specified by:

closeForPlayer in interface me.devnatan.inventoryframework.context.IFConfinedContext

openForPlayer

public final void openForPlayer(@NotNull
 @NotNull Class<? extends me.devnatan.inventoryframework.RootView> other)

Specified by:

openForPlayer in interface me.devnatan.inventoryframework.context.IFConfinedContext

openForPlayer

public final void openForPlayer(@NotNull
 @NotNull Class<? extends me.devnatan.inventoryframework.RootView> other,
 Object initialData)

Specified by:

openForPlayer in interface me.devnatan.inventoryframework.context.IFConfinedContext

updateTitleForPlayer

public final void updateTitleForPlayer(@NotNull
 @NotNull String title)

Specified by:

updateTitleForPlayer in interface me.devnatan.inventoryframework.context.IFConfinedContext

resetTitleForPlayer

public final void resetTitleForPlayer()

Specified by:

resetTitleForPlayer in interface me.devnatan.inventoryframework.context.IFConfinedContext

isCombined

public final boolean isCombined()

Specified by:

isCombined in interface me.devnatan.inventoryframework.context.IFSlotClickContext

getViewers

@NotNull
public final List<me.devnatan.inventoryframework.Viewer> getViewers()

Specified by:

getViewers in interface me.devnatan.inventoryframework.context.IFContext

addViewer

public final void addViewer(@NotNull
 me.devnatan.inventoryframework.Viewer arg0)

Specified by:

addViewer in interface me.devnatan.inventoryframework.context.IFContext

removeViewer

public final void removeViewer(@NotNull
 me.devnatan.inventoryframework.Viewer arg0)

Specified by:

removeViewer in interface me.devnatan.inventoryframework.context.IFContext

getInitialTitle

@NotNull
public final String getInitialTitle()

Specified by:

getInitialTitle in interface me.devnatan.inventoryframework.context.IFContext

isShared

public final boolean isShared()

Specified by:

isShared in interface me.devnatan.inventoryframework.context.IFContext

iterator

@NotNull
public final Iterator<me.devnatan.inventoryframework.component.Component> iterator()

Specified by:

iterator in interface Iterable<me.devnatan.inventoryframework.component.Component>

tryThrowDoNotWorkWithSharedContext

final void tryThrowDoNotWorkWithSharedContext()

tryThrowDoNotWorkWithSharedContext

final void tryThrowDoNotWorkWithSharedContext(String arg0)