public class DockingWindowProperties extends PropertyMapContainer
Modifier and Type | Field and Description |
---|---|
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 and Description |
---|
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.
|
Modifier and Type | Method and Description |
---|---|
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.
|
getMap
public static final PropertyMapGroup PROPERTIES
public static final PropertyMapProperty TAB_PROPERTIES
public static final PropertyMapProperty DROP_FILTER_PROPERTIES
public static final BooleanProperty DRAG_ENABLED
public static final BooleanProperty UNDOCK_ENABLED
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.
public static final BooleanProperty DOCK_ENABLED
public static final BooleanProperty MINIMIZE_ENABLED
public static final BooleanProperty CLOSE_ENABLED
public static final BooleanProperty RESTORE_ENABLED
public static final BooleanProperty MAXIMIZE_ENABLED
public static final DockingWindowTitleProviderProperty TITLE_PROVIDER
public DockingWindowProperties()
public DockingWindowProperties(PropertyMap map)
map
- the property mappublic DockingWindowProperties(DockingWindowProperties inheritFrom)
inheritFrom
- the object from which to inherit property valuespublic DockingWindowProperties addSuperObject(DockingWindowProperties properties)
properties
- the object from which to inherit property valuespublic DockingWindowProperties removeSuperObject()
removeSuperObject(DockingWindowProperties)
instead.public DockingWindowProperties removeSuperObject(DockingWindowProperties superObject)
superObject
- the super object to removepublic WindowTabProperties getTabProperties()
public DockingWindowDropFilterProperties getDropFilterProperties()
public boolean getDragEnabled()
public DockingWindowProperties setDragEnabled(boolean enabled)
enabled
- if true, drag is enabled, otherwise it's disabledpublic boolean getUndockEnabled()
public DockingWindowProperties setUndockEnabled(boolean enabled)
enabled
- if true, a window can be undocked to a floating window,
otherwise it's disabledpublic 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.
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.
enabled
- if true, drop to floating window is enabled, otherwise it's disabledpublic boolean getDockEnabled()
public DockingWindowProperties setDockEnabled(boolean enabled)
enabled
- if true, a window can be docked to the root window from a floating window,
otherwise it's disabledpublic boolean getMinimizeEnabled()
public DockingWindowProperties setMinimizeEnabled(boolean enabled)
enabled
- if true, minimize is enabled, otherwise it's disabledpublic boolean getMaximizeEnabled()
public DockingWindowProperties setMaximizeEnabled(boolean enabled)
enabled
- if true, maximize is enabled, otherwise it's disabledpublic boolean getCloseEnabled()
public DockingWindowProperties setCloseEnabled(boolean enabled)
enabled
- if true, close is enabled, otherwise it's disabledpublic boolean getRestoreEnabled()
public DockingWindowProperties setRestoreEnabled(boolean enabled)
enabled
- if true, restore is enabled, otherwise it's disabledpublic DockingWindowTitleProvider getTitleProvider()
public DockingWindowProperties setTitleProvider(DockingWindowTitleProvider titleProvider)
titleProvider
- the title provider for the window