me.leoko.advancedgui.utils.components

Class TextInputComponent

java.lang.Object

me.leoko.advancedgui.utils.components.Component

me.leoko.advancedgui.utils.components.TextInputComponent

public class TextInputComponent
extends Component

The type Text input component.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID_PLACEHOLDER_SUFFIX The constant ID_PLACEHOLDER_SUFFIX.
static String	ID_TEXT_SUFFIX The constant ID_TEXT_SUFFIX.

Fields inherited from class me.leoko.advancedgui.utils.components.Component

clickAction, hidden, id, interaction

Constructor Summary

Constructors

Constructor and Description
TextInputComponent(String id, Action clickAction, boolean hidden, Interaction interaction, int x, int y, int width, int height, int padding, Color backgroundColor, Color backgroundColorActive, Font font, Color fontColor, Color fontColorPlaceholder, String placeHolder, @NotNull String defaultInput, InputHandler inputHandler, boolean registerPlaceholder) Instantiates a new TextInputComponent.

Method Summary

Modifier and Type	Method and Description
void	apply(Graphics graphic, org.bukkit.entity.Player player, GuiPoint cursor) Render the component on the provided graphic context.
TextInputComponent	clone(Interaction interaction) Clone the component with the new interaction.
void	dispose() Dispose the component.
String	getInput() Get current input for an interaction.
String	getRawInput() Get current raw input for an interaction.
String	getState(org.bukkit.entity.Player player, GuiPoint cursor) Gets the current state of the component for the given parameters.
boolean	isInBounds(org.bukkit.entity.Player player, GuiPoint cursor) Checks whether the cursor is in bounds of the component.
TextInputComponent	locateOn(Interaction interaction) Locate the same component on a different interaction.
void	onChat(org.bukkit.event.player.AsyncPlayerChatEvent event)
void	setInput(String input, boolean involveInputHandler) Sets input for an interaction.
void	setInputHandler(InputHandler inputHandler) Sets input handler.

Methods inherited from class me.leoko.advancedgui.utils.components.Component

getClickAction, getId, getInteraction, isHidden, locate, locate, onClick, setClickAction, setHidden

Methods inherited from class java.lang.Object

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

Field Detail

ID_TEXT_SUFFIX

public static final String ID_TEXT_SUFFIX

The constant ID_TEXT_SUFFIX.

See Also:

Constant Field Values

ID_PLACEHOLDER_SUFFIX

public static final String ID_PLACEHOLDER_SUFFIX

The constant ID_PLACEHOLDER_SUFFIX.

See Also:

Constant Field Values

Constructor Detail

TextInputComponent

public TextInputComponent(String id,
                          Action clickAction,
                          boolean hidden,
                          Interaction interaction,
                          int x,
                          int y,
                          int width,
                          int height,
                          int padding,
                          Color backgroundColor,
                          Color backgroundColorActive,
                          Font font,
                          Color fontColor,
                          Color fontColorPlaceholder,
                          String placeHolder,
                          @NotNull
                          @NotNull String defaultInput,
                          InputHandler inputHandler,
                          boolean registerPlaceholder)

Instantiates a new TextInputComponent.

Parameters:

id - the id

clickAction - the click action

hidden - the hidden

interaction - the interaction

x - the x

y - the y

width - the width

height - the height

padding - the padding

backgroundColor - the background color

backgroundColorActive - the background color active

font - the font

fontColor - the font color

fontColorPlaceholder - the font color placeholder

placeHolder - the place holder

defaultInput - the default input

inputHandler - whether to register a PAPI placeholder

registerPlaceholder - whether to register a PAPI placeholder

Method Detail

setInputHandler

public void setInputHandler(InputHandler inputHandler)

Sets input handler.

Parameters:

inputHandler - the input handler

apply

public void apply(Graphics graphic,
                  org.bukkit.entity.Player player,
                  GuiPoint cursor)

Description copied from class: Component

Render the component on the provided graphic context.

Specified by:

apply in class Component

Parameters:

graphic - the graphic

player - the player

cursor - the cursor

isInBounds

public boolean isInBounds(org.bukkit.entity.Player player,
                          GuiPoint cursor)

Description copied from class: Component

Checks whether the cursor is in bounds of the component.

Specified by:

isInBounds in class Component

Parameters:

player - the player

cursor - the cursor

Returns:

the boolean

getState

public String getState(org.bukkit.entity.Player player,
                       GuiPoint cursor)

Description copied from class: Component

Gets the current state of the component for the given parameters. This methods main purpose is to allow caching and reduce the need to render and send data. This method can be executed very frequently (by default every 50ms for every interacting player) so don't do any heavy calculations here.
If Component.apply(Graphics, Player, GuiPoint) renders different content, then the this method should return different strings. If it renders the same the return value should be the same.
A good way to achieve this is to just 'describe' what you would render. (e.g. the RectComponent returns x+"*"+y+"*"+width+"*"+height+"*"+color.getRGB())

Specified by:

getState in class Component

Parameters:

player - the player

cursor - the cursor

Returns:

the state

clone

public TextInputComponent clone(Interaction interaction)

Description copied from class: Component

Clone the component with the new interaction. Used to copy component tree when initializing new interactions.

Specified by:

clone in class Component

Parameters:

interaction - the interaction

Returns:

the component

locateOn

public TextInputComponent locateOn(Interaction interaction)

Description copied from class: Component

Locate the same component on a different interaction.
In most cases return value can safely be casted to concrete component class.
Alias for:
interaction.getComponentTree().locate(component.getId())

Overrides:

locateOn in class Component

Parameters:

interaction - the interaction

Returns:

the component

dispose

public void dispose()

Description copied from class: Component

Dispose the component.

Overrides:

dispose in class Component

setInput

public void setInput(String input,
                     boolean involveInputHandler)

Sets input for an interaction.

Parameters:

input - the input

involveInputHandler - whether to involve input handler

getInput

public String getInput()

Get current input for an interaction.

Returns:

the input

getRawInput

public String getRawInput()

Get current raw input for an interaction. This is what the player actually typed in before being processed.

Returns:

the raw input

onChat

public void onChat(org.bukkit.event.player.AsyncPlayerChatEvent event)