net.infonode.docking.properties
Class DockingWindowProperties

java.lang.Object
  net.infonode.properties.propertymap.PropertyMapContainer
      net.infonode.docking.properties.DockingWindowProperties

public class DockingWindowProperties
extends PropertyMapContainer

Properties and property values common for all docking windows.

Version:

$Revision: 1.25 $

Author:

$Author: jesper $

Field Summary

static BooleanProperty	CLOSE_ENABLED Enables/disables window close by the user.
static BooleanProperty	DOCK_ENABLED Enables/disables undock to a floating window.
static BooleanProperty	DRAG_ENABLED Enables/disables window drag by the user.
static PropertyMapProperty	DROP_FILTER_PROPERTIES Property values for drop filters.
static BooleanProperty	MAXIMIZE_ENABLED Enables/disables window maximize by the user.
static BooleanProperty	MINIMIZE_ENABLED Enables/disables window minimize by the user.
static PropertyMapGroup	PROPERTIES Property group containing all docking window properties.
static BooleanProperty	RESTORE_ENABLED Enables/disables window restore by the user.
static PropertyMapProperty	TAB_PROPERTIES Property values for the window tab when the window is located in a TabWindow or a WindowBar.
static DockingWindowTitleProviderProperty	TITLE_PROVIDER Provides a title for a window.
static BooleanProperty	UNDOCK_ENABLED Enables/disables undock to a floating window.
static BooleanProperty	UNDOCK_ON_DROP Enables/disables undock when dropped outside root window.

Constructor Summary

DockingWindowProperties()
Creates an empty property object.

DockingWindowProperties(DockingWindowProperties inheritFrom)
Creates a property object that inherit values from another property object.

DockingWindowProperties(PropertyMap map)
Creates a property map containing the map.

Method Summary

DockingWindowProperties	addSuperObject(DockingWindowProperties properties) Adds a super object from which property values are inherited.
boolean	getCloseEnabled() Returns true if the window close by the user is enabled.
boolean	getDockEnabled() Returns true if the window can be docked to the root window from a floating window.
boolean	getDragEnabled() Returns true if the window drag by the user is enabled.
DockingWindowDropFilterProperties	getDropFilterProperties() Returns the property values for drop filters.
boolean	getMaximizeEnabled() Returns true if the window maximize by the user is enabled.
boolean	getMinimizeEnabled() Returns true if the window minimize by the user is enabled.
boolean	getRestoreEnabled() Returns true if the window restore by the user is enabled.
WindowTabProperties	getTabProperties() Returns the property values for the window tab when the window is located in a TabWindow or a WindowBar.
DockingWindowTitleProvider	getTitleProvider() Returns the title provider for the window.
boolean	getUndockEnabled() Returns true if the window can be undocked to a floating window.
boolean	getUndockOnDropEnabled() Returns true if the window drag by the user and is dropped outside the root window should undock to a floating window.
DockingWindowProperties	removeSuperObject() Deprecated. Use removeSuperObject(DockingWindowProperties) instead.
DockingWindowProperties	removeSuperObject(DockingWindowProperties superObject) Removes a super object.
DockingWindowProperties	setCloseEnabled(boolean enabled) Enables/disables window close by the user.
DockingWindowProperties	setDockEnabled(boolean enabled) Enables/disables dock to the root window from a floating window.
DockingWindowProperties	setDragEnabled(boolean enabled) Enables/disables window drag by the user.
DockingWindowProperties	setMaximizeEnabled(boolean enabled) Enables/disables window maximize by the user.
DockingWindowProperties	setMinimizeEnabled(boolean enabled) Enables/disables window minimize by the user.
DockingWindowProperties	setRestoreEnabled(boolean enabled) Enables/disables window restore by the user.
DockingWindowProperties	setTitleProvider(DockingWindowTitleProvider titleProvider) Sets the title provider for the window.
DockingWindowProperties	setUndockEnabled(boolean enabled) Enables/disables undock to floating window.
DockingWindowProperties	setUndockOnDropEnabled(boolean enabled) Enables/disables if the window drag by the user and is dropped outside the root window should undock to a floating window or not.

Methods inherited from class net.infonode.properties.propertymap.PropertyMapContainer

getMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROPERTIES

public static final PropertyMapGroup PROPERTIES

Property group containing all docking window properties.

TAB_PROPERTIES

public static final PropertyMapProperty TAB_PROPERTIES

Property values for the window tab when the window is located in a TabWindow or a WindowBar.

DROP_FILTER_PROPERTIES

public static final PropertyMapProperty DROP_FILTER_PROPERTIES

Property values for drop filters.

Since:

IDW 1.4.0

DRAG_ENABLED

public static final BooleanProperty DRAG_ENABLED

Enables/disables window drag by the user.

Since:

IDW 1.2.0

UNDOCK_ENABLED

public static final BooleanProperty UNDOCK_ENABLED

Enables/disables undock to a floating window.

Since:

IDW 1.4.0

UNDOCK_ON_DROP

public static final BooleanProperty UNDOCK_ON_DROP

Enables/disables undock when dropped outside root window.

Note: This property will only have effect if window drag is enabled and undocking is enabled.

Since:

IDW 1.4.0

DOCK_ENABLED

public static final BooleanProperty DOCK_ENABLED

Enables/disables undock to a floating window.

Since:

IDW 1.4.0

MINIMIZE_ENABLED

public static final BooleanProperty MINIMIZE_ENABLED

Enables/disables window minimize by the user.

Since:

IDW 1.2.0

CLOSE_ENABLED

public static final BooleanProperty CLOSE_ENABLED

Enables/disables window close by the user.

Since:

IDW 1.2.0

RESTORE_ENABLED

public static final BooleanProperty RESTORE_ENABLED

Enables/disables window restore by the user.

Since:

IDW 1.2.0

MAXIMIZE_ENABLED

public static final BooleanProperty MAXIMIZE_ENABLED

Enables/disables window maximize by the user.

Since:

IDW 1.2.0

TITLE_PROVIDER

public static final DockingWindowTitleProviderProperty TITLE_PROVIDER

Provides a title for a window.

Since:

IDW 1.3.0

Constructor Detail

DockingWindowProperties

public DockingWindowProperties()

Creates an empty property object.

DockingWindowProperties

public DockingWindowProperties(PropertyMap map)

Creates a property map containing the map.

Parameters:

map - the property map

DockingWindowProperties

public DockingWindowProperties(DockingWindowProperties inheritFrom)

Creates a property object that inherit values from another property object.

Parameters:

inheritFrom - the object from which to inherit property values

Method Detail

addSuperObject

public DockingWindowProperties addSuperObject(DockingWindowProperties properties)

Adds a super object from which property values are inherited.

Parameters:

properties - the object from which to inherit property values

Returns:

this

removeSuperObject

public DockingWindowProperties removeSuperObject()

Deprecated. Use removeSuperObject(DockingWindowProperties) instead.

Removes the last added super object.

Returns:

this

Since:

IDW 1.1.0

removeSuperObject

public DockingWindowProperties removeSuperObject(DockingWindowProperties superObject)

Removes a super object.

Parameters:

superObject - the super object to remove

Returns:

this

Since:

IDW 1.3.0

getTabProperties

public WindowTabProperties getTabProperties()

Returns the property values for the window tab when the window is located in a TabWindow or a WindowBar.

Returns:

the property values for the window tab when the window is located in a TabWindow or a WindowBar

getDropFilterProperties

public DockingWindowDropFilterProperties getDropFilterProperties()

Returns the property values for drop filters.

Returns:

the property values for drop filters

Since:

IDW 1.4.0

getDragEnabled

public boolean getDragEnabled()

Returns true if the window drag by the user is enabled.

Returns:

true if the window drag is enabled

Since:

IDW 1.2.0

setDragEnabled

public DockingWindowProperties setDragEnabled(boolean enabled)

Enables/disables window drag by the user.

Parameters:

enabled - if true, drag is enabled, otherwise it's disabled

Returns:

this

Since:

IDW 1.2.0

getUndockEnabled

public boolean getUndockEnabled()

Returns true if the window can be undocked to a floating window.

Returns:

true if undocking is enabled

Since:

IDW 1.4.0

setUndockEnabled

public DockingWindowProperties setUndockEnabled(boolean enabled)

Enables/disables undock to floating window.

Parameters:

enabled - if true, a window can be undocked to a floating window, otherwise it's disabled

Returns:

this

Since:

IDW 1.4.0

getUndockOnDropEnabled

public boolean getUndockOnDropEnabled()

Returns true if the window drag by the user and is dropped outside the root window should undock to a floating window.

Note: This property will only have effect if drag is enabled.

Returns:

true if the dropped window should undock to a floating window

Since:

IDW 1.4.0

setUndockOnDropEnabled

public DockingWindowProperties setUndockOnDropEnabled(boolean enabled)

Enables/disables if the window drag by the user and is dropped outside the root window should undock to a floating window or not.

Note: This property will only have effect if drag is enabled.

Parameters:

enabled - if true, drop to floating window is enabled, otherwise it's disabled

Returns:

this

Since:

IDW 1.4.0

getDockEnabled

public boolean getDockEnabled()

Returns true if the window can be docked to the root window from a floating window.

Returns:

true if docking is enabled

Since:

IDW 1.4.0

setDockEnabled

public DockingWindowProperties setDockEnabled(boolean enabled)

Enables/disables dock to the root window from a floating window.

Parameters:

enabled - if true, a window can be docked to the root window from a floating window, otherwise it's disabled

Returns:

this

Since:

IDW 1.4.0

getMinimizeEnabled

public boolean getMinimizeEnabled()

Returns true if the window minimize by the user is enabled.

Returns:

true if the window minimize is enabled

Since:

IDW 1.2.0

setMinimizeEnabled

public DockingWindowProperties setMinimizeEnabled(boolean enabled)

Enables/disables window minimize by the user.

Parameters:

enabled - if true, minimize is enabled, otherwise it's disabled

Returns:

this

Since:

IDW 1.2.0

getMaximizeEnabled

public boolean getMaximizeEnabled()

Returns true if the window maximize by the user is enabled.

Returns:

true if the window maximize is enabled

Since:

IDW 1.2.0

setMaximizeEnabled

public DockingWindowProperties setMaximizeEnabled(boolean enabled)

Enables/disables window maximize by the user.

Parameters:

enabled - if true, maximize is enabled, otherwise it's disabled

Returns:

this

Since:

IDW 1.2.0

getCloseEnabled

public boolean getCloseEnabled()

Returns true if the window close by the user is enabled.

Returns:

true if the window close is enabled

Since:

IDW 1.2.0

setCloseEnabled

public DockingWindowProperties setCloseEnabled(boolean enabled)

Enables/disables window close by the user.

Parameters:

enabled - if true, close is enabled, otherwise it's disabled

Returns:

this

Since:

IDW 1.2.0

getRestoreEnabled

public boolean getRestoreEnabled()

Returns true if the window restore by the user is enabled.

Returns:

true if the window restore is enabled

Since:

IDW 1.2.0

setRestoreEnabled

public DockingWindowProperties setRestoreEnabled(boolean enabled)

Enables/disables window restore by the user.

Parameters:

enabled - if true, restore is enabled, otherwise it's disabled

Returns:

this

Since:

IDW 1.2.0

getTitleProvider

public DockingWindowTitleProvider getTitleProvider()

Returns the title provider for the window.

Returns:

the title provider for the window

Since:

IDW 1.3.0

setTitleProvider

public DockingWindowProperties setTitleProvider(DockingWindowTitleProvider titleProvider)

Sets the title provider for the window.

Parameters:

titleProvider - the title provider for the window

Since:

IDW 1.3.0