Package org.patternfly.component.badge

Class Badge

java.lang.Object

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

org.patternfly.component.badge.Badge

All Implemented Interfaces:

Container<HTMLElement,Badge>, Finder<HTMLElement>, HasElement<HTMLElement,Badge>, HasHTMLElement<HTMLElement,Badge>, IsElement<HTMLElement>, TypedBuilder<HTMLElement,Badge>, Component, HasValue<Integer>, WithObservableValue<HTMLElement,Badge,Integer>

public class Badge
extends BaseComponent<HTMLElement,Badge>
implements HasValue<Integer>, WithObservableValue<HTMLElement,Badge,Integer>

A badge is used to annotate other information like a label or an object name.

See Also:

https://www.patternfly.org/components/badge

Method Summary

Modifier and Type	Method	Description
static Badge	badge(int count)
static Badge	badge(int count, int limit)
Badge	bind(ObservableValue<Integer> ov)	Binds an observable value to this component.
int	count()
Badge	count(int count)	Same as count(count, false)
Badge	count(int count, boolean fireEvent)	Sets the count of this badge.
Badge	display(Function<Integer,String> display)	Use a function to render the text for the value of count().
Badge	limit(int limit)	Sets the limit of this badge
Badge	maxDisplay(Function<Integer,String> maxDisplay)	Use a function to render the text if count() > limit(int).
Badge	onChange(ChangeHandler<Badge,Integer> changeHandler)	Defines a change handler that is called when the value() of this badge changes.
Badge	read()	Marks the badge as read.
Badge	screenReader(String text)
Badge	that()
Badge	unread()	Marks the badge as unread.
Integer	value()

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, add, addAll, 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, classList, classList, css, id, id, innerHtml, on, run, textContent, textNode, toggle, toggle, toggle, uniqueId

Methods inherited from interface org.jboss.elemento.HasHTMLElement

data, hidden, style, style, style, style, style, style, title

Methods inherited from interface org.jboss.elemento.IsElement

element

Method Detail

badge

public static Badge badge(int count)

badge

public static Badge badge(int count,
                          int limit)

read

public Badge read()

Marks the badge as read.

unread

public Badge unread()

Marks the badge as unread.

count

public Badge count(int count)

Same as count(count, false)

count

public Badge count(int count,
                   boolean fireEvent)

Sets the count of this badge.

display

public Badge display(Function<Integer,String> display)

Use a function to render the text for the value of count(). If not set String.valueOf(count) is used implicitly.

maxDisplay

public Badge maxDisplay(Function<Integer,String> maxDisplay)

Use a function to render the text if count() > limit(int). If not set count + "+" is used implicitly.

limit

public Badge limit(int limit)

Sets the limit of this badge

screenReader

public Badge screenReader(String text)

bind

public Badge bind(ObservableValue<Integer> ov)

Binds an observable value to this component. If you're using an observable value, you must not use count(int) or count(int, boolean) to set the value. Use ObservableValue.set(Object) instead.

Specified by:

bind in interface WithObservableValue<HTMLElement,Badge,Integer>

that

public Badge that()

Specified by:

that in interface TypedBuilder<HTMLElement,Badge>

onChange

public Badge onChange(ChangeHandler<Badge,Integer> changeHandler)

Defines a change handler that is called when the value() of this badge changes.

count

public int count()

value

public Integer value()

Specified by:

value in interface HasValue<Integer>