bibliothek.gui.dock.util.icon
Class DockIcon

java.lang.Object
  extended by bibliothek.gui.dock.util.AbstractUIValue<javax.swing.Icon,DockIcon>
      extended by bibliothek.gui.dock.util.icon.DockIcon
All Implemented Interfaces:
UIValue<javax.swing.Icon>
Direct Known Subclasses:
DockableIcon, DockActionIcon, DockStationIcon, PreferenceOperationIcon, TabMenuDockIcon

public abstract class DockIcon
extends AbstractUIValue<javax.swing.Icon,DockIcon>

This class is used to retreive Icons from the IconManager.

Author:
Benjamin Sigg

Field Summary
static Path KIND_ICON
          What kind of UIValue this is
 
Constructor Summary
DockIcon(java.lang.String id, Path kind)
          Creates a new DockIcon.
DockIcon(java.lang.String id, Path kind, javax.swing.Icon backup)
          Creates a new DockIcon.
 
Method Summary
protected  DockIcon me()
          Returns this.
 void setController(DockController controller)
          Sets the IconManager of controller
 
Methods inherited from class bibliothek.gui.dock.util.AbstractUIValue
changed, getBackup, getId, getKind, getValue, set, setBackup, setId, setKind, setManager, setValue, setValue, update, value
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

KIND_ICON

public static final Path KIND_ICON
What kind of UIValue this is

Constructor Detail

DockIcon

public DockIcon(java.lang.String id,
                Path kind)
Creates a new DockIcon.

Parameters:
id - the unique identifier of this icon
kind - what kind of UIValue this is

DockIcon

public DockIcon(java.lang.String id,
                Path kind,
                javax.swing.Icon backup)
Creates a new DockIcon.

Parameters:
id - the unique identifier of this icon
kind - what kind of UIValue this is
backup - the icon to be used if no other icon is found
Method Detail

setController

public void setController(DockController controller)
Sets the IconManager of controller

Parameters:
controller - the controller to observe, can be null

me

protected DockIcon me()
Description copied from class: AbstractUIValue
Returns this. This method can only be implemented when the generic boundaries are met, so this methods ensures that this is really an U, or abstract.

Specified by:
me in class AbstractUIValue<javax.swing.Icon,DockIcon>
Returns:
this