Class Button

java.lang.Object

org.patternfly.component.BaseComponent<elemental2.dom.HTMLElement, Button>

org.patternfly.component.button.Button

All Implemented Interfaces:

ElementAttributeMethods<elemental2.dom.HTMLElement, Button>, ElementClassListMethods<elemental2.dom.HTMLElement, Button>, ElementConsumerMethods<elemental2.dom.HTMLElement, Button>, ElementContainerDelegate<elemental2.dom.HTMLElement, Button>, ElementContainerMethods<elemental2.dom.HTMLElement, Button>, ElementEventMethods<elemental2.dom.HTMLElement, Button>, ElementIdMethods<elemental2.dom.HTMLElement, Button>, ElementQueryMethods<elemental2.dom.HTMLElement>, ElementTextMethods<elemental2.dom.HTMLElement, Button>, HTMLElementAttributeMethods<elemental2.dom.HTMLElement, Button>, HTMLElementDataMethods<elemental2.dom.HTMLElement, Button>, HTMLElementStyleMethods<elemental2.dom.HTMLElement, Button>, HTMLElementVisibilityMethods<elemental2.dom.HTMLElement, Button>, IsElement<elemental2.dom.HTMLElement>, TypedBuilder<elemental2.dom.HTMLElement, Button>, Component, ComponentIcon<elemental2.dom.HTMLElement, Button>, ComponentIconAndText<elemental2.dom.HTMLElement, Button>, ComponentProgress<elemental2.dom.HTMLElement, Button>, OuiaSupport<elemental2.dom.HTMLElement, Button>, Modifiers.Circle<elemental2.dom.HTMLElement, Button>, Modifiers.Disabled<elemental2.dom.HTMLElement, Button>, Modifiers.Inline<elemental2.dom.HTMLElement, Button>, Modifiers.NoPadding<elemental2.dom.HTMLElement, Button>, Modifiers.Plain<elemental2.dom.HTMLElement, Button>, Modifiers.Primary<elemental2.dom.HTMLElement, Button>, Modifiers.Secondary<elemental2.dom.HTMLElement, Button>

public class Button
extends BaseComponent<elemental2.dom.HTMLElement, Button>
implements Modifiers.Circle<elemental2.dom.HTMLElement, Button>, ComponentIcon<elemental2.dom.HTMLElement, Button>, ComponentIconAndText<elemental2.dom.HTMLElement, Button>, ComponentProgress<elemental2.dom.HTMLElement, Button>, Modifiers.Disabled<elemental2.dom.HTMLElement, Button>, ElementContainerDelegate<elemental2.dom.HTMLElement, Button>, ElementTextMethods<elemental2.dom.HTMLElement, Button>, Modifiers.Inline<elemental2.dom.HTMLElement, Button>, Modifiers.NoPadding<elemental2.dom.HTMLElement, Button>, Modifiers.Plain<elemental2.dom.HTMLElement, Button>, Modifiers.Primary<elemental2.dom.HTMLElement, Button>, Modifiers.Secondary<elemental2.dom.HTMLElement, Button>

A button is a box area or text that communicates and triggers user actions when clicked or selected. Buttons can be used to communicate and immediately trigger actions a user can take in an application, like submitting a form, canceling a process, or creating a new object. Buttons can also be used to take a user to a new location, like another page inside a web application, or an external site such as help or documentation.

See Also:

• https://www.patternfly.org/components/button

Method Summary

Modifier and Type	Method	Description
Button	add(Badge badge)
Button	addBadge(Badge badge)
Button	ariaDisabled()
Button	ariaDisabled(boolean disabled)
Button	ariaExpanded(boolean expanded)
Button	ariaLabel(String label)
Button	block()
static Button	button()
static Button	button(String text)
static Button	button(String text, String href)	Creates a button with an <a/> tag.
static Button	button(String text, String href, String target)	Creates a button with an <a/> tag.
static <E extends elemental2.dom.HTMLElement> Button	button(HTMLContainerBuilder<E> builder)
static Button	button(PredefinedIcon icon)
static Button	button(PredefinedIcon icon, String href)	Creates a button with an <a/> tag.
static Button	button(PredefinedIcon icon, String href, String target)	Creates a button with an <a/> tag.
Button	callToAction()
Button	clicked()
elemental2.dom.Element	containerDelegate()
Button	control()
Button	danger()
Button	disabled(boolean disabled)	Adds/removes modifier(disabled)
Button	favorite()
Button	favorited(boolean favorited)
Button	hamburger()
Button	href(String href)
Button	icon(elemental2.dom.Element icon)
Button	iconAndText(elemental2.dom.Element icon, String text, IconPosition position)
Button	link()
Button	onClick(ComponentHandler<Button> actionHandler)
Button	progress(boolean inProgress, String label, Consumer<Spinner> spinnerConsumer)
Button	removeIcon()
Button	settings()
Button	small()
Button	stateful(NotificationStatus status)
Button	target(String target)
Button	tertiary()
String	text()
Button	text(String text)	Changes the text of this button.
elemental2.dom.HTMLElement	textElement()
Button	that()
Button	warning()

Methods inherited from class BaseComponent

componentType, element, ouiaComponentType, registerComponent

Methods inherited from class Object

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

Methods inherited from interface ComponentIcon

icon

Methods inherited from interface ComponentIconAndText

iconAndText, iconAndText

Methods inherited from interface ComponentProgress

inProgress, progress, progress, progress, startProgress, stopProgress, toggleProgress

Methods inherited from interface ElementAttributeMethods

aria, aria, aria, attr, attr, attr, role, role

Methods inherited from interface ElementClassListMethods

classList, classList, css, toggle, toggle, toggle

Methods inherited from interface ElementConsumerMethods

apply, run

Methods inherited from interface ElementContainerDelegate

add, add, add

Methods inherited from interface ElementContainerMethods

add, addAll, addAll, addAll, addAll, addAll, addAll

Methods inherited from interface ElementEventMethods

on, on, on

Methods inherited from interface ElementIdMethods

id, uniqueId

Methods inherited from interface ElementQueryMethods

closest, querySelector, querySelectorAll

Methods inherited from interface HTMLElementAttributeMethods

title

Methods inherited from interface HTMLElementDataMethods

data, data

Methods inherited from interface HTMLElementStyleMethods

style, style, style, style, style, style

Methods inherited from interface HTMLElementVisibilityMethods

hidden

Methods inherited from interface IsElement

element

Methods inherited from interface Modifiers.Circle

circle, circle

Methods inherited from interface Modifiers.Disabled

disabled, isDisabled

Methods inherited from interface Modifiers.Inline

inline, inline

Methods inherited from interface Modifiers.NoPadding

noPadding, noPadding

Methods inherited from interface Modifiers.Plain

plain, plain

Methods inherited from interface Modifiers.Primary

primary, primary

Methods inherited from interface Modifiers.Secondary

secondary, secondary

Methods inherited from interface OuiaSupport

initOuia, ouiaId, ouiaSafe, ouiaTransition

Method Details

button

public static Button button()

button

public static Button button(String text)

button

public static Button button(PredefinedIcon icon)

button

public static Button button(String text,
 String href)

Creates a button with an <a/> tag.

button

public static Button button(String text,
 String href,
 String target)

Creates a button with an <a/> tag.

button

public static Button button(PredefinedIcon icon,
 String href)

Creates a button with an <a/> tag.

button

public static Button button(PredefinedIcon icon,
 String href,
 String target)

Creates a button with an <a/> tag.

button

public static <E extends elemental2.dom.HTMLElement>
Button button(HTMLContainerBuilder<E> builder)

containerDelegate

public elemental2.dom.Element containerDelegate()

Specified by:

containerDelegate in interface ElementContainerDelegate<elemental2.dom.HTMLElement, Button>

addBadge

public Button addBadge(Badge badge)

add

public Button add(Badge badge)

icon

public Button icon(elemental2.dom.Element icon)

Specified by:

icon in interface ComponentIcon<elemental2.dom.HTMLElement, Button>

removeIcon

public Button removeIcon()

Specified by:

removeIcon in interface ComponentIcon<elemental2.dom.HTMLElement, Button>

iconAndText

public Button iconAndText(elemental2.dom.Element icon,
 String text,
 IconPosition position)

Specified by:

iconAndText in interface ComponentIconAndText<elemental2.dom.HTMLElement, Button>

text

public Button text(String text)

Changes the text of this button.

Specified by:

text in interface ElementTextMethods<elemental2.dom.HTMLElement, Button>

href

public Button href(String href)

target

public Button target(String target)

danger

public Button danger()

tertiary

public Button tertiary()

warning

public Button warning()

small

public Button small()

link

public Button link()

control

public Button control()

stateful

public Button stateful(NotificationStatus status)

settings

public Button settings()

hamburger

public Button hamburger()

favorite

public Button favorite()

favorited

public Button favorited(boolean favorited)

block

public Button block()

clicked

public Button clicked()

callToAction

public Button callToAction()

ariaDisabled

public Button ariaDisabled()

ariaDisabled

public Button ariaDisabled(boolean disabled)

ariaExpanded

public Button ariaExpanded(boolean expanded)

ariaLabel

public Button ariaLabel(String label)

disabled

public Button disabled(boolean disabled)

Description copied from interface: Modifiers.Disabled

Adds/removes modifier(disabled)

Specified by:

disabled in interface Modifiers.Disabled<elemental2.dom.HTMLElement, Button>

progress

public Button progress(boolean inProgress,
 String label,
 Consumer<Spinner> spinnerConsumer)

Specified by:

progress in interface ComponentProgress<elemental2.dom.HTMLElement, Button>

that

public Button that()

Specified by:

that in interface TypedBuilder<elemental2.dom.HTMLElement, Button>

onClick

public Button onClick(ComponentHandler<Button> actionHandler)

text

public String text()

Specified by:

text in interface ElementTextMethods<elemental2.dom.HTMLElement, Button>

textElement

public elemental2.dom.HTMLElement textElement()