Package com.explodingpixels.macwidgets
Class SourceListItem
java.lang.Object
com.explodingpixels.macwidgets.SourceListItem
- All Implemented Interfaces:
MacBadgeContentProvider
,SourceListBadgeContentProvider
,IconProvider
,TextProvider
public class SourceListItem
extends Object
implements TextProvider, IconProvider, SourceListBadgeContentProvider
An item in a
SourceList
which is contained within a SourceListCategory
.-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionSourceListItem
(String text) Creates aSourceListItem
with the given text.SourceListItem
(String text, Icon icon) Creates aSourceListItem
with the given text and icon. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds aPropertyChangeListener
on thisSourceListItem
.boolean
containsItem
(SourceListItem item) Returnstrue
if the givenSourceListItem
is contained by this item, to include being a sub-element of another childSourceListItem
.Returns the string value of what should be displayed in the badge areaGets a list of thisSourceListItem
's childSourceListItem
s.int
Gets the counter value to use for this item.getIcon()
Gets the icon to use for this item.getText()
Gets the text to use for this item.void
Removes aPropertyChangeListener
from thisSourceListItem
.void
setCounterValue
(int counterValue) Sets the counter value to use for this item.void
Sets the icon to use for this item.void
Sets the text to use for this item.toString()
Returns aString
representation of thisSourceListItem
.
-
Field Details
-
TEXT
- See Also:
-
ICON
- See Also:
-
COUNTER_VALUE
- See Also:
-
-
Constructor Details
-
SourceListItem
Creates aSourceListItem
with the given text.- Parameters:
text
- the item text. Cannot be null.- Throws:
IllegalArgumentException
- if the text is null.
-
SourceListItem
Creates aSourceListItem
with the given text and icon.- Parameters:
text
- the item text. Cannot be null.icon
- the item icon. Can be null.- Throws:
IllegalArgumentException
- if the text is null.
-
-
Method Details
-
getText
Gets the text to use for this item.- Specified by:
getText
in interfaceTextProvider
- Returns:
- the text to use for this item.
-
setText
Sets the text to use for this item.- Parameters:
text
- the text to use for this item. Cannot be null.- Throws:
IllegalArgumentException
- if the text is null.
-
getIcon
Gets the icon to use for this item.- Specified by:
getIcon
in interfaceIconProvider
- Returns:
- the icon to use for this item.
-
setIcon
Sets the icon to use for this item.- Parameters:
icon
- the icon to use for this item. Can be null.
-
getCounterValue
public int getCounterValue()Gets the counter value to use for this item. The counter value will be displayed to the right of the item.- Specified by:
getCounterValue
in interfaceSourceListBadgeContentProvider
- Returns:
- the counter value to use for this item.
-
getBadgeValue
Returns the string value of what should be displayed in the badge area- Specified by:
getBadgeValue
in interfaceMacBadgeContentProvider
- Returns:
- text to display
-
setCounterValue
public void setCounterValue(int counterValue) Sets the counter value to use for this item. The counter value will be displayed to the right of the item.- Parameters:
counterValue
- the counter value to use for this item. Must be >= 0.- Throws:
IllegalArgumentException
- if the counter value is not >= 0.
-
containsItem
Returnstrue
if the givenSourceListItem
is contained by this item, to include being a sub-element of another childSourceListItem
.- Parameters:
item
- theSourceListItem
to determine whether or not is contained by this item.- Returns:
true
if the givenSourceListItem
is contained within this item or within on of this items childSourceListItem
s.
-
toString
Returns aString
representation of thisSourceListItem
. -
getChildItems
Gets a list of thisSourceListItem
's childSourceListItem
s.- Returns:
- a list of this
SourceListItem
's childSourceListItem
s.
-
addPropertyChangeListener
Adds aPropertyChangeListener
on thisSourceListItem
.- Parameters:
listener
- the listener to add.
-
removePropertyChangeListener
Removes aPropertyChangeListener
from thisSourceListItem
.- Parameters:
listener
- the listener to remove.
-