Interface IconValue

All Superinterfaces:

Serializable

All Known Implementing Classes:

MappedValue, MappedValues.MappedValueUIResource

public interface IconValue
extends Serializable

A simple converter to return a Icon representation of an Object.

This class is intended to be the "small coin" to configure/format icon cell content of concrete subclasses of ComponentProvider.

NOTE: this is experimental, most probably will change. A (near) future version with change the signature of the getIcon method to

Icon getIcon(Object value, IconType type);

That will allow a more fine-grained control of custom icons in tree rendering.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	IconValue.IconType	The cell type the icon is used for.

Field Summary

Fields

Modifier and Type	Field	Description
static final Icon	NULL_ICON	A marker icon used to indicate a null.

Method Summary

Modifier and Type	Method	Description
Icon	getIcon(Object value)	Returns a icon representation of the given value.

Field Details

NULL_ICON

static final Icon NULL_ICON

A marker icon used to indicate a null.

Method Details

getIcon

Icon getIcon(Object value)

Returns a icon representation of the given value.

Parameters:

value - the object to present as Icon

Returns:

a Icon representation of the given value, may be null if none available.