All Superinterfaces:

IAnyGroup<IBadge>, IChildable<IBadge,I>, IComponent<IBadge>, IHtmlBasedComponent<IBadge>, IXulElement<IBadge>
```
public interface IBadge
extends IXulElement<IBadge>, IChildable<IBadge,I>, IAnyGroup<IBadge>
```
Immutable Badge component.
A badge (count or status indicator). Used standalone, or wrapping a child component to pin the indicator onto it — see getPlacement(), which is only effective in that wrap mode.

Since:

11.0.0

Author:

peaker

See Also:

Badge

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static class`	`IBadge.Builder<I extends IAnyGroup>`	Builds instances of type `IBadge`.
`static class`	`IBadge.Updater`	Builds an updater of type `IBadge` for `UiAgent.smartUpdate(Locator, SmartUpdater)`.

Field Summary

Fields
Modifier and Type Field Description

static IBadge<IAnyGroup> DEFAULT
Constant for default attributes of this immutable component.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default int`	`getCount()`	Returns the count of this badge.
`default int`	`getMax()`	Returns the maximum count to display before falling back to `"{max}+"`.
`default java.lang.String`	`getPlacement()`	Returns the placement of the indicator relative to the wrapped child, or null when it was reset to the default.
`default java.lang.String`	`getSeverity()`	Returns the severity (color theme), or null when it was reset to the default.
`default java.lang.String`	`getValue()`	Returns the text value of this badge.
`default java.lang.String`	`getWidgetClass()`	Returns the client widget class.
`default boolean`	`isDot()`	Returns whether to render as a small dot, ignoring value and count text.
`default boolean`	`isShowZero()`	Returns whether to display when the count is zero.
`static <I extends IAnyGroup> IBadge<I>`	`of(int count)`	Returns the instance with the given count.
`static <I extends IAnyGroup> IBadge<I>`	`of(java.lang.String value)`	Returns the instance with the given text value.
`static <I extends IAnyGroup> IBadge<I>`	`ofId(java.lang.String id)`	Returns the instance with the given id.
`IBadge<I>`	`withCount(int count)`	Returns a copy of `this` immutable component with the specified `count`.
`IBadge<I>`	`withDot(boolean dot)`	Returns a copy of `this` immutable component with the specified `dot`.
`IBadge<I>`	`withMax(int max)`	Returns a copy of `this` immutable component with the specified `max`.
`IBadge<I>`	`withPlacement(java.lang.String placement)`	Returns a copy of `this` immutable component with the specified `placement`.
`IBadge<I>`	`withSeverity(java.lang.String severity)`	Returns a copy of `this` immutable component with the specified `severity`.
`IBadge<I>`	`withShowZero(boolean showZero)`	Returns a copy of `this` immutable component with the specified `showZero`.
`IBadge<I>`	`withValue(java.lang.String value)`	Returns a copy of `this` immutable component with the specified `value`.

Methods inherited from interface org.zkoss.stateless.sul.IChildable
getChildren, withChildren, withChildren

Methods inherited from interface org.zkoss.stateless.sul.IComponent
getAction, getActions, getClientAttributes, getId, getMold, getWidgetListeners, getWidgetOverrides, isVisible, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withActions, withActions, withClientAttribute, withClientAttributes, withId, withMold, withVisible, withWidgetClass, withWidgetListener, withWidgetListeners, withWidgetOverride, withWidgetOverrides

Methods inherited from interface org.zkoss.stateless.sul.IHtmlBasedComponent
getClientAction, getDraggable, getDroppable, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getSkeleton, getStyle, getTabindex, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZIndex, isFocus, withClientAction, withDraggable, withDroppable, withFocus, withHeight, withHflex, withLeft, withRenderdefer, withSclass, withSkeleton, withStyle, withTabindex, withTabindex, withTooltiptext, withTop, withVflex, withWidth, withZclass, withZIndex

Methods inherited from interface org.zkoss.stateless.sul.IXulElement
getContext, getCtrlKeys, getPopup, getTooltip, withContext, withCtrlKeys, withPopup, withTooltip

- Field Detail
 - DEFAULT
```
static final IBadge<IAnyGroup> DEFAULT
```
 Constant for default attributes of this immutable component.
- Method Detail
 - getWidgetClass
```
default java.lang.String getWidgetClass()
```
 Returns the client widget class.
 Default: "zul.wgt.Badge"
 
 Specified by:
 
 getWidgetClass in interface IComponent
 - getValue
```
@Nullable
default java.lang.String getValue()
```
 Returns the text value of this badge.
 Default: null. When non-null, takes precedence over getCount().
 - withValue
```
IBadge withValue(@Nullable
 java.lang.String value)
```
 Returns a copy of this immutable component with the specified value.
 Sets the text value of this badge.
 
 Parameters:
 
 value - the text to show; takes precedence over getCount().
 Default: null.
 
 Returns:
 
 A modified copy of the this object
 - getCount
```
default int getCount()
```
 Returns the count of this badge.
 Default: 0.
 - withCount
```
IBadge withCount(int count)
```
 Returns a copy of this immutable component with the specified count.
 Sets the count of this badge.
 
 Parameters:
 
 count - the number to show; must not be negative.
 Default: 0.
 
 Returns:
 
 A modified copy of the this object
 
 Throws:
 
 org.zkoss.zk.ui.WrongValueException - if count is negative
 - getMax
```
default int getMax()
```
 Returns the maximum count to display before falling back to "{max}+".
 Default: 99.
 - withMax
```
IBadge withMax(int max)
```
 Returns a copy of this immutable component with the specified max.
 Sets the maximum count.
 
 Parameters:
 
 max - the cap above which "{max}+" is shown; must be at least 1.
 Default: 99.
 
 Returns:
 
 A modified copy of the this object
 
 Throws:
 
 org.zkoss.zk.ui.WrongValueException - if max is less than 1
 - isShowZero
```
default boolean isShowZero()
```
 Returns whether to display when the count is zero.
 Default: false.
 - withShowZero
```
IBadge withShowZero(boolean showZero)
```
 Returns a copy of this immutable component with the specified showZero.
 Sets whether to display when the count is zero.
 
 Parameters:
 
 showZero - whether the badge shows when the count is zero.
 Default: false.
 
 Returns:
 
 A modified copy of the this object
 - isDot
```
default boolean isDot()
```
 Returns whether to render as a small dot, ignoring value and count text.
 Default: false.
 - withDot
```
IBadge withDot(boolean dot)
```
 Returns a copy of this immutable component with the specified dot.
 Sets whether to render as a small dot, ignoring value and count text.
 
 Parameters:
 
 dot - whether to render as a dot instead of value/count text.
 Default: false.
 
 Returns:
 
 A modified copy of the this object
 - getSeverity
```
@Nullable
default java.lang.String getSeverity()
```
 Returns the severity (color theme), or null when it was reset to the default.
 Default: "info".
 - withSeverity
```
IBadge withSeverity(@Nullable
 java.lang.String severity)
```
 Returns a copy of this immutable component with the specified severity.
 Sets the severity.
 
 Parameters:
 
 severity - "info", "success", "warning", "error" or "neutral".
 Default: "info".
 
 Returns:
 
 A modified copy of the this object
 
 Throws:
 
 org.zkoss.zk.ui.WrongValueException - if severity is not one of the accepted tokens
 - getPlacement
```
@Nullable
default java.lang.String getPlacement()
```
 Returns the placement of the indicator relative to the wrapped child, or null when it was reset to the default.
 Default: "top_right".
 - withPlacement
```
IBadge withPlacement(@Nullable
 java.lang.String placement)
```
 Returns a copy of this immutable component with the specified placement.
 Sets the placement.
 
 Parameters:
 
 placement - "top_right", "top_left", "bottom_right" or "bottom_left".
 Default: "top_right".
 
 Returns:
 
 A modified copy of the this object
 
 Throws:
 
 org.zkoss.zk.ui.WrongValueException - if placement is not one of the accepted tokens
 - of
```
static  IBadge of(int count)
```
 Returns the instance with the given count.
 
 Parameters:
 
 count - The count of the badge
 - of
```
static  IBadge of(java.lang.String value)
```
 Returns the instance with the given text value.
 
 Parameters:
 
 value - The text value of the badge
 - ofId
```
static  IBadge ofId(java.lang.String id)
```
 Returns the instance with the given id.
 
 Parameters:
 
 id - The id to identify this component

Interface IBadge<I extends IAnyGroup>

Nested Class Summary

Field Summary

Method Summary

Methods inherited from interface org.zkoss.stateless.sul.IChildable

Methods inherited from interface org.zkoss.stateless.sul.IComponent

Methods inherited from interface org.zkoss.stateless.sul.IHtmlBasedComponent

Methods inherited from interface org.zkoss.stateless.sul.IXulElement

Field Detail

DEFAULT

Method Detail

getWidgetClass

getValue

withValue

getCount

withCount

getMax

withMax

isShowZero

withShowZero

isDot

withDot

getSeverity

withSeverity

getPlacement

withPlacement

of

of

ofId