pub.vlsolutions.swing.docking.ws

Class WSDockKey

java.lang.Object

pub.vlsolutions.swing.docking.ws.WSDockKey

public class WSDockKey
extends java.lang.Object

Defines a key associated to a dockable in a workspace. The internal "key" will have to match the one of a DockKey when the worspace is applied to a DockingContext.

example : if your application uses a dockable with DockKey k = new DockKey("testDockable");
than your corresponding WSDockKey will be wsdk = new WSDockKey("testDockable");

Design note : We use this class insted of DockKey because sometimes dockkeys are lazily created (at dockable creation) and thus aren't already available when specifying a workspace.

Author:

Lilian Chamontin, VLSolutions

Constructor Summary

Constructors

Constructor and Description
WSDockKey(java.lang.String key)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
DockingConstants.Hide	getAutoHideBorder() Returns the autohide border of this dockable, or null if not set
java.lang.String	getKey() returns the inner key of this object (which must match a DockKey's 'key' instance variable)
int	hashCode() returns this object's hashcode
void	setAutoHideBorder(DockingConstants.Hide border) Updates the autohide border property
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WSDockKey

public WSDockKey(java.lang.String key)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

returns this object's hashcode

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

getKey

public java.lang.String getKey()

returns the inner key of this object (which must match a DockKey's 'key' instance variable)

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