Package net.arcadiusmc.dom

Interface Attributes

public interface Attributes

Attribute name constants

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTION_TRIGGER	Trigger for BUTTON_ACTION.
static final String	ADVANCED_ITEM_TOOLTIPS	If item tooltips use advanced tooltips.
static final String	BUTTON_ACTION	Button action, executed when a ButtonElement button element is clicked.
static final String	CLASS	Class list attribute.
static final String	CLASS_NAME	Name of the linked java class in a JavaObjectElement
static final String	ENABLED	Enabled/disabled state attribute, used by <button> elements.
static final String	ID	ID attribute.
static final String	ITEM_TOOLTIP_HIDE	Item tooltip hide state attribute, used by <item> elements to determine whether the item tooltip should be hidden or not.
static final String	NAME	Option name attribute, used during parsing by the <option> element.
static final String	PLACEHOLDER	Used to specify the placeholder on an InputElement
static final String	SOURCE	Source attribute, used by <script>, <style> and <item> elements.
static final String	STYLE	Inline style attribute.
static final String	TYPE	Type attribute.
static final String	VALUE	Key attribute, used during parsing by the <option> element.

Method Summary

Static Methods

Modifier and Type	Method	Description
static boolean	boolAttribute(@Nullable String value, boolean fallback)
static Result<Float,String>	floatAttribute(String value, float min, float max)	Parses a float attribute value.

Field Details

ID

static final String ID

ID attribute.

See Also:

• Document.getElementById(String)
• Constant Field Values

CLASS

static final String CLASS

Class list attribute.

See Also:

• Constant Field Values

STYLE

static final String STYLE

Inline style attribute.

See Also:

• Constant Field Values

SOURCE

static final String SOURCE

Source attribute, used by <script>, <style> and <item> elements.

See Also:

• Constant Field Values

NAME

static final String NAME

Option name attribute, used during parsing by the <option> element.

See Also:

• Constant Field Values

VALUE

static final String VALUE

Key attribute, used during parsing by the <option> element.

See Also:

• Constant Field Values

ENABLED

static final String ENABLED

Enabled/disabled state attribute, used by <button> elements.

See Also:

• ButtonElement
• Constant Field Values

ITEM_TOOLTIP_HIDE

static final String ITEM_TOOLTIP_HIDE

Item tooltip hide state attribute, used by <item> elements to determine whether the item tooltip should be hidden or not.

See Also:

• ItemElement
• Constant Field Values

ADVANCED_ITEM_TOOLTIPS

static final String ADVANCED_ITEM_TOOLTIPS

If item tooltips use advanced tooltips. (Including the F3+H debug information).

This attribute overrides the Options.ADVANCED_ITEM_TOOLTIPS option, if it is set.

See Also:

• Options.ADVANCED_ITEM_TOOLTIPS
• Constant Field Values

BUTTON_ACTION

static final String BUTTON_ACTION

Button action, executed when a ButtonElement button element is clicked. Only works on button elements.

Valid value patterns

Pattern	Description	Example
close	Closes the page	"close"
cmd: <command>	Runs a command as console. You can use %player% as a placeholder for the player's name	"cmd: msg %player% Hello, world!
player-cmd: <command>	Runs a command as the player. You can use %player% as a placeholder for the player's name	"player-cmd: msg %player% Hello, me!

See Also:

• Constant Field Values

ACTION_TRIGGER

static final String ACTION_TRIGGER

Trigger for BUTTON_ACTION.

Supported values

Value	Triggers
left	When button is left-clicked
right	When button is right-clicked

See Also:

• Constant Field Values

CLASS_NAME

static final String CLASS_NAME

Name of the linked java class in a JavaObjectElement

See Also:

• Constant Field Values

TYPE

static final String TYPE

Type attribute.

Used in multiple places:

• On ComponentElements to specify what syntax to use when loading component data.
• On InputElements to specify what type of input they accept

See Also:

• Constant Field Values

PLACEHOLDER

static final String PLACEHOLDER

Used to specify the placeholder on an InputElement

See Also:

• Constant Field Values

Method Details

floatAttribute

static Result<Float,String> floatAttribute(String value,
 float min,
 float max)

Parses a float attribute value.

If the specified value cannot be parsed into a float, an erroneous result with the error "Invalid number" is returned.

If the number is parsed successfully, then it is clamped according to the min and max parameters.

Parameters:

value - Value to parse from

min - Minimum value

max - Maximum value

Returns:

Parsed float result

boolAttribute

static boolean boolAttribute(@Nullable
 @Nullable String value,
 boolean fallback)