org.jdesktop.swingx.renderer
Interface IconValue

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
MappedValue

public interface IconValue
extends java.io.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
static class IconValue.IconType
          The cell type the icon is used for.
 
Field Summary
static IconValue ICON
          Returns the value as Icon if possible or null.
static IconValue NONE
          Always NULL_ICON.
static javax.swing.Icon NULL_ICON
          A marker icon used to indicate a null.
 
Method Summary
 javax.swing.Icon getIcon(java.lang.Object value)
          Returns a icon representation of the given value.
 

Field Detail

NULL_ICON

static final javax.swing.Icon NULL_ICON
A marker icon used to indicate a null.


ICON

static final IconValue ICON
Returns the value as Icon if possible or null.


NONE

static final IconValue NONE
Always NULL_ICON. This is useful to indicate that we really want no icon instead of f.i. a default provided by the CellContext.

Method Detail

getIcon

javax.swing.Icon getIcon(java.lang.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.