com.vlsolutions.swing.docking
public class DockKey extends Object
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.
UNKNOWN: 2006/12/01 Lilian Chamontin : added client property support
Field Summary | |
---|---|
static String | PROPERTY_AUTOHIDEABLE Key identifying a change in the autohideEnabled property |
static String | PROPERTY_CLOSEABLE Key identifying a change in the closeEnabled property |
static String | PROPERTY_DOCKABLE_STATE
Key identifying a change in the dockable dockableState |
static String | PROPERTY_DOCKKEY
Key identifying a change in the dockKey property |
static String | PROPERTY_FLOATABLE Key identifying a change in the floatableEnabled property |
static String | PROPERTY_ICON Key identifying a change in the icon property |
static String | PROPERTY_MAXIMIZABLE Key identifying a change in the maximizedEnabled property |
static String | PROPERTY_NAME Key identifying a change in the name property |
static String | PROPERTY_NOTIFICATION Key identifying a change in the notification property |
static String | PROPERTY_TAB_NAME Key identifying a change in the tabname property (title used by tabbed containers) |
static 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(String dockKey)
Constructs a DockKey with dockKey (unique key) and name set to the same value | |
DockKey(String dockKey, String name)
Constructs a DockKey with dockKey (unique key) and a displayed name | |
DockKey(String dockKey, String name, String tooltip)
Constructs a DockKey with dockKey (unique key), a displayed name and a tooltip | |
DockKey(String dockKey, String name, String tooltip, Icon icon)
Constructs a DockKey with dockKey (unique key), a displayed name, a tooltip and
an icon. | |
DockKey(String dockKey, String name, String tooltip, 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(PropertyChangeListener listener) Hook for property change notification |
boolean | equals(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 |
String | getDockName() |
Icon | getIcon() Returns the icon displayed in title bars |
String | getKey() Returns the unique id designating the user component.
|
String | getName() Returns the name (or title) displayed in title bars |
Object | getProperty(String name) returns a property associated to this name, or null if the property is undefined |
float | getResizeWeight() |
String | getTabName() Returns the tab name (or tab title) displayed when the component is contained into a tabbed container. |
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(String name, Object value) Allows any property to be stored in a map associated with this dockkey. |
Object | removeProperty(String name) returns and removes a property associated to this name, or null if the property is undefined |
void | removePropertyChangeListener(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(String name) |
void | setFloatEnabled(boolean enabled) Updates the floatEnabled propety.
|
void | setIcon(Icon icon) Updates the icon property.
|
void | setKey(String dockKey)
Updates the dockKey property.
|
void | setMaximizeEnabled(boolean enabled) Updates the maximizeEnabled propety.
|
void | setName(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(String tabName) Updates the tabname property.
|
void | setTooltip(String tooltip) Updates the tooltip property.
|
String | toString() |
See Also: DockableState
Deprecated: use getKey instead
See Also: getKey
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()
Parameters: name the name used to lookup the property
Since: 2.1.2
default notification is making title bars blink.
Parameters: name the name used to lookup the property value the value of the property
Since: 2.1.2
Parameters: name the name used to lookup the property
Since: 2.1.2
PropertyListeners are notified of that change
PropertyListeners are notified of that change
Warning : do not call this method, it is for the sole use of the DockingDesktop API.
See Also: DockableState
Deprecated: use setKey instead
See Also: setKey
PropertyListeners are notified of that change
PropertyListeners are notified of that change
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()
PropertyListeners are notified of that change
PropertyListeners are notified of that change
PropertyListeners are notified of that change.
Default value is null, meaning the name
PropertyListeners are notified of that change
Since: 2.1
PropertyListeners are notified of that change