xdev.ui

Class ItemList.Entry

java.lang.Object

xdev.ui.ItemList.Entry

All Implemented Interfaces:

Cloneable, Copyable<ItemList.Entry>

Enclosing class:

ItemList

public static class ItemList.Entry
extends Object
implements Copyable<ItemList.Entry>

An entry in an ItemList holding

• a data object
• a display item
• an icon
• settings: enabled
• and client properties

Author:

XDEV Software

Constructor Summary

Constructors

Constructor and Description
Entry(Object data) Creates a new entry with the specified data object, the display item is the String value of data.
Entry(Object item, Object data) Creates a new entry with the specified data object and display item.
Entry(Object item, Object data, Icon icon) Creates a new entry with the specified data object, a display item and an icon.

Method Summary

Modifier and Type	Method and Description
ItemList.Entry	clone() Returns a field-for-field copy of this instance.
boolean	equals(Object obj) Compares obj with this entry.
Object	getClientProperty(Object key) Returns the value of the property with the specified key.
Object	getData() Returns the data object of this entry.
Icon	getIcon() Returns the optional icon of this entry.
Object	getItem() Returns the diplay item of this entry.
int	hashCode()
boolean	isEnabled() Determines whether this entry is enabled.
void	putClientProperty(Object key, Object value) Adds an arbitrary key/value "client property" to this entry.
void	setData(Object data) Sets a new data object for this entry.
void	setEnabled(boolean enabled) Enables or disables this entry, depending on the value of the parameter enabled.
void	setIcon(Icon icon) Sets the display icon of this entry.
void	setItem(Object item) Sets a new display item for this entry.
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Entry

public Entry(Object data)

Creates a new entry with the specified data object, the display item is the String value of data.

Parameters:

data - the data object

Entry

public Entry(Object item,
             Object data)

Creates a new entry with the specified data object and display item.

Parameters:

item - the display item

data - the data object

Entry

public Entry(Object item,
             Object data,
             Icon icon)

Creates a new entry with the specified data object, a display item and an icon.

Parameters:

item - the display item

data - the data object

icon - the display icon

Method Detail

getItem

public Object getItem()

Returns the diplay item of this entry.

Returns:

the display item

setItem

public void setItem(Object item)

Sets a new display item for this entry.

Parameters:

item - the new display item

getData

public Object getData()

Returns the data object of this entry.

Returns:

the data object

setData

public void setData(Object data)

Sets a new data object for this entry.

Parameters:

data - the new data object

getIcon

public Icon getIcon()

Returns the optional icon of this entry.

Returns:

the icon (may be null)

setIcon

public void setIcon(Icon icon)

Sets the display icon of this entry.

Parameters:

icon - the new diplay icon

isEnabled

public boolean isEnabled()

Determines whether this entry is enabled.

Returns:

true if the entry is enabled, false otherwise

setEnabled

public void setEnabled(boolean enabled)

Enables or disables this entry, depending on the value of the parameter enabled.

A disabled entry is renderered disabled and cannot be selected.

Parameters:

enabled - If true, this entry is enabled; otherwise this entry is disabled

putClientProperty

public void putClientProperty(Object key,
                              Object value)

Adds an arbitrary key/value "client property" to this entry.

The get/putClientProperty methods provide access to a small per-instance hashtable. Callers can use get/putClientProperty to annotate entries.

If value is null this method will remove the property.

Parameters:

key - the new client property key

value - the new client property value; if null this method will remove the property

See Also:

getClientProperty(java.lang.Object)

getClientProperty

public Object getClientProperty(Object key)

Returns the value of the property with the specified key. Only properties added with putClientProperty will return a non-null value.

Parameters:

key - the being queried

Returns:

the value of this property or null

See Also:

putClientProperty(java.lang.Object, java.lang.Object)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Compares obj with this entry.

Two entries are considered equal if their item and data objects are equal.

Overrides:

equals in class Object

Parameters:

obj - the Object to compare

Returns:

true if equal, otherwise false

See Also:

getData()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ItemList.Entry clone()

Returns a field-for-field copy of this instance.

Specified by:

clone in interface Copyable<ItemList.Entry>

Overrides:

clone in class Object

Returns:

a field-for-field copy of this instance.