Class Label

java.lang.Object

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

org.patternfly.component.label.Label

All Implemented Interfaces:

Attachable, ElementAttributeMethods<elemental2.dom.HTMLElement, Label>, ElementClassListMethods<elemental2.dom.HTMLElement, Label>, ElementConsumerMethods<elemental2.dom.HTMLElement, Label>, ElementContainerMethods<elemental2.dom.HTMLElement, Label>, ElementEventMethods<elemental2.dom.HTMLElement, Label>, ElementIdMethods<elemental2.dom.HTMLElement, Label>, ElementQueryMethods<elemental2.dom.HTMLElement>, ElementTextDelegate<elemental2.dom.HTMLElement, Label>, ElementTextMethods<elemental2.dom.HTMLElement, Label>, HTMLElementAttributeMethods<elemental2.dom.HTMLElement, Label>, HTMLElementDataMethods<elemental2.dom.HTMLElement, Label>, HTMLElementStyleMethods<elemental2.dom.HTMLElement, Label>, HTMLElementVisibilityMethods<elemental2.dom.HTMLElement, Label>, IsElement<elemental2.dom.HTMLElement>, TypedBuilder<elemental2.dom.HTMLElement, Label>, Closeable<elemental2.dom.HTMLElement, Label>, Component, ComponentIcon<elemental2.dom.HTMLElement, Label>, ComponentIconAndText<elemental2.dom.HTMLElement, Label>, ComponentContext<elemental2.dom.HTMLElement, Label>, HasIdentifier<elemental2.dom.HTMLElement, Label>, HasValue<String>, OuiaSupport<elemental2.dom.HTMLElement, Label>, Modifiers.Compact<elemental2.dom.HTMLElement, Label>, Modifiers.Disabled<elemental2.dom.HTMLElement, Label>

public class Label
extends BaseComponent<elemental2.dom.HTMLElement, Label>
implements Attachable, Closeable<elemental2.dom.HTMLElement, Label>, Modifiers.Compact<elemental2.dom.HTMLElement, Label>, ComponentContext<elemental2.dom.HTMLElement, Label>, ComponentIcon<elemental2.dom.HTMLElement, Label>, ComponentIconAndText<elemental2.dom.HTMLElement, Label>, Modifiers.Disabled<elemental2.dom.HTMLElement, Label>, ElementTextDelegate<elemental2.dom.HTMLElement, Label>, HasIdentifier<elemental2.dom.HTMLElement, Label>, HasValue<String>

The label component allows users to add specific element captions for user clarity and convenience.

See Also:

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

Method Summary

Modifier and Type	Method	Description
Label	add()	Same as add(true)
Label	add(boolean add)	Adds/removes modifier(add)
Label	ariaCloseLabel(String label)
void	attach(elemental2.dom.MutationRecord mutationRecord)
Label	clickable()
Label	clickable(ComponentHandler<Label> clickHandler)
Label	closable()
Label	closable(CloseHandler<Label> closeHandler)
void	close(elemental2.dom.Event event, boolean fireEvent)
void	detach(elemental2.dom.MutationRecord mutationRecord)
Label	disabled(boolean disabled)	Adds/removes modifier(disabled)
Label	editable()
Label	editable(LabelEditCancelHandler cancelHandler, LabelEditCompleteHandler completeHandler)
boolean	equals(Object o)
Label	filled()	Same as filled(true)
Label	filled(boolean filled)	Adds/removes modifier(filled)
<T> T	get(String key)	Retrieves the value associated with the given key from the ComponentContext.
boolean	has(String key)	Determines whether a value is stored with the specified key.
int	hashCode()
Label	href(String href)
Label	icon(elemental2.dom.Element icon)
Label	iconAndText(elemental2.dom.Element icon, String text, IconPosition iconPosition)
String	identifier()	Retrieves the identifier associated with this component.
static Label	label(String text)
static Label	label(String identifier, String text)
static Label	label(String identifier, String text, Color color)
static Label	label(String text, Color color)
static <E extends elemental2.dom.HTMLElement> Label	label(HTMLContainerBuilder<E> builder, String identifier, String text, Color color)
Label	onClick(ComponentHandler<Label> clickHandler)
Label	onClose(CloseHandler<Label> closeHandler)
Label	onEditCancel(LabelEditCancelHandler cancelHandler)
Label	onEditComplete(LabelEditCompleteHandler completeHandler)
Label	outline()	Same as outline(true)
Label	outline(boolean outline)	Adds/removes modifier(outline)
Label	removeIcon()
Label	status(Severity severity)
<T> Label	store(String key, T value)	Stores a value associated with a key.
String	text()
Label	text(String text)
elemental2.dom.Element	textDelegate()
Label	textMaxWidth(String maxWidth)
Label	that()
String	value()

Methods inherited from class BaseComponent

componentType, element, ouiaComponentType, registerComponent

Methods inherited from class Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Closeable

close, close

Methods inherited from interface ComponentContext

get, get

Methods inherited from interface ComponentIcon

icon

Methods inherited from interface ComponentIconAndText

iconAndText, iconAndText

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 ElementContainerMethods

add, add, add, 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.Compact

compact, compact

Methods inherited from interface Modifiers.Disabled

disabled, isDisabled

Methods inherited from interface OuiaSupport

initOuia, ouiaId, ouiaSafe, ouiaTransition

Method Details

label

public static Label label(String text)

label

public static Label label(String identifier,
 String text)

label

public static Label label(String text,
 Color color)

label

public static Label label(String identifier,
 String text,
 Color color)

label

public static <E extends elemental2.dom.HTMLElement>
Label label(HTMLContainerBuilder<E> builder,
 String identifier,
 String text,
 Color color)

textDelegate

public elemental2.dom.Element textDelegate()

Specified by:

textDelegate in interface ElementTextDelegate<elemental2.dom.HTMLElement, Label>

attach

public void attach(elemental2.dom.MutationRecord mutationRecord)

Specified by:

attach in interface Attachable

detach

public void detach(elemental2.dom.MutationRecord mutationRecord)

Specified by:

detach in interface Attachable

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

disabled

public Label disabled(boolean disabled)

Description copied from interface: Modifiers.Disabled

Adds/removes modifier(disabled)

Specified by:

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

filled

public Label filled()

Same as filled(true)

filled

public Label filled(boolean filled)

Adds/removes modifier(filled)

add

public Label add()

Same as add(true)

add

public Label add(boolean add)

Adds/removes modifier(add)

outline

public Label outline()

Same as outline(true)

outline

public Label outline(boolean outline)

Adds/removes modifier(outline)

closable

public Label closable()

closable

public Label closable(CloseHandler<Label> closeHandler)

clickable

public Label clickable()

clickable

public Label clickable(ComponentHandler<Label> clickHandler)

editable

public Label editable()

editable

public Label editable(LabelEditCancelHandler cancelHandler,
 LabelEditCompleteHandler completeHandler)

icon

public Label icon(elemental2.dom.Element icon)

Specified by:

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

removeIcon

public Label removeIcon()

Specified by:

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

iconAndText

public Label iconAndText(elemental2.dom.Element icon,
 String text,
 IconPosition iconPosition)

Specified by:

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

href

public Label href(String href)

status

public Label status(Severity severity)

text

public Label text(String text)

Specified by:

text in interface ElementTextDelegate<elemental2.dom.HTMLElement, Label>

Specified by:

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

textMaxWidth

public Label textMaxWidth(String maxWidth)

store

public <T> Label store(String key,
 T value)

Description copied from interface: ComponentContext

Stores a value associated with a key.

Specified by:

store in interface ComponentContext<elemental2.dom.HTMLElement, Label>

Type Parameters:

T - the type of the value being stored

Parameters:

key - the key associated with the value

value - the value to be stored

that

public Label that()

Specified by:

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

ariaCloseLabel

public Label ariaCloseLabel(String label)

onClose

public Label onClose(CloseHandler<Label> closeHandler)

Specified by:

onClose in interface Closeable<elemental2.dom.HTMLElement, Label>

onClick

public Label onClick(ComponentHandler<Label> clickHandler)

onEditCancel

public Label onEditCancel(LabelEditCancelHandler cancelHandler)

onEditComplete

public Label onEditComplete(LabelEditCompleteHandler completeHandler)

identifier

public String identifier()

Description copied from interface: HasIdentifier

Retrieves the identifier associated with this component.

Specified by:

identifier in interface HasIdentifier<elemental2.dom.HTMLElement, Label>

Returns:

the identifier of the component

has

public boolean has(String key)

Description copied from interface: ComponentContext

Determines whether a value is stored with the specified key.

Specified by:

has in interface ComponentContext<elemental2.dom.HTMLElement, Label>

Parameters:

key - the key to check

Returns:

true if a value is stored with the specified key, false otherwise

get

public <T> T get(String key)

Description copied from interface: ComponentContext

Retrieves the value associated with the given key from the ComponentContext.

Specified by:

get in interface ComponentContext<elemental2.dom.HTMLElement, Label>

Type Parameters:

T - the type of the value being retrieved

Parameters:

key - the key associated with the value

Returns:

the value associated with the key, or null if no value is found

value

public String value()

Specified by:

value in interface HasValue<String>

text

public String text()

Specified by:

text in interface ElementTextDelegate<elemental2.dom.HTMLElement, Label>

Specified by:

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

close

public void close(elemental2.dom.Event event,
 boolean fireEvent)

Specified by:

close in interface Closeable<elemental2.dom.HTMLElement, Label>