net.infonode.docking.properties
public class DockingWindowProperties extends PropertyMapContainer
Version: $Revision: 1.25 $
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(PropertyMap map)
Creates a property map containing the map.
| |
DockingWindowProperties(DockingWindowProperties inheritFrom)
Creates a property object that inherit values from another property object.
|
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()
Removes the last added super object.
|
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. |
Since: IDW 1.2.0
Since: IDW 1.4.0
Since: IDW 1.2.0
Since: IDW 1.4.0
Since: IDW 1.2.0
Since: IDW 1.2.0
Since: IDW 1.2.0
Since: IDW 1.3.0
Since: IDW 1.4.0
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
Parameters: map the property map
Parameters: inheritFrom the object from which to inherit property values
Parameters: properties the object from which to inherit property values
Returns: this
Returns: true if the window close is enabled
Since: IDW 1.2.0
Returns: true if docking is enabled
Since: IDW 1.4.0
Returns: true if the window drag is enabled
Since: IDW 1.2.0
Returns: the property values for drop filters
Since: IDW 1.4.0
Returns: true if the window maximize is enabled
Since: IDW 1.2.0
Returns: true if the window minimize is enabled
Since: IDW 1.2.0
Returns: true if the window restore is enabled
Since: IDW 1.2.0
Returns: the property values for the window tab when the window is located in a TabWindow or a WindowBar
Returns: the title provider for the window
Since: IDW 1.3.0
Returns: true if undocking is enabled
Since: IDW 1.4.0
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
Deprecated: Use removeSuperObject instead.
Removes the last added super object.Returns: this
Since: IDW 1.1.0
Parameters: superObject the super object to remove
Returns: this
Since: IDW 1.3.0
Parameters: enabled if true, close is enabled, otherwise it's disabled
Returns: this
Since: IDW 1.2.0
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
Parameters: enabled if true, drag is enabled, otherwise it's disabled
Returns: this
Since: IDW 1.2.0
Parameters: enabled if true, maximize is enabled, otherwise it's disabled
Returns: this
Since: IDW 1.2.0
Parameters: enabled if true, minimize is enabled, otherwise it's disabled
Returns: this
Since: IDW 1.2.0
Parameters: enabled if true, restore is enabled, otherwise it's disabled
Returns: this
Since: IDW 1.2.0
Parameters: titleProvider the title provider for the window
Since: IDW 1.3.0
Parameters: enabled if true, a window can be undocked to a floating window, otherwise it's disabled
Returns: this
Since: IDW 1.4.0
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