Package org.patternfly.component.button

Class Button

java.lang.Object

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

org.patternfly.component.button.Button

All Implemented Interfaces:

Container<HTMLElement,Button>, Finder<HTMLElement>, HasElement<HTMLElement,Button>, HasHTMLElement<HTMLElement,Button>, IsElement<HTMLElement>, TypedBuilder<HTMLElement,Button>, Component, Modifiers.Disabled<HTMLElement,Button>, Modifiers.Inline<HTMLElement,Button>, Modifiers.Plain<HTMLElement,Button>, WithProgress<HTMLElement,Button>

public class Button
extends BaseComponent<HTMLElement,Button>
implements Modifiers.Disabled<HTMLElement,Button>, Modifiers.Inline<HTMLElement,Button>, Modifiers.Plain<HTMLElement,Button>, WithProgress<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/html

Method Summary

Modifier and Type	Method	Description
Button	addBadge(Badge badge)
Button	addIcon(String iconClass)
Button	addIcon(InlineIcon icon)
Button	addIcon(PredefinedIcon icon)
Button	addIconAndText(String iconClass, String text)
Button	addIconAndText(String iconClass, String text, IconPosition position)
Button	addIconAndText(InlineIcon icon, String text)
Button	addIconAndText(InlineIcon icon, String text, IconPosition position)
Button	addIconAndText(PredefinedIcon icon, String text)
Button	addIconAndText(PredefinedIcon icon, String text, IconPosition position)
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 Button	button(ButtonElement element)
static Button	button(InlineIcon icon)
static Button	button(InlineIcon icon, String label)
static Button	button(PredefinedIcon icon)
static Button	button(PredefinedIcon icon, String label)
Button	callToAction()
Button	control()
Button	danger()
Button	disabled(boolean disabled)	Adds/removes modifier(disabled)
Button	href(String href)
Button	inProgress(boolean inProgress, String label, Consumer<Spinner> spinnerConsumer)
Button	link()
Button	noPadding()
Button	onAction(ActionHandler<Button> actionHandler)
Button	primary()
Button	secondary()
Button	small()
Button	target(String target)
Button	tertiary()
Button	text(String text)	Changes the text of this button.
Button	that()
Button	warning()

Methods inherited from class org.patternfly.component.BaseComponent

componentType, element

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.elemento.Container

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

Methods inherited from interface org.jboss.elemento.Finder

closest, find, findAll

Methods inherited from interface org.jboss.elemento.HasElement

add, apply, aria, aria, aria, attr, attr, attr, css, id, id, innerHtml, on, textContent, toggle, toggle, toggle

Methods inherited from interface org.jboss.elemento.HasHTMLElement

data, hidden, style, title

Methods inherited from interface org.jboss.elemento.IsElement

element

Methods inherited from interface org.patternfly.core.Modifiers.Disabled

disabled

Methods inherited from interface org.patternfly.core.Modifiers.Inline

inline, inline

Methods inherited from interface org.patternfly.core.Modifiers.Plain

plain, plain

Methods inherited from interface org.patternfly.core.WithProgress

inProgress, inProgress, inProgress, isInProgress, startProgress, stopProgress, toggleProgress

Method Detail

button

public static Button button()

button

public static Button button(String text)

button

public static Button button(PredefinedIcon icon)

button

public static Button button(PredefinedIcon icon,
                            String label)

button

public static Button button(InlineIcon icon)

button

public static Button button(InlineIcon icon,
                            String label)

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(ButtonElement element)

that

public Button that()

Specified by:

that in interface TypedBuilder<HTMLElement,Button>

addIcon

public Button addIcon(String iconClass)

addIcon

public Button addIcon(PredefinedIcon icon)

addIcon

public Button addIcon(InlineIcon icon)

addIconAndText

public Button addIconAndText(String iconClass,
                             String text)

addIconAndText

public Button addIconAndText(PredefinedIcon icon,
                             String text)

addIconAndText

public Button addIconAndText(InlineIcon icon,
                             String text)

addIconAndText

public Button addIconAndText(String iconClass,
                             String text,
                             IconPosition position)

addIconAndText

public Button addIconAndText(PredefinedIcon icon,
                             String text,
                             IconPosition position)

addIconAndText

public Button addIconAndText(InlineIcon icon,
                             String text,
                             IconPosition position)

addBadge

public Button addBadge(Badge badge)

primary

public Button primary()

secondary

public Button secondary()

danger

public Button danger()

tertiary

public Button tertiary()

warning

public Button warning()

small

public Button small()

link

public Button link()

noPadding

public Button noPadding()

control

public Button control()

block

public Button block()

callToAction

public Button callToAction()

disabled

public Button disabled(boolean disabled)

Description copied from interface: Modifiers.Disabled

Adds/removes modifier(disabled)

Specified by:

disabled in interface Modifiers.Disabled<HTMLElement,Button>

onAction

public Button onAction(ActionHandler<Button> actionHandler)

text

public Button text(String text)

Changes the text of this button. Prefer this method over HasElement.textContent(String), since this method doesn't remove a possible progress spinner.

href

public Button href(String href)

target

public Button target(String target)

inProgress

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

Specified by:

inProgress in interface WithProgress<HTMLElement,Button>