bibliothek.gui.dock.util
Class PropertyKey<A>

java.lang.Object
  extended by bibliothek.gui.dock.util.PropertyKey<A>
Type Parameters:
A - the type of entry

public class PropertyKey<A>
extends Object

The key for an entry of DockProperties.

Author:
Benjamin Sigg

Field Summary
static PropertyKey<Icon> DOCK_STATION_ICON
          The Icon used for a DockStation if it has no icon.
static PropertyKey<String> DOCK_STATION_TITLE
          The title of a DockStation if it has no title.
static PropertyKey<Icon> DOCKABLE_ICON
          The Icon used for a Dockable if it has no icon.
static PropertyKey<String> DOCKABLE_TITLE
          The title of a Dockable if it has no title.
 
Constructor Summary
PropertyKey(String id)
          Creates a new key.
PropertyKey(String id, A value)
          Creates a new key.
 
Method Summary
 boolean equals(Object obj)
           
 A getDefault()
          Gets a default-value that should be used when no value is set in the DockProperties.
 int hashCode()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DOCKABLE_ICON

public static final PropertyKey<Icon> DOCKABLE_ICON
The Icon used for a Dockable if it has no icon.


DOCK_STATION_ICON

public static final PropertyKey<Icon> DOCK_STATION_ICON
The Icon used for a DockStation if it has no icon.


DOCKABLE_TITLE

public static final PropertyKey<String> DOCKABLE_TITLE
The title of a Dockable if it has no title.


DOCK_STATION_TITLE

public static final PropertyKey<String> DOCK_STATION_TITLE
The title of a DockStation if it has no title.

Constructor Detail

PropertyKey

public PropertyKey(String id)
Creates a new key.

Parameters:
id - a unique identifier, should contain the name of the type of property, represented by this key.

PropertyKey

public PropertyKey(String id,
                   A value)
Creates a new key.

Parameters:
id - a unique identifier, should contain the name of the type of property, represented by this key.
value - the value that will be used when no value is set in the properties
Method Detail

getDefault

public final A getDefault()
Gets a default-value that should be used when no value is set in the DockProperties.

Returns:
the default-value

hashCode

public final int hashCode()
Overrides:
hashCode in class Object

equals

public final boolean equals(Object obj)
Overrides:
equals in class Object