com.vlsolutions.swing.docking
Class DockKey

java.lang.Object
  extended by com.vlsolutions.swing.docking.DockKey

public class DockKey
extends java.lang.Object

Provides a unique identification for a Dockable and runtime properties, like icon, name, tooltip, preferred audohide-zone...

As it is the object which identifies uniquely a user Dockable component, it should be associated with one and only one Dockable.

The unique key used for equals() comparison is the dockKey property, other properties can be shared by a set of DockKey (for example, you can share an icon, or even a display name between dockable Components).

Another usage is the decoration of a dockable container, providing informations such as its name, tooltip or icon.

Properties of a DockKey are listened to by the docking framework, so a change of name or icon is reflected on the GUI without further programming.


Field Summary
static java.lang.String PROPERTY_AUTOHIDEABLE
          Key identifying a change in the autohideEnabled property
static java.lang.String PROPERTY_CLOSEABLE
          Key identifying a change in the closeEnabled property
static java.lang.String PROPERTY_DOCKABLE_STATE
          Key identifying a change in the dockable dockableState
static java.lang.String PROPERTY_DOCKKEY
          Key identifying a change in the dockKey property
static java.lang.String PROPERTY_FLOATABLE
          Key identifying a change in the floatableEnabled property
static java.lang.String PROPERTY_ICON
          Key identifying a change in the icon property
static java.lang.String PROPERTY_MAXIMIZABLE
          Key identifying a change in the maximizedEnabled property
static java.lang.String PROPERTY_NAME
          Key identifying a change in the name property
static java.lang.String PROPERTY_NOTIFICATION
          Key identifying a change in the notification property
static java.lang.String PROPERTY_TAB_NAME
          Key identifying a change in the tabname property (title used by tabbed containers)
static java.lang.String PROPERTY_TOOLTIP
          Key identifying a change in the tooltip property
 
Constructor Summary
DockKey()
          JavaBeans constructor : If used, also think to set the dockKey property.
DockKey(java.lang.String dockKey)
          Constructs a DockKey with dockKey (unique key) and name set to the same value
DockKey(java.lang.String dockKey, java.lang.String name)
          Constructs a DockKey with dockKey (unique key) and a displayed name
DockKey(java.lang.String dockKey, java.lang.String name, java.lang.String tooltip)
          Constructs a DockKey with dockKey (unique key), a displayed name and a tooltip
DockKey(java.lang.String dockKey, java.lang.String name, java.lang.String tooltip, javax.swing.Icon icon)
          Constructs a DockKey with dockKey (unique key), a displayed name, a tooltip and an icon.
DockKey(java.lang.String dockKey, java.lang.String name, java.lang.String tooltip, javax.swing.Icon icon, DockingConstants.Hide hideBorder)
          Constructs a DockKey with dockKey (unique key), a displayed name, a tooltip, an icon and a default autohide border.
 
Method Summary
 void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
          Hook for property change notification
 boolean equals(java.lang.Object o)
          Overriden for Map storage needs
 DockableActionCustomizer getActionCustomizer()
          Returns the action customizer associated to this dockkey (may return null)
 DockingConstants.Hide getAutoHideBorder()
          Returns the autohide border of this dockable, or null if not set
 int getDockableState()
          returns the current visible dockableState of the dockable (see DockableState.STATE_ for enumaration values)
 DockGroup getDockGroup()
          returns the dockGroup of this dockable
 java.lang.String getDockName()
          Deprecated. use getKey instead
 javax.swing.Icon getIcon()
          Returns the icon displayed in title bars
 java.lang.String getKey()
          Returns the unique id designating the user component.
 java.lang.String getName()
          Returns the name (or title) displayed in title bars
 java.lang.Object getProperty(java.lang.String name)
          returns a property associated to this name, or null if the property is undefined
 float getResizeWeight()
           
 java.lang.String getTabName()
          Returns the tab name (or tab title) displayed when the component is contained into a tabbed container.
 java.lang.String getTooltip()
          Returns the tooltip associated to the title bar
 int hashCode()
          Overriden for Map storage needs
 boolean isAutoHideEnabled()
          Returns try if autohiding is enabled
 boolean isCloseEnabled()
          Returns true if this dockable can be closed
 boolean isFloatEnabled()
          Returns true if this dockable can be detached from its desktop
 boolean isMaximizeEnabled()
          Returns true if this dockable can be maximized
 boolean isNotification()
          Returns true is a notification has been set.
 void putProperty(java.lang.String name, java.lang.Object value)
          Allows any property to be stored in a map associated with this dockkey.
 java.lang.Object removeProperty(java.lang.String name)
          returns and removes a property associated to this name, or null if the property is undefined
 void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
          Remove a property change notification
 void setActionCustomizer(DockableActionCustomizer actionCustomizer)
          Updates the action customizer of this dockable
 void setAutoHideBorder(DockingConstants.Hide border)
          Updates the autohide border property
 void setAutoHideEnabled(boolean enabled)
          Updates the autohideEnabled propety.
 void setCloseEnabled(boolean enabled)
          Updates the closeEnabled propety.
 void setDockableState(int dockableState)
          updates the dockableState property.
 void setDockGroup(DockGroup group)
          Updates the dockGroup of this dockable.
 void setDockName(java.lang.String name)
          Deprecated. use setKey instead
 void setFloatEnabled(boolean enabled)
          Updates the floatEnabled propety.
 void setIcon(javax.swing.Icon icon)
          Updates the icon property.
 void setKey(java.lang.String dockKey)
          Updates the dockKey property.
 void setMaximizeEnabled(boolean enabled)
          Updates the maximizeEnabled propety.
 void setName(java.lang.String name)
          Updates the name property.
 void setNotification(boolean notification)
          Updates the notification propety.
 void setResizeWeight(float weight)
          updates the resize weight of this dockable.
 void setTabName(java.lang.String tabName)
          Updates the tabname property.
 void setTooltip(java.lang.String tooltip)
          Updates the tooltip property.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

PROPERTY_TOOLTIP

public static final java.lang.String PROPERTY_TOOLTIP
Key identifying a change in the tooltip property

See Also:
Constant Field Values

PROPERTY_NAME

public static final java.lang.String PROPERTY_NAME
Key identifying a change in the name property

See Also:
Constant Field Values

PROPERTY_TAB_NAME

public static final java.lang.String PROPERTY_TAB_NAME
Key identifying a change in the tabname property (title used by tabbed containers)

See Also:
Constant Field Values

PROPERTY_DOCKKEY

public static final java.lang.String PROPERTY_DOCKKEY
Key identifying a change in the dockKey property

See Also:
Constant Field Values

PROPERTY_ICON

public static final java.lang.String PROPERTY_ICON
Key identifying a change in the icon property

See Also:
Constant Field Values

PROPERTY_AUTOHIDEABLE

public static final java.lang.String PROPERTY_AUTOHIDEABLE
Key identifying a change in the autohideEnabled property

See Also:
Constant Field Values

PROPERTY_CLOSEABLE

public static final java.lang.String PROPERTY_CLOSEABLE
Key identifying a change in the closeEnabled property

See Also:
Constant Field Values

PROPERTY_MAXIMIZABLE

public static final java.lang.String PROPERTY_MAXIMIZABLE
Key identifying a change in the maximizedEnabled property

See Also:
Constant Field Values

PROPERTY_NOTIFICATION

public static final java.lang.String PROPERTY_NOTIFICATION
Key identifying a change in the notification property

See Also:
Constant Field Values

PROPERTY_FLOATABLE

public static final java.lang.String PROPERTY_FLOATABLE
Key identifying a change in the floatableEnabled property

See Also:
Constant Field Values

PROPERTY_DOCKABLE_STATE

public static final java.lang.String PROPERTY_DOCKABLE_STATE
Key identifying a change in the dockable dockableState

See Also:
Constant Field Values
Constructor Detail

DockKey

public DockKey()
JavaBeans constructor : If used, also think to set the dockKey property.


DockKey

public DockKey(java.lang.String dockKey)
Constructs a DockKey with dockKey (unique key) and name set to the same value


DockKey

public DockKey(java.lang.String dockKey,
               java.lang.String name)
Constructs a DockKey with dockKey (unique key) and a displayed name


DockKey

public DockKey(java.lang.String dockKey,
               java.lang.String name,
               java.lang.String tooltip)
Constructs a DockKey with dockKey (unique key), a displayed name and a tooltip


DockKey

public DockKey(java.lang.String dockKey,
               java.lang.String name,
               java.lang.String tooltip,
               javax.swing.Icon icon)
Constructs a DockKey with dockKey (unique key), a displayed name, a tooltip and an icon.


DockKey

public DockKey(java.lang.String dockKey,
               java.lang.String name,
               java.lang.String tooltip,
               javax.swing.Icon icon,
               DockingConstants.Hide hideBorder)
Constructs a DockKey with dockKey (unique key), a displayed name, a tooltip, an icon and a default autohide border.

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Hook for property change notification


removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Remove a property change notification


getIcon

public javax.swing.Icon getIcon()
Returns the icon displayed in title bars


getName

public java.lang.String getName()
Returns the name (or title) displayed in title bars


getTooltip

public java.lang.String getTooltip()
Returns the tooltip associated to the title bar


getKey

public java.lang.String getKey()
Returns the unique id designating the user component.

Note : This used to be the getDockName prior version 2.0. It has been renamed to clarify the concept (there was a naming problem between getName() and getDockName()


setTooltip

public void setTooltip(java.lang.String tooltip)
Updates the tooltip property.

PropertyListeners are notified of that change


setName

public void setName(java.lang.String name)
Updates the name property. The name property is used by dockable container headers to associate a title with a dockable.

PropertyListeners are notified of that change


getTabName

public java.lang.String getTabName()
Returns the tab name (or tab title) displayed when the component is contained into a tabbed container.


setTabName

public void setTabName(java.lang.String tabName)
Updates the tabname property. This property is used by tabbed containers to display a shorter version of the title of this dockable.

Default value is null, meaning the name

PropertyListeners are notified of that change

Since:
2.1

setIcon

public void setIcon(javax.swing.Icon icon)
Updates the icon property.

PropertyListeners are notified of that change


setKey

public void setKey(java.lang.String dockKey)
Updates the dockKey property.

Although PropertyListeners are notified of that change, it is not recommended to change dynamicaly the dockKey property, as it is heavily used in the docking framework to identify dockable components.

Note : This used to be the getDockName prior version 2.0. It has been renamed to clarify the concept (there was a naming problem between getName() and getDockName()


getDockName

public java.lang.String getDockName()
Deprecated. use getKey instead

See Also:
getKey()

setDockName

public void setDockName(java.lang.String name)
Deprecated. use setKey instead

See Also:
setKey(String)

getAutoHideBorder

public DockingConstants.Hide getAutoHideBorder()
Returns the autohide border of this dockable, or null if not set


setAutoHideBorder

public void setAutoHideBorder(DockingConstants.Hide border)
Updates the autohide border property


isAutoHideEnabled

public boolean isAutoHideEnabled()
Returns try if autohiding is enabled


setAutoHideEnabled

public void setAutoHideEnabled(boolean enabled)
Updates the autohideEnabled propety.

PropertyListeners are notified of that change


isCloseEnabled

public boolean isCloseEnabled()
Returns true if this dockable can be closed


setCloseEnabled

public void setCloseEnabled(boolean enabled)
Updates the closeEnabled propety.

PropertyListeners are notified of that change


isMaximizeEnabled

public boolean isMaximizeEnabled()
Returns true if this dockable can be maximized


setMaximizeEnabled

public void setMaximizeEnabled(boolean enabled)
Updates the maximizeEnabled propety.

PropertyListeners are notified of that change


isFloatEnabled

public boolean isFloatEnabled()
Returns true if this dockable can be detached from its desktop


setFloatEnabled

public void setFloatEnabled(boolean enabled)
Updates the floatEnabled propety.

PropertyListeners are notified of that change


isNotification

public boolean isNotification()
Returns true is a notification has been set.

default notification is making title bars blink.


setNotification

public void setNotification(boolean notification)
Updates the notification propety. Notification results in a visual change of the dockable in order to attract attention from the user to this dockable.

PropertyListeners are notified of that change.


hashCode

public int hashCode()
Overriden for Map storage needs

Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)
Overriden for Map storage needs

Overrides:
equals in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getActionCustomizer

public DockableActionCustomizer getActionCustomizer()
Returns the action customizer associated to this dockkey (may return null)


setActionCustomizer

public void setActionCustomizer(DockableActionCustomizer actionCustomizer)
Updates the action customizer of this dockable


setDockGroup

public void setDockGroup(DockGroup group)
Updates the dockGroup of this dockable.


getDockGroup

public DockGroup getDockGroup()
returns the dockGroup of this dockable


getDockableState

public int getDockableState()
returns the current visible dockableState of the dockable (see DockableState.STATE_ for enumaration values)

See Also:
DockableState

setDockableState

public void setDockableState(int dockableState)
updates the dockableState property.

Warning : do not call this method, it is for the sole use of the DockingDesktop API.

See Also:
DockableState

getResizeWeight

public float getResizeWeight()

setResizeWeight

public void setResizeWeight(float weight)
updates the resize weight of this dockable. Valid values range between 0.0f and 1.0f


putProperty

public void putProperty(java.lang.String name,
                        java.lang.Object value)
Allows any property to be stored in a map associated with this dockkey. A property change event is propagated to listeners (with a property name equal to "clientProperty." + name)

Parameters:
name - the name used to lookup the property
value - the value of the property
Since:
2.1.2

getProperty

public java.lang.Object getProperty(java.lang.String name)
returns a property associated to this name, or null if the property is undefined

Parameters:
name - the name used to lookup the property
Since:
2.1.2

removeProperty

public java.lang.Object removeProperty(java.lang.String name)
returns and removes a property associated to this name, or null if the property is undefined

Parameters:
name - the name used to lookup the property
Since:
2.1.2


© Copyright 2004-2007 VLSolutions. All Rights Reserved.
www.vlsolutions.com : Java Components - Smart Client Applications