Interface InputElement

All Superinterfaces:

DomQueryable, Element, EventTarget, Node

public interface InputElement
extends Element

An element that can take in a player's input

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	InputElement.InputType	Input element type

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_PLACEHOLDER	Default placeholder value returned by getPlaceholder()

Method Summary

Modifier and Type	Method	Description
boolean	canHaveChildren()	Input elements cannot have child nodes.
@NotNull String	getPlaceholder()	Get the element's placeholder, or a fallback value, if not set.
String	getPrompt()	Get the Attributes.PROMPT attribute value.
@NotNull InputElement.InputType	getType()	Get the input type from the Attributes.TYPE attribute.
@Nullable String	getValue()	Get the inputted value
boolean	isDisabled()	Test if the element is disabled.
void	setDisabled(boolean disabled)	Set the Attributes.ENABLED attribute
void	setPlaceholder(@Nullable String placeholder)	Set the value of the Attributes.PLACEHOLDER attribute.
void	setPrompt(@Nullable String prompt)	Set the Attributes.PROMPT attribute value.
void	setType(@Nullable InputElement.InputType type)	Set the input type
void	setValue(@Nullable String value)	Set the inputted value.
void	setValue(@Nullable String value, @NotNull org.bukkit.entity.Player player)	Set the inputted value.

Methods inherited from interface com.juliewoolie.dom.DomQueryable

getElementsByClassName, getElementsByTagName, querySelector, querySelectorAll

Methods inherited from interface com.juliewoolie.dom.Element

appendChild, appendElement, appendText, clearChildren, firstChild, forEachDescendant, getAttribute, getAttributeEntries, getAttributeNames, getChild, getChildCount, getChildren, getClassList, getClassName, getCurrentStyle, getId, getStyle, getTagName, getTextContent, getTitleNode, getTooltip, getTooltipBehaviour, getTooltipDelay, hasAttribute, hasChild, hasChildren, indexOf, insertAfter, insertBefore, isDescendant, lastChild, matches, prependChild, removeAttribute, removeChild, removeChild, removeMatchingChildren, replaceChild, replaceChild, setAttribute, setClassName, setId, setTextContent, setTitleNode, setTooltipBehaviour, setTooltipDelay

Methods inherited from interface com.juliewoolie.dom.event.EventTarget

addEventListener, dispatchEvent, getOnAddAttribute, getOnAddOption, getOnAppendChild, getOnAttributeChange, getOnClick, getOnClosing, getOnInput, getOnLoaded, getOnMouseEnter, getOnMouseExit, getOnMouseMove, getOnOptionChange, getOnRemoveAttribute, getOnRemoveChild, getOnRemoveOption, getOnRightClick, getOnSetAttribute, getOnSetOption, getOnSpawned, onAddAttribute, onAddOption, onAppendChild, onAttributeChange, onClick, onClosing, onInput, onLoaded, onMouseEnter, onMouseExit, onMouseMove, onOptionChange, onRemoveAttribute, onRemoveChild, onRemoveOption, onRightClick, onSetAttribute, onSetOption, onSpawned, removeEventListener

Methods inherited from interface com.juliewoolie.dom.Node

enterVisitor, exitVisitor, getDepth, getOwningDocument, getParent, getRenderingBounds, getSiblingIndex, hasFlag, nextSibling, previousSibling

Field Details

DEFAULT_PLACEHOLDER

static final String DEFAULT_PLACEHOLDER

Default placeholder value returned by getPlaceholder()

See Also:

• Constant Field Values

Method Details

canHaveChildren

@Contract("-> false")
boolean canHaveChildren()

Input elements cannot have child nodes.

Specified by:

canHaveChildren in interface Element

Returns:

false

isDisabled

boolean isDisabled()

Test if the element is disabled.

This element can be disabled by setting the Attributes.ENABLED attribute to false.

Returns:

true, if the element is disabled, false otherwise

setDisabled

void setDisabled(boolean disabled)

Set the Attributes.ENABLED attribute

Parameters:

disabled - true to disable the element, false otherwise.

getPrompt

String getPrompt()

Get the Attributes.PROMPT attribute value.

The prompt is displayed to players when asking for input

Returns:

Prompt

setPrompt

void setPrompt(@Nullable
 @Nullable String prompt)

Set the Attributes.PROMPT attribute value.

The prompt is displayed to players when asking for input

Parameters:

prompt - Prompt

getType

@NotNull
@NotNull InputElement.InputType getType()

Get the input type from the Attributes.TYPE attribute.

If the attribute isn't set or its value does not map to an enum value, then InputElement.InputType.TEXT is returned.

Returns:

Input type

setType

void setType(@Nullable
 @Nullable InputElement.InputType type)

Set the input type

Parameters:

type - Input type, or null.

getValue

@Nullable
@Nullable String getValue()

Get the inputted value

Returns:

Inputted value, may be an empty string or null

setValue

void setValue(@Nullable
 @Nullable String value)

Set the inputted value.

Triggers a EventTypes.INPUT event.

Parameters:

value - New element value

setValue

void setValue(@Nullable
 @Nullable String value,
 @NotNull
 @NotNull org.bukkit.entity.Player player)

Set the inputted value.

Triggers a EventTypes.INPUT event.

Parameters:

value - New element value

player - Player that changed the element

getPlaceholder

@NotNull
@NotNull String getPlaceholder()

Get the element's placeholder, or a fallback value, if not set.

Placeholders are set with the Attributes.PLACEHOLDER attribute. If the attribute is not explicitly set, then this method returns DEFAULT_PLACEHOLDER.

Returns:

Placeholder

setPlaceholder

void setPlaceholder(@Nullable
 @Nullable String placeholder)

Set the value of the Attributes.PLACEHOLDER attribute.

Parameters:

placeholder - New placeholder