Package me.despical.inventoryframework.pane.component

Class Label

java.lang.Object

me.despical.inventoryframework.pane.Pane

me.despical.inventoryframework.pane.OutlinePane

me.despical.inventoryframework.pane.component.Label

All Implemented Interfaces:

Flippable, Orientable, Rotatable

public class Label
extends OutlinePane

A label for displaying text.

Since:

1.0.1

Created at 04.09.2020

Author:

Despical

Nested Class Summary

Nested classes/interfaces inherited from class me.despical.inventoryframework.pane.Pane

Pane.Priority

Nested classes/interfaces inherited from interface me.despical.inventoryframework.pane.Orientable

Orientable.Orientation

Field Summary

Fields inherited from class me.despical.inventoryframework.pane.Pane

height, length, onClick, x, y

Constructor Summary

Constructors

Constructor	Description
Label(int x, int y, int length, int height, @NotNull Font font)	Creates a new label
Label(int x, int y, int length, int height, @NotNull Pane.Priority priority, @NotNull Font font)	Creates a new label
Label(int length, int height, @NotNull Font font)	Creates a new label

Method Summary

Modifier and Type	Method	Description
boolean	click(@NotNull Gui gui, @NotNull org.bukkit.event.inventory.InventoryClickEvent event, int paneOffsetX, int paneOffsetY, int maxLength, int maxHeight)	Called whenever there is being clicked on this pane
@NotNull Font	getFont()	Gets the character set currently used for the text in this label
@NotNull String	getText()	Gets the text currently displayed in this label
static @NotNull Label	load(@NotNull Object instance, @NotNull Element element)	Loads a label from a given element
void	setText(@NotNull String text)	Sets the text to be displayed in this label

Methods inherited from class me.despical.inventoryframework.pane.OutlinePane

addItem, applyMask, clear, display, doesRepeat, flipHorizontally, flipVertically, getGap, getItems, getOrientation, getPanes, getRotation, insertItem, isFlippedHorizontally, isFlippedVertically, removeItem, setGap, setOrientation, setRepeat, setRotation

Methods inherited from class me.despical.inventoryframework.pane.Pane

findMatchingItem, getHeight, getLength, getPriority, getPropertyMappings, getX, getY, isVisible, load, loadItem, registerProperty, setHeight, setLength, setOnClick, setOnLocalClick, setPriority, setVisible, setX, setY

Methods inherited from class java.lang.Object

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

Constructor Details

Label

public Label(int x,
 int y,
 int length,
 int height,
 @NotNull
 @NotNull Pane.Priority priority,
 @NotNull
 @NotNull Font font)

Creates a new label

Parameters:

x - the x coordinate

y - the y coordinate

length - the length

height - the height

priority - the priority

font - the character set

Since:

1.0.1

Label

public Label(int x,
 int y,
 int length,
 int height,
 @NotNull
 @NotNull Font font)

Creates a new label

Parameters:

x - the x coordinate

y - the y coordinate

length - the length

height - the height

font - the character set

Since:

1.0.1

Label

public Label(int length,
 int height,
 @NotNull
 @NotNull Font font)

Creates a new label

Parameters:

length - the length

height - the height

font - the character set

Since:

1.0.1

Method Details

load

@NotNull
@Contract(pure=true)
public static @NotNull Label load(@NotNull
 @NotNull Object instance,
 @NotNull
 @NotNull Element element)

Loads a label from a given element

Parameters:

instance - the instance class

element - the element

Returns:

the percentage bar

click

public boolean click(@NotNull
 @NotNull Gui gui,
 @NotNull
 @NotNull org.bukkit.event.inventory.InventoryClickEvent event,
 int paneOffsetX,
 int paneOffsetY,
 int maxLength,
 int maxHeight)

Description copied from class: Pane

Called whenever there is being clicked on this pane

Overrides:

click in class OutlinePane

Parameters:

gui - the gui this event stems from

event - the event that occurred while clicking on this item

paneOffsetX - the pane's offset on the x axis

paneOffsetY - the pane's offset on the y axis

maxLength - the maximum length of the pane

maxHeight - the maximum height of the pane

Returns:

whether the item was found or not

getText

@Contract(pure=true)
@NotNull
public @NotNull String getText()

Gets the text currently displayed in this label

Returns:

the text in this label

Since:

1.0.1

setText

public void setText(@NotNull
 @NotNull String text)

Sets the text to be displayed in this label

Parameters:

text - the new text

Since:

1.0.1

getFont

@Contract(pure=true)
@NotNull
public @NotNull Font getFont()

Gets the character set currently used for the text in this label

Returns:

the character set

Since:

1.0.1