Package org.patternfly.component.notification

Class NotificationBadge

java.lang.Object

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

org.patternfly.component.notification.NotificationBadge

All Implemented Interfaces:

ElementAttributeMethods<HTMLElement,NotificationBadge>, ElementClassListMethods<HTMLElement,NotificationBadge>, ElementConsumerMethods<HTMLElement,NotificationBadge>, ElementContainerMethods<HTMLElement,NotificationBadge>, ElementEventMethods<HTMLElement,NotificationBadge>, ElementIdMethods<HTMLElement,NotificationBadge>, ElementQueryMethods<HTMLElement>, HTMLElementAttributeMethods<HTMLElement,NotificationBadge>, HTMLElementDataMethods<HTMLElement,NotificationBadge>, HTMLElementStyleMethods<HTMLElement,NotificationBadge>, HTMLElementVisibilityMethods<HTMLElement,NotificationBadge>, IsElement<HTMLElement>, TypedBuilder<HTMLElement,NotificationBadge>, Component, Expandable<HTMLElement,NotificationBadge>, HasObservableValue<HTMLElement,NotificationBadge,Integer>, HasValue<Integer>

public class NotificationBadge
extends BaseComponent<HTMLElement,NotificationBadge>
implements Expandable<HTMLElement,NotificationBadge>, HasObservableValue<HTMLElement,NotificationBadge,Integer>, HasValue<Integer>

A notification badge is a visual indicator that alerts users about incoming notifications.

See Also:

• PatternFly Notification Badge

Method Summary

Modifier and Type	Method	Description
NotificationBadge	ariaLabel(String ariaLabel)
NotificationBadge	attention()
NotificationBadge	bind(ObservableValue<Integer> ov)	Binds an observable value to this component.
NotificationBadge	bindStatus(ObservableValue<NotificationStatus> os)	Binds an observable status to this component.
void	collapse(boolean fireEvent)
int	count()
NotificationBadge	count(int count)	Same as count(count, false)
NotificationBadge	count(int count, boolean fireEvent)	Sets the count of this notification badge.
void	expand(boolean fireEvent)
boolean	expanded()
static NotificationBadge	notificationBadge()
static NotificationBadge	notificationBadge(int count)
NotificationBadge	onChangeStatus(ChangeHandler<NotificationBadge,NotificationStatus> changeHandler)
NotificationBadge	onChangeValue(ChangeHandler<NotificationBadge,Integer> changeHandler)	Defines a change handler that is called when the value() of this notification badge changes.
NotificationBadge	onClick(ComponentHandler<NotificationBadge> actionHandler)
NotificationBadge	onToggle(ToggleHandler<NotificationBadge> toggleHandler)
NotificationBadge	read()
NotificationStatus	status()
NotificationBadge	status(NotificationStatus status)	Same as status(status, false)
NotificationBadge	status(NotificationStatus status, boolean fireEvent)
NotificationBadge	that()
void	triggerNotification()
NotificationBadge	unread()
Integer	value()

Methods inherited from class org.patternfly.component.BaseComponent

componentType, element, registerComponent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.elemento.ElementAttributeMethods

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

Methods inherited from interface org.jboss.elemento.ElementClassListMethods

classList, classList, css, toggle, toggle, toggle

Methods inherited from interface org.jboss.elemento.ElementConsumerMethods

apply, run

Methods inherited from interface org.jboss.elemento.ElementContainerMethods

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

Methods inherited from interface org.jboss.elemento.ElementEventMethods

on, on, on

Methods inherited from interface org.jboss.elemento.ElementIdMethods

id, uniqueId

Methods inherited from interface org.jboss.elemento.ElementQueryMethods

closest, querySelector, querySelectorAll

Methods inherited from interface org.patternfly.component.Expandable

collapse, expand, toggle, toggle

Methods inherited from interface org.jboss.elemento.HTMLElementAttributeMethods

title

Methods inherited from interface org.jboss.elemento.HTMLElementDataMethods

data

Methods inherited from interface org.jboss.elemento.HTMLElementStyleMethods

style, style, style, style, style, style

Methods inherited from interface org.jboss.elemento.HTMLElementVisibilityMethods

hidden

Methods inherited from interface org.jboss.elemento.IsElement

element

Method Details

notificationBadge

public static NotificationBadge notificationBadge()

notificationBadge

public static NotificationBadge notificationBadge(int count)

count

public NotificationBadge count(int count)

Same as count(count, false)

count

public NotificationBadge count(int count,
 boolean fireEvent)

Sets the count of this notification badge.

bind

public NotificationBadge 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 HasObservableValue<HTMLElement,NotificationBadge,Integer>

unread

public NotificationBadge unread()

read

public NotificationBadge read()

attention

public NotificationBadge attention()

status

public NotificationBadge status(NotificationStatus status)

Same as status(status, false)

status

public NotificationBadge status(NotificationStatus status,
 boolean fireEvent)

bindStatus

public NotificationBadge bindStatus(ObservableValue<NotificationStatus> os)

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

that

public NotificationBadge that()

Specified by:

that in interface TypedBuilder<HTMLElement,NotificationBadge>

ariaLabel

public NotificationBadge ariaLabel(String ariaLabel)

onChangeValue

public NotificationBadge onChangeValue(ChangeHandler<NotificationBadge,Integer> changeHandler)

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

onChangeStatus

public NotificationBadge onChangeStatus(ChangeHandler<NotificationBadge,NotificationStatus> changeHandler)

onClick

public NotificationBadge onClick(ComponentHandler<NotificationBadge> actionHandler)

onToggle

public NotificationBadge onToggle(ToggleHandler<NotificationBadge> toggleHandler)

expand

public void expand(boolean fireEvent)

Specified by:

expand in interface Expandable<HTMLElement,NotificationBadge>

collapse

public void collapse(boolean fireEvent)

Specified by:

collapse in interface Expandable<HTMLElement,NotificationBadge>

triggerNotification

public void triggerNotification()

count

public int count()

expanded

public boolean expanded()

Specified by:

expanded in interface Expandable<HTMLElement,NotificationBadge>

Returns:

true if the element's class list has the modifier Classes.expanded, false otherwise.

value

public Integer value()

Specified by:

value in interface HasValue<Integer>

status

public NotificationStatus status()