Interface ButtonElement

All Superinterfaces:

DomQueryable, Element, EventTarget, Node

public interface ButtonElement
extends Element

Button elements play a sound when clicked

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	ButtonElement.ButtonAction	Button action.
static enum	ButtonElement.ButtonActionType	Button action type
static enum	ButtonElement.ButtonTrigger	Button action trigger

Method Summary

Modifier and Type	Method	Description
@Nullable ButtonElement.ButtonAction	getAction()	Get the button action, shorthand for accessing the Attributes.BUTTON_ACTION attribute's value.
@NotNull ButtonElement.ButtonTrigger	getTrigger()	Get the button trigger, used for getAction().
boolean	isEnabled()	Test if the button is enabled
void	setAction(@Nullable ButtonElement.ButtonAction action)	Set the button action, shorthand for setting the Attributes.BUTTON_ACTION attribute's value.
void	setEnabled(boolean enabled)	Set if the button is enabled
void	setTrigger(@Nullable ButtonElement.ButtonTrigger trigger)	Set the button trigger, used for getAction().

Methods inherited from interface com.juliewoolie.dom.DomQueryable

getElementsByClassName, getElementsByTagName, querySelector, querySelectorAll

Methods inherited from interface com.juliewoolie.dom.Element

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

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

Method Details

isEnabled

boolean isEnabled()

Test if the button is enabled

Shortcut for accessing the Attributes.ENABLED attribute.

Returns:

true, if the button is enabled, false otherwise.

setEnabled

void setEnabled(boolean enabled)

Set if the button is enabled

Shortcut for setting the Attributes.ENABLED attribute.

Parameters:

enabled - true, if the button is enabled, false otherwise.

getTrigger

@NotNull
@NotNull ButtonElement.ButtonTrigger getTrigger()

Get the button trigger, used for getAction().

If the Attributes.ACTION_TRIGGER attribute is not set, this will default to ButtonElement.ButtonTrigger.DEFAULT.

Returns:

Button trigger

setTrigger

void setTrigger(@Nullable
 @Nullable ButtonElement.ButtonTrigger trigger)

Set the button trigger, used for getAction().

Shorthand for setting the Attributes.ACTION_TRIGGER attribute value.

Parameters:

trigger - Trigger value

getAction

@Nullable
@Nullable ButtonElement.ButtonAction getAction()

Get the button action, shorthand for accessing the Attributes.BUTTON_ACTION attribute's value.

The returned action is executed when the button is clicked with the same mouse button as getTrigger().

Returns:

Button action, or null, if the underlying attribute is not set.

setAction

void setAction(@Nullable
 @Nullable ButtonElement.ButtonAction action)

Set the button action, shorthand for setting the Attributes.BUTTON_ACTION attribute's value.

The set action is executed when the button is clicked with the same mouse button as getTrigger().

Parameters:

action - Button action