com.github.stefvanschie.inventoryframework.pane.component

Class Label

java.lang.Object

com.github.stefvanschie.inventoryframework.pane.Pane

com.github.stefvanschie.inventoryframework.pane.OutlinePane

com.github.stefvanschie.inventoryframework.pane.component.Label

All Implemented Interfaces:

Flippable, Orientable, Rotatable

public class Label
extends OutlinePane

A label for displaying text.

Since:

0.5.0

Nested Class Summary

Nested classes/interfaces inherited from class com.github.stefvanschie.inventoryframework.pane.Pane

Pane.Priority

Nested classes/interfaces inherited from interface com.github.stefvanschie.inventoryframework.pane.Orientable

Orientable.Orientation

Field Summary

Fields inherited from class com.github.stefvanschie.inventoryframework.pane.Pane

height, length, onClick, x, y

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class com.github.stefvanschie.inventoryframework.pane.OutlinePane

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

Methods inherited from class com.github.stefvanschie.inventoryframework.pane.Pane

getHeight, getLength, getPriority, getPropertyMappings, getX, getY, isVisible, load, loadItem, 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

Methods inherited from interface com.github.stefvanschie.inventoryframework.pane.Flippable

load

Methods inherited from interface com.github.stefvanschie.inventoryframework.pane.Orientable

load

Methods inherited from interface com.github.stefvanschie.inventoryframework.pane.Rotatable

load

Constructor Detail

Label

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

Creates a new label

Parameters:

x - the x coordinate

y - the y coordinate

length - the length

height - the width

priority - the priority

font - the character set

Since:

0.5.0

Label

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

Creates a new label

Parameters:

x - the x coordinate

y - the y coordinate

length - the length

height - the width

font - the character set

Since:

0.5.0

Label

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

Creates a new label

Parameters:

length - the length

height - the width

font - the character set

Since:

0.5.0

Method Detail

setText

public void setText(@NotNull
                    String text)

Sets the text to be displayed in this label

Parameters:

text - the new text

Since:

0.5.0

click

public 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

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 String getText()

Gets the text currently displayed in this label

Returns:

the text in this label

Since:

0.5.0

getFont

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

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

Returns:

the character set

Since:

0.5.0

load

@NotNull
 @Contract(value="_, null -> fail",
          pure=true)
public static Label load(@NotNull
                                                                                              Object instance,
                                                                                              @NotNull
                                                                                              Element element)

Loads a label from a given element

Parameters:

instance - the instance class

element - the element

Returns:

the percentage bar