org.fujion.ancillary

Class Badge

java.lang.Object

org.fujion.ancillary.Badge

public class Badge
extends Object

Helper class for displaying a badge with numeric counter. Each time the counter changes, the owning component and its ancestors are notified of the delta, allowing any components that are capable of displaying a badge to update their cumulative counts.

Constructor Summary

Constructors

Constructor and Description
Badge(BaseComponent owner) Creates a badge with an initial count of 0.
Badge(BaseComponent owner, int count) Creates a badge with a specified initial count.

Method Summary

Modifier and Type	Method and Description
int	getCount() Returns the current count.
BaseComponent	getOwner() Returns the component associated with this badge.
void	incCount(int increment) Increments the count by the specified value.
void	setCount(int count) Sets the count to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Badge

public Badge(BaseComponent owner)

Creates a badge with an initial count of 0.

Parameters:

owner - The component to associate with this badge.

Badge

public Badge(BaseComponent owner,
             int count)

Creates a badge with a specified initial count.

Parameters:

owner - The component to associate with this badge.

count - The initial count for the badge.

Method Detail

getOwner

public BaseComponent getOwner()

Returns the component associated with this badge.

Returns:

The owning component.

getCount

public int getCount()

Returns the current count.

Returns:

The current count.

setCount

public void setCount(int count)

Sets the count to the specified value.

Parameters:

count - The new count.

incCount

public void incCount(int increment)

Increments the count by the specified value.

Parameters:

increment - The increment to apply to the current count.