WItemSlot (LibGui 4.0.0-alpha.1+21w11a API)

java.lang.Object
- io.github.cottonmc.cotton.gui.widget.WWidget
- - io.github.cottonmc.cotton.gui.widget.WItemSlot

```
public class WItemSlot
extends WWidget
```
A widget that displays an item that can be interacted with.
Item slot widgets can contain multiple visual slots themselves. For example, a slot widget might be 5x3 with 15 visual slots in total.
Item slots are handled with so-called peers in the background. They are instances of ValidatedSlot that handle the interactions between the player and the widget.
Filters
Item slots can have filters that check whether a player is allowed to insert an item or not. The filter can be set with setFilter(Predicate). For example:
```
 
 // Only sand in this slot!
 slot.setFilter(stack -> stack.getItem() == Items.SAND);
 
 
```
Listeners
Slot change listeners are instances of WItemSlot.ChangeListener that can handle changes to item stacks in slots. For example:
```
 
 slot.addChangeListener((slot, inventory, index, stack) -> {
     if (stack.isEmpty() || stack.getCount() < stack.getMaxCount()) {
         System.out.println("I'm not full yet!");
     }
 });
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface WItemSlot.ChangeListener
A listener for changes in an item slot.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`WItemSlot.ChangeListener` A listener for changes in an item slot.

Field Summary
- Fields inherited from class io.github.cottonmc.cotton.gui.widget.WWidget
  height, host, parent, width, x, y

Constructor Summary

Constructors
Constructor and Description
`WItemSlot(net.minecraft.inventory.Inventory inventory, int startIndex, int slotsWide, int slotsHigh, boolean big)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChangeListener(WItemSlot.ChangeListener listener)` Adds a change listener to this slot.
`void`	`addPainters()` Adds the default background painters to this widget and all children.
`boolean`	`canFocus()` Tests whether this widget can have the focus in the GUI.
`protected ValidatedSlot`	`createSlotPeer(net.minecraft.inventory.Inventory inventory, int index, int x, int y)` Creates a slot peer for this slot widget.
`@Nullable WWidget`	`cycleFocus(boolean lookForwards)` Cycles the focus inside this widget.
`@Nullable BackgroundPainter`	`getBackgroundPainter()` Gets this slot widget's background painter.
`java.util.function.Predicate<net.minecraft.item.ItemStack>`	`getFilter()` Gets the item filter of this item slot.
`int`	`getFocusedSlot()` Gets the currently focused slot index.
`int`	`getHeight()`
`int`	`getWidth()`
`boolean`	`isBigSlot()`
`boolean`	`isInsertingAllowed()` Returns whether items can be inserted into this slot.
`boolean`	`isModifiable()` Returns true if the contents of this `WItemSlot` can be modified by players.
`boolean`	`isTakingAllowed()` Returns whether items can be taken from this slot.
`static WItemSlot`	`of(net.minecraft.inventory.Inventory inventory, int index)`
`static WItemSlot`	`of(net.minecraft.inventory.Inventory inventory, int startIndex, int slotsWide, int slotsHigh)`
`static WItemSlot`	`ofPlayerStorage(net.minecraft.inventory.Inventory inventory)` Creates a 9x3 slot widget from the "main" part of a player inventory.
`void`	`onHidden()` Notifies this widget that it won't be drawn and hides any visible peers of itself and its children.
`void`	`onKeyPressed(int ch, int key, int modifiers)` Notifies this widget that a key has been pressed.
`void`	`onShown()` Notifies this widget that it is visible and shows any hidden peers of itself and its children.
`static WItemSlot`	`outputOf(net.minecraft.inventory.Inventory inventory, int index)`
`void`	`paint(net.minecraft.client.util.math.MatrixStack matrices, int x, int y, int mouseX, int mouseY)` Paints this widget.
`void`	`setBackgroundPainter(@Nullable BackgroundPainter painter)` Sets this item slot's background painter.
`WItemSlot`	`setFilter(java.util.function.Predicate<net.minecraft.item.ItemStack> filter)` Sets the item filter of this item slot.
`WItemSlot`	`setInsertingAllowed(boolean insertingAllowed)` Sets whether inserting items into this slot is allowed.
`WItemSlot`	`setModifiable(boolean modifiable)`
`WItemSlot`	`setTakingAllowed(boolean takingAllowed)` Sets whether taking items from this slot is allowed.
`void`	`validate(GuiDescription host)` Creates component peers, lays out children, and initializes animation data for this Widget and all its children.

Methods inherited from class io.github.cottonmc.cotton.gui.widget.WWidget
addTooltip, canResize, createPeers, getAbsoluteX, getAbsoluteY, getHost, getParent, getX, getY, hit, isActivationKey, isFocused, isWithinBounds, onCharTyped, onClick, onFocusGained, onFocusLost, onKeyReleased, onMouseDown, onMouseDrag, onMouseMove, onMouseScroll, onMouseUp, releaseFocus, renderTooltip, requestFocus, setHost, setLocation, setParent, setSize, tick

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WItemSlot
```
public WItemSlot(net.minecraft.inventory.Inventory inventory,
                 int startIndex,
                 int slotsWide,
                 int slotsHigh,
                 boolean big)
```
- Method Detail
  - of
```
public static WItemSlot of(net.minecraft.inventory.Inventory inventory,
                           int index)
```
  - of
```
public static WItemSlot of(net.minecraft.inventory.Inventory inventory,
                           int startIndex,
                           int slotsWide,
                           int slotsHigh)
```
  - outputOf
```
public static WItemSlot outputOf(net.minecraft.inventory.Inventory inventory,
                                 int index)
```
  - ofPlayerStorage
```
public static WItemSlot ofPlayerStorage(net.minecraft.inventory.Inventory inventory)
```
    Creates a 9x3 slot widget from the "main" part of a player inventory.
    
    Parameters:
    
    inventory - the player inventory
    
    Returns:
    
    the created slot widget
    
    See Also:
    
    WPlayerInvPanel
  - getWidth
```
public int getWidth()
```
    Overrides:
    
    getWidth in class WWidget
  - getHeight
```
public int getHeight()
```
    Overrides:
    
    getHeight in class WWidget
  - canFocus
```
public boolean canFocus()
```
    Description copied from class: WWidget
    
    Tests whether this widget can have the focus in the GUI.
    
    Overrides:
    
    canFocus in class WWidget
    
    Returns:
    
    true if this widget can be focused, false otherwise
  - isBigSlot
```
public boolean isBigSlot()
```
  - isModifiable
```
public boolean isModifiable()
```
    Returns true if the contents of this WItemSlot can be modified by players.
    
    Returns:
    
    true if items can be inserted into or taken from this slot widget, false otherwise
    
    Since:
    
    1.8.0
  - setModifiable
```
public WItemSlot setModifiable(boolean modifiable)
```
  - isInsertingAllowed
```
public boolean isInsertingAllowed()
```
    Returns whether items can be inserted into this slot.
    
    Returns:
    
    true if items can be inserted, false otherwise
    
    Since:
    
    1.10.0
  - setInsertingAllowed
```
public WItemSlot setInsertingAllowed(boolean insertingAllowed)
```
    Sets whether inserting items into this slot is allowed.
    
    Parameters:
    
    insertingAllowed - true if items can be inserted, false otherwise
    
    Returns:
    
    this slot widget
    
    Since:
    
    1.10.0
  - isTakingAllowed
```
public boolean isTakingAllowed()
```
    Returns whether items can be taken from this slot.
    
    Returns:
    
    true if items can be taken, false otherwise
    
    Since:
    
    1.10.0
  - setTakingAllowed
```
public WItemSlot setTakingAllowed(boolean takingAllowed)
```
    Sets whether taking items from this slot is allowed.
    
    Parameters:
    
    takingAllowed - true if items can be taken, false otherwise
    
    Returns:
    
    this slot widget
    
    Since:
    
    1.10.0
  - getFocusedSlot
```
public int getFocusedSlot()
```
    Gets the currently focused slot index.
    
    Returns:
    
    the currently focused slot, or -1 if this widget isn't focused
    
    Since:
    
    2.0.0
  - validate
```
public void validate(GuiDescription host)
```
    Description copied from class: WWidget
    
    Creates component peers, lays out children, and initializes animation data for this Widget and all its children. The host container must clear any heavyweight peers from its records before this method is called.
    
    Overrides:
    
    validate in class WWidget
    
    Parameters:
    
    host - the host GUI description
  - onKeyPressed
```
@Environment(value=CLIENT)
public void onKeyPressed(int ch,
                                                     int key,
                                                     int modifiers)
```
    Description copied from class: WWidget
    
    Notifies this widget that a key has been pressed.
    
    Overrides:
    
    onKeyPressed in class WWidget
    
    key - the GLFW scancode of the key
  - createSlotPeer
```
protected ValidatedSlot createSlotPeer(net.minecraft.inventory.Inventory inventory,
                                       int index,
                                       int x,
                                       int y)
```
    Creates a slot peer for this slot widget.
    
    Parameters:
    
    inventory - the slot inventory
    
    index - the index in the inventory
    
    x - the X coordinate
    
    y - the Y coordinate
    
    Returns:
    
    the created slot instance
    
    Since:
    
    1.11.0
  - getBackgroundPainter
```
@Nullable
 @Environment(value=CLIENT)
public @Nullable BackgroundPainter getBackgroundPainter()
```
    Gets this slot widget's background painter.
    
    Returns:
    
    the background painter
    
    Since:
    
    2.0.0
  - setBackgroundPainter
```
@Environment(value=CLIENT)
public void setBackgroundPainter(@Nullable
                                                             @Nullable BackgroundPainter painter)
```
    Sets this item slot's background painter.
    
    Parameters:
    
    painter - the new painter
  - getFilter
```
public java.util.function.Predicate<net.minecraft.item.ItemStack> getFilter()
```
    Gets the item filter of this item slot.
    
    Returns:
    
    the item filter
    
    Since:
    
    2.0.0
  - setFilter
```
public WItemSlot setFilter(java.util.function.Predicate<net.minecraft.item.ItemStack> filter)
```
    Sets the item filter of this item slot.
    
    Parameters:
    
    filter - the new item filter
    
    Returns:
    
    this item slot
    
    Since:
    
    2.0.0
  - paint
```
@Environment(value=CLIENT)
public void paint(net.minecraft.client.util.math.MatrixStack matrices,
                                              int x,
                                              int y,
                                              int mouseX,
                                              int mouseY)
```
    Description copied from class: WWidget
    
    Paints this widget.
    
    Overrides:
    
    paint in class WWidget
    
    Parameters:
    
    matrices - the rendering matrix stack
    
    x - this widget's X coordinate on the screen
    
    y - this widget's Y coordinate on the screen
    
    mouseX - the X coordinate of the cursor
    
    mouseY - the X coordinate of the cursor
  - cycleFocus
```
@Nullable
public @Nullable WWidget cycleFocus(boolean lookForwards)
```
    Description copied from class: WWidget
    
    Cycles the focus inside this widget.
    If this widget is not focusable, returns null.
    
    Overrides:
    
    cycleFocus in class WWidget
    
    Parameters:
    
    lookForwards - whether this should cycle forwards (true) or backwards (false)
    
    Returns:
    
    the next focused widget, or null if should exit to the parent panel
  - addChangeListener
```
public void addChangeListener(WItemSlot.ChangeListener listener)
```
    Adds a change listener to this slot. Does nothing if the listener is already registered.
    
    Parameters:
    
    listener - the added listener
    
    Throws:
    
    java.lang.NullPointerException - if the listener is null
    
    Since:
    
    3.0.0
  - onShown
```
public void onShown()
```
    Description copied from class: WWidget
    
    Notifies this widget that it is visible and shows any hidden peers of itself and its children.
    
    Overrides:
    
    onShown in class WWidget
  - onHidden
```
public void onHidden()
```
    Description copied from class: WWidget
    
    Notifies this widget that it won't be drawn and hides any visible peers of itself and its children.
    The default implementation releases this widget's focus if it is focused. Overriding implementations might want to do this as well.
    
    Overrides:
    
    onHidden in class WWidget
  - addPainters
```
@Environment(value=CLIENT)
public void addPainters()
```
    Description copied from class: WWidget
    
    Adds the default background painters to this widget and all children.
    Always called before GuiDescription.addPainters() to allow users to modify painters.
    
    Overrides:
    
    addPainters in class WWidget

Class WItemSlot

Filters

Listeners

Nested Class Summary

Field Summary

Fields inherited from class io.github.cottonmc.cotton.gui.widget.WWidget

Constructor Summary

Method Summary

Methods inherited from class io.github.cottonmc.cotton.gui.widget.WWidget

Methods inherited from class java.lang.Object

Constructor Detail

WItemSlot

Method Detail

of

of

outputOf

ofPlayerStorage

getWidth

getHeight

canFocus

isBigSlot

isModifiable

setModifiable

isInsertingAllowed

setInsertingAllowed

isTakingAllowed

setTakingAllowed

getFocusedSlot

validate

onKeyPressed

createSlotPeer

getBackgroundPainter

setBackgroundPainter

getFilter

setFilter

paint

cycleFocus

addChangeListener

onShown

onHidden

addPainters