Package 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.
    Author:
    Jeanette Winzenburg

    • Nested Class Summary

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

    • Field Summary

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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.

    • 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.