org.dominokit.domino.ui.button

Class BaseButton<B extends BaseButton<?>>

java.lang.Object

org.dominokit.domino.ui.utils.BaseDominoElement<E,T>

org.dominokit.domino.ui.style.WavesElement<elemental2.dom.HTMLElement,B>

org.dominokit.domino.ui.button.BaseButton<B>

Type Parameters:

B - The button subclass being wrapped

All Implemented Interfaces:

DominoStyle<elemental2.dom.HTMLElement,B,B>, HasWaveEffect<B>, HasBackground<B>, HasChildren<B>, HasClickableElement, HasContent<B>, HasWavesElement, IsCollapsible<B>, IsReadOnly<B>, Sizable<B>, Switchable<B>, org.jboss.elemento.IsElement<elemental2.dom.HTMLElement>

Direct Known Subclasses:

Button, DropdownButton, ScrollTop

public abstract class BaseButton<B extends BaseButton<?>>
extends WavesElement<elemental2.dom.HTMLElement,B>
implements HasClickableElement, Sizable<B>, HasBackground<B>, HasContent<B>, Switchable<B>

A base component to implement buttons

this class provides commons functionality and methods used in different implementations of a button

Nested Class Summary

Nested classes/interfaces inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

BaseDominoElement.ElementHandler<T>, BaseDominoElement.ResizeHandler<T>, BaseDominoElement.StyleEditor<E extends elemental2.dom.HTMLElement,T extends org.jboss.elemento.IsElement<E>>, BaseDominoElement.WavesStyler

Field Summary

Fields

Modifier and Type	Field and Description
protected DominoElement<elemental2.dom.HTMLButtonElement>	buttonElement The default element that represent the button HTMLElement.
protected String	content

Fields inherited from class org.dominokit.domino.ui.style.WavesElement

wavesSupport

Fields inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

element

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseButton() creates a button with default size ButtonSize.MEDIUM
protected	BaseButton(BaseIcon icon) creates a button with an icon and default size ButtonSize.MEDIUM
protected	BaseButton(BaseIcon icon, StyleType type) creates a button with an icon and default size ButtonSize.MEDIUM and apply a predefined StyleType
protected	BaseButton(String content) creates a button with text and default size ButtonSize.MEDIUM
	BaseButton(String content, Color background) creates a button with a text and default size ButtonSize.MEDIUM and apply a custom background Color
protected	BaseButton(String content, StyleType type) creates a button with an icon and default size ButtonSize.MEDIUM and apply a predefined StyleType

Method Summary

Modifier and Type	Method and Description
B	block() delegate to setBlock(boolean) with true
B	bordered() adds a border to the button by applying the ButtonStyles.BUTTON_BORDERED and removes the Elevation
B	bordered(Color borderColor) sets the border color for a bordered button
B	circle() changes the button to a circle button by applying ButtonStyles.BUTTON_CIRCLE
B	deLinkify() Revert a linkify(ed) button to look like a button by removing ButtonStyles.BUTTON_LINK and restore the previous Elevation
B	disable() disables the button, this will effectively set the button HTMLElement disable attribute
B	enable() enables the button, this will effectively remove the button HTMLElement disable attribute
Color	getBackground()
elemental2.dom.HTMLElement	getClickableElement() return the clickable HTMLElement of this component, which the component button element.
ButtonSize	getSize()
DominoElement<elemental2.dom.HTMLElement>	getTextSpan()
boolean	isEnabled() check if the button is enabled or not
B	large() change the button size to ButtonSize.LARGE
B	linkify() changes the button to look like a link by applying ButtonStyles.BUTTON_LINK and remove the Elevation
B	medium() change the button size to ButtonSize.MEDIUM
B	nonBordered() removes the button border applied by bordered() and restore previous Elevation
B	setBackground(Color background) change the button background color
B	setBlock(boolean block) sets or remove the ButtonStyles.BUTTON_BLOCK
B	setButtonType(StyleType type) changes the button style type
B	setColor(Color color) Changes the text color of a button
B	setContent(String content) replaces the current text of the button
B	setEnabled(boolean enabled) delegate to disable() or enable() based on the flag
B	setIcon(BaseIcon<?> icon) sets the button icon replacing the current icon.
B	setSize(ButtonSize size) change the size of the button
B	setTextContent(String text) same as setContent(String)
B	small() change the button size to ButtonSize.SMALL
B	xSmall() change the button size to ButtonSize.XSMALL

Methods inherited from class org.dominokit.domino.ui.style.WavesElement

applyWaveStyle, init, initWaves, removeWaves, setWaveColor

Methods inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

add, add, addClickListener, addCss, addCss, addEventListener, addEventListener, addEventsListener, addHideListener, addShowListener, alignCenter, alignRight, appendChild, appendChild, apply, attr, blur, childNodes, clearElement, contains, contains, contains, containsCss, css, css, cssClassByIndex, cssClassesCount, cssText, element, elevate, elevate, firstChild, getAttachObserver, getAttribute, getBoundingClientRect, getChildElementCount, getCollapsible, getCollapsibleElement, getDetachObserver, getDominoId, getElementsCount, getElevation, getFirstChild, getId, getTextContent, getTooltip, getWavesElement, hasAttribute, hasChildNodes, hasDirectChild, hide, hideOn, id, insertAfter, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertBefore, insertFirst, insertFirst, insertFirst, isAttached, isCollapsed, isDisabled, isEmptyElement, isEqualNode, isForceHidden, isHidden, isReadOnly, item, lastChild, length, onAttached, onDetached, onResize, pullLeft, pullRight, querySelector, querySelectorAll, remove, removeAttachObserver, removeAttribute, removeChild, removeChild, removeCss, removeCss, removeCssProperty, removeDetachObserver, removeEventListener, removeEventListener, removeHideListener, removeHideOn, removeShowListener, removeShowOn, removeTooltip, replaceCss, setAlignItems, setAttribute, setAttribute, setAttribute, setBackgroundColor, setBackgroundColor, setBorder, setBorderColor, setBottom, setBottom, setBoxShadow, setCollapseStrategy, setColor, setColor, setContent, setContent, setCssProperty, setCssProperty, setCursor, setCursor, setDisabled, setDisplay, setDisplay, setDropMenu, setFlex, setFloat, setFloat, setFontSize, setFontSize, setForceHidden, setHeight, setHeight, setId, setInnerHtml, setLeft, setLeft, setLineHeight, setLineHeight, setMargin, setMargin, setMarginBottom, setMarginBottom, setMarginLeft, setMarginLeft, setMarginRight, setMarginRight, setMarginTop, setMarginTop, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setOpacity, setOpacity, setOverFlow, setOverFlow, setOverFlowY, setPadding, setPadding, setPaddingBottom, setPaddingBottom, setPaddingLeft, setPaddingLeft, setPaddingRight, setPaddingRight, setPaddingTop, setPaddingTop, setPointerEvents, setPosition, setPosition, setReadOnly, setRight, setRight, setTabIndex, setTextAlign, setTextAlign, setTooltip, setTooltip, setTooltip, setTooltip, setTop, setTop, setTransitionDuration, setWidth, setWidth, setZIndex, show, showOn, style, style, styler, textContent, toggleDisplay, toggleDisplay, withWaves, withWaves

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dominokit.domino.ui.utils.IsCollapsible

isExpanded

Methods inherited from interface org.dominokit.domino.ui.style.DominoStyle

add, add, remove, remove, removeProperty, replace, setProperty, setProperty

Field Detail

content

protected String content

buttonElement

protected final DominoElement<elemental2.dom.HTMLButtonElement> buttonElement

The default element that represent the button HTMLElement.

Constructor Detail

BaseButton

protected BaseButton()

creates a button with default size ButtonSize.MEDIUM

BaseButton

protected BaseButton(String content)

creates a button with text and default size ButtonSize.MEDIUM

Parameters:

content - String text

BaseButton

protected BaseButton(BaseIcon icon)

creates a button with an icon and default size ButtonSize.MEDIUM

Parameters:

icon - BaseIcon

BaseButton

protected BaseButton(String content,
                     StyleType type)

creates a button with an icon and default size ButtonSize.MEDIUM and apply a predefined StyleType

Parameters:

content - String text

type - StyleType

BaseButton

protected BaseButton(BaseIcon icon,
                     StyleType type)

creates a button with an icon and default size ButtonSize.MEDIUM and apply a predefined StyleType

Parameters:

icon - BaseIcon

type - StyleType

BaseButton

public BaseButton(String content,
                  Color background)

creates a button with a text and default size ButtonSize.MEDIUM and apply a custom background Color

Parameters:

content - String text

background - Color the background color

Method Detail

setContent

public B setContent(String content)

replaces the current text of the button

Specified by:

setContent in interface HasContent<B extends BaseButton<?>>

Parameters:

content - String, the new text

Returns:

same instance

setTextContent

public B setTextContent(String text)

same as setContent(String)

Overrides:

setTextContent in class BaseDominoElement<elemental2.dom.HTMLElement,B extends BaseButton<?>>

Parameters:

text - String, the new text

Returns:

same instance

setSize

public B setSize(ButtonSize size)

change the size of the button

Parameters:

size - ButtonSize

Returns:

same instance

setBlock

public B setBlock(boolean block)

sets or remove the ButtonStyles.BUTTON_BLOCK

Parameters:

block - boolean if true add the style otherwise remove it

Returns:

same instance

setBackground

public B setBackground(Color background)

change the button background color

Specified by:

setBackground in interface HasBackground<B extends BaseButton<?>>

Parameters:

background - the Color of the new background

Returns:

same instance

setColor

public B setColor(Color color)

Changes the text color of a button

Parameters:

color - the new Color

Returns:

same instance

setButtonType

public B setButtonType(StyleType type)

changes the button style type

Parameters:

type - the new StyleType

Returns:

same instance

disable

public B disable()

disables the button, this will effectively set the button HTMLElement disable attribute

Specified by:

disable in interface Switchable<B extends BaseButton<?>>

Overrides:

disable in class BaseDominoElement<elemental2.dom.HTMLElement,B extends BaseButton<?>>

Returns:

same instance

enable

public B enable()

enables the button, this will effectively remove the button HTMLElement disable attribute

Specified by:

enable in interface Switchable<B extends BaseButton<?>>

Overrides:

enable in class BaseDominoElement<elemental2.dom.HTMLElement,B extends BaseButton<?>>

Returns:

same instance

setEnabled

public B setEnabled(boolean enabled)

delegate to disable() or enable() based on the flag

Parameters:

enabled - boolean, if true call enable() else call disable()

Returns:

same instance

isEnabled

public boolean isEnabled()

check if the button is enabled or not

Specified by:

isEnabled in interface Switchable<B extends BaseButton<?>>

Returns:

boolean, true if the button is enabled else return false

getClickableElement

public elemental2.dom.HTMLElement getClickableElement()

return the clickable HTMLElement of this component, which the component button element.

Specified by:

getClickableElement in interface HasClickableElement

Overrides:

getClickableElement in class BaseDominoElement<elemental2.dom.HTMLElement,B extends BaseButton<?>>

Returns:

HTMLElement of this button instance

large

public B large()

change the button size to ButtonSize.LARGE

Specified by:

large in interface Sizable<B extends BaseButton<?>>

Returns:

same instance

medium

public B medium()

change the button size to ButtonSize.MEDIUM

Specified by:

medium in interface Sizable<B extends BaseButton<?>>

Returns:

same instance

small

public B small()

change the button size to ButtonSize.SMALL

Specified by:

small in interface Sizable<B extends BaseButton<?>>

Returns:

same instance

xSmall

public B xSmall()

change the button size to ButtonSize.XSMALL

Specified by:

xSmall in interface Sizable<B extends BaseButton<?>>

Returns:

same instance

block

public B block()

delegate to setBlock(boolean) with true

Returns:

same instance

linkify

public B linkify()

changes the button to look like a link by applying ButtonStyles.BUTTON_LINK and remove the Elevation

Returns:

same instance

deLinkify

public B deLinkify()

Revert a linkify(ed) button to look like a button by removing ButtonStyles.BUTTON_LINK and restore the previous Elevation

Returns:

same instance

bordered

public B bordered()

adds a border to the button by applying the ButtonStyles.BUTTON_BORDERED and removes the Elevation

Returns:

same instance

bordered

public B bordered(Color borderColor)

sets the border color for a bordered button

Parameters:

borderColor - the Color of the border

Returns:

same instance

nonBordered

public B nonBordered()

removes the button border applied by bordered() and restore previous Elevation

Returns:

same instance

circle

public B circle()

changes the button to a circle button by applying ButtonStyles.BUTTON_CIRCLE

Returns:

same instance

setIcon

public B setIcon(BaseIcon<?> icon)

sets the button icon replacing the current icon.

Parameters:

icon - the new BaseIcon

Returns:

same instance

getSize

public ButtonSize getSize()

Returns:

the current applied ButtonSize

getBackground

public Color getBackground()

getTextSpan

public DominoElement<elemental2.dom.HTMLElement> getTextSpan()

Returns:

DominoElement of HTMLElement that wrap the button text