Package net.infonode.docking.properties
Class RootWindowProperties
- java.lang.Object
-
- net.infonode.properties.propertymap.PropertyMapContainer
-
- net.infonode.docking.properties.RootWindowProperties
-
public class RootWindowProperties extends PropertyMapContainer
Properties and property values for a root window.
-
-
Field Summary
Fields Modifier and Type Field Description static IntegerProperty
ABORT_DRAG_KEY
Key code for the key that aborts a drag.static PropertyMapProperty
COMPONENT_PROPERTIES
The root window component property values.static int
DEFAULT_WINDOW_TAB_BUTTON_ICON_SIZE
The size of the default window tab button icons.static PropertyMapProperty
DOCKING_WINDOW_PROPERTIES
Default property values for DockingWindows inside this root window.static BooleanProperty
DOUBLE_CLICK_RESTORES_WINDOW
Double clicking on a minimized window in a window bar restores it.static PropertyMapProperty
DRAG_LABEL_PROPERTIES
The window drag label property values.static IntegerProperty
DRAG_RECTANGLE_BORDER_WIDTH
The width of the drag rectangle border.static PropertyMapProperty
DRAG_RECTANGLE_SHAPED_PANEL_PROPERTIES
Shaped panel properties for the drag rectangle.static IntegerProperty
EDGE_SPLIT_DISTANCE
Inside this distance from the window edge a mouse drag will trigger a window split.static PropertyMapProperty
FLOATING_WINDOW_PROPERTIES
Default property values for floating windows inside this root window.static PropertyMapGroup
PROPERTIES
Property group containing all root window properties.static BooleanProperty
RECURSIVE_TABS_ENABLED
If true, makes it possible for the user to create tab windows inside other tab windows when dragging windows.static PropertyMapProperty
SHAPED_PANEL_PROPERTIES
The root window shaped panel property values.static PropertyMapProperty
SPLIT_WINDOW_PROPERTIES
Default property values for split windows inside this root window.static PropertyMapProperty
TAB_WINDOW_PROPERTIES
Default property values for tab windows inside this root window.static PropertyMapProperty
VIEW_PROPERTIES
Default property values for views inside this root window.static PropertyMapProperty
WINDOW_AREA_PROPERTIES
The window area component property values.static PropertyMapProperty
WINDOW_AREA_SHAPED_PANEL_PROPERTIES
The window area shaped panel property values.static PropertyMapProperty
WINDOW_BAR_PROPERTIES
The default window bar property values.
-
Constructor Summary
Constructors Constructor Description RootWindowProperties()
Creates an empty property object.RootWindowProperties(RootWindowProperties inheritFrom)
Creates a property object which inherits property values from another object.RootWindowProperties(PropertyMap map)
Creates a property object containing the map.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description RootWindowProperties
addSuperObject(RootWindowProperties properties)
Adds a super object from which property values are inherited.static RootWindowProperties
createDefault()
Creates a property object that inherits default property values.int
getAbortDragKey()
Returns the key code for the key that aborts a drag.ComponentProperties
getComponentProperties()
Returns the property values for the root window component.DockingWindowProperties
getDockingWindowProperties()
Returns the default property values for docking windows.boolean
getDoubleClickRestoresWindow()
Returns true if double clicking on a window tab in a window bar restores the window.ComponentProperties
getDragLabelProperties()
Returns the property values for the drag label.int
getDragRectangleBorderWidth()
Returns the border width of the drag rectangle.ShapedPanelProperties
getDragRectangleShapedPanelProperties()
Shaped panel properties for the drag rectangle.int
getEdgeSplitDistance()
Returns the distance from the window edge inside which a mouse drag will trigger a window split.FloatingWindowProperties
getFloatingWindowProperties()
Returns the default property values for floating windows.boolean
getRecursiveTabsEnabled()
Returns true if the user is allowed to place tab windows inside other tab windows.ShapedPanelProperties
getShapedPanelProperties()
Returns the property values for the root window shaped panel.SplitWindowProperties
getSplitWindowProperties()
Returns the default property values for split windows.TabWindowProperties
getTabWindowProperties()
Returns the default property values for tab windows.ViewProperties
getViewProperties()
Returns the default property values for views.ComponentProperties
getWindowAreaProperties()
Returns the component property values for the window area component.ShapedPanelProperties
getWindowAreaShapedPanelProperties()
Returns the shaped panel property values for the window area component.WindowBarProperties
getWindowBarProperties()
Returns the default window bar property values.RootWindowProperties
removeSuperObject()
Deprecated.UseremoveSuperObject(RootWindowProperties)
instead.RootWindowProperties
removeSuperObject(RootWindowProperties superObject)
Removes a super object.RootWindowProperties
replaceSuperObject(RootWindowProperties oldSuperObject, RootWindowProperties newSuperObject)
Replaces a super object.RootWindowProperties
setAbortDragKey(int key)
Sets the key code for the key that aborts a drag.RootWindowProperties
setDoubleClickRestoresWindow(boolean enabled)
If set to true, double clicking on a window tab in a window bar restores the window.RootWindowProperties
setDragRectangleBorderWidth(int width)
Sets the border width of the drag rectangle.RootWindowProperties
setEdgeSplitDistance(int size)
Sets the distance from the window edge inside which a mouse drag will trigger a window split.RootWindowProperties
setRecursiveTabsEnabled(boolean enabled)
If set to true, the user is allowed to place tab windows inside other tab windows.-
Methods inherited from class net.infonode.properties.propertymap.PropertyMapContainer
getMap
-
-
-
-
Field Detail
-
DEFAULT_WINDOW_TAB_BUTTON_ICON_SIZE
public static final int DEFAULT_WINDOW_TAB_BUTTON_ICON_SIZE
The size of the default window tab button icons.- See Also:
- Constant Field Values
-
PROPERTIES
public static final PropertyMapGroup PROPERTIES
Property group containing all root window properties.
-
COMPONENT_PROPERTIES
public static final PropertyMapProperty COMPONENT_PROPERTIES
The root window component property values.
-
SHAPED_PANEL_PROPERTIES
public static final PropertyMapProperty SHAPED_PANEL_PROPERTIES
The root window shaped panel property values.
-
WINDOW_AREA_PROPERTIES
public static final PropertyMapProperty WINDOW_AREA_PROPERTIES
The window area component property values. The window area is the area inside the WindowBars.
-
WINDOW_AREA_SHAPED_PANEL_PROPERTIES
public static final PropertyMapProperty WINDOW_AREA_SHAPED_PANEL_PROPERTIES
The window area shaped panel property values. The window area is the area inside the WindowBars.
-
DRAG_RECTANGLE_SHAPED_PANEL_PROPERTIES
public static final PropertyMapProperty DRAG_RECTANGLE_SHAPED_PANEL_PROPERTIES
Shaped panel properties for the drag rectangle. Setting a painter disables the default drag rectangle.- Since:
- IDW 1.2.0
-
DRAG_RECTANGLE_BORDER_WIDTH
public static final IntegerProperty DRAG_RECTANGLE_BORDER_WIDTH
The width of the drag rectangle border.
-
DRAG_LABEL_PROPERTIES
public static final PropertyMapProperty DRAG_LABEL_PROPERTIES
The window drag label property values.
-
DOCKING_WINDOW_PROPERTIES
public static final PropertyMapProperty DOCKING_WINDOW_PROPERTIES
Default property values for DockingWindows inside this root window.
-
TAB_WINDOW_PROPERTIES
public static final PropertyMapProperty TAB_WINDOW_PROPERTIES
Default property values for tab windows inside this root window.
-
SPLIT_WINDOW_PROPERTIES
public static final PropertyMapProperty SPLIT_WINDOW_PROPERTIES
Default property values for split windows inside this root window.
-
FLOATING_WINDOW_PROPERTIES
public static final PropertyMapProperty FLOATING_WINDOW_PROPERTIES
Default property values for floating windows inside this root window.- Since:
- IDW 1.4.0
-
VIEW_PROPERTIES
public static final PropertyMapProperty VIEW_PROPERTIES
Default property values for views inside this root window.
-
DOUBLE_CLICK_RESTORES_WINDOW
public static final BooleanProperty DOUBLE_CLICK_RESTORES_WINDOW
Double clicking on a minimized window in a window bar restores it.
-
RECURSIVE_TABS_ENABLED
public static final BooleanProperty RECURSIVE_TABS_ENABLED
If true, makes it possible for the user to create tab windows inside other tab windows when dragging windows. If false, only one level of tab windows is allowed. Changing the value of this property does not alter the window tree.
-
EDGE_SPLIT_DISTANCE
public static final IntegerProperty EDGE_SPLIT_DISTANCE
Inside this distance from the window edge a mouse drag will trigger a window split.
-
ABORT_DRAG_KEY
public static final IntegerProperty ABORT_DRAG_KEY
Key code for the key that aborts a drag.
-
WINDOW_BAR_PROPERTIES
public static final PropertyMapProperty WINDOW_BAR_PROPERTIES
The default window bar property values.- Since:
- IDW 1.1.0
-
-
Constructor Detail
-
RootWindowProperties
public RootWindowProperties()
Creates an empty property object.
-
RootWindowProperties
public RootWindowProperties(PropertyMap map)
Creates a property object containing the map.- Parameters:
map
- the property map
-
RootWindowProperties
public RootWindowProperties(RootWindowProperties inheritFrom)
Creates a property object which inherits property values from another object.- Parameters:
inheritFrom
- the object which from to inherit property values
-
-
Method Detail
-
createDefault
public static RootWindowProperties createDefault()
Creates a property object that inherits default property values.- Returns:
- a new property object that inherits default property values
-
addSuperObject
public RootWindowProperties addSuperObject(RootWindowProperties 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 RootWindowProperties removeSuperObject()
Deprecated.UseremoveSuperObject(RootWindowProperties)
instead.Removes the last added super object.- Returns:
- this
- Since:
- IDW 1.1.0
-
removeSuperObject
public RootWindowProperties removeSuperObject(RootWindowProperties superObject)
Removes a super object.- Parameters:
superObject
- the super object to remove- Returns:
- this
- Since:
- IDW 1.3.0
-
replaceSuperObject
public RootWindowProperties replaceSuperObject(RootWindowProperties oldSuperObject, RootWindowProperties newSuperObject)
Replaces a super object.- Parameters:
oldSuperObject
- the super object to be replacednewSuperObject
- the super object to replace it with- Returns:
- this
- Since:
- IDW 1.3.0
-
getTabWindowProperties
public TabWindowProperties getTabWindowProperties()
Returns the default property values for tab windows.- Returns:
- the default property values for tab windows
-
getSplitWindowProperties
public SplitWindowProperties getSplitWindowProperties()
Returns the default property values for split windows.- Returns:
- the default property values for split windows
-
getFloatingWindowProperties
public FloatingWindowProperties getFloatingWindowProperties()
Returns the default property values for floating windows.- Returns:
- the default property values for floating windows
- Since:
- IDW 1.4.0
-
getViewProperties
public ViewProperties getViewProperties()
Returns the default property values for views.- Returns:
- the default property values for views
-
getDockingWindowProperties
public DockingWindowProperties getDockingWindowProperties()
Returns the default property values for docking windows.- Returns:
- the default property values for docking windows
-
setDragRectangleBorderWidth
public RootWindowProperties setDragRectangleBorderWidth(int width)
Sets the border width of the drag rectangle.- Parameters:
width
- the border width- Returns:
- this
-
getDragRectangleBorderWidth
public int getDragRectangleBorderWidth()
Returns the border width of the drag rectangle.- Returns:
- the border width of the drag rectangle
-
getRecursiveTabsEnabled
public boolean getRecursiveTabsEnabled()
Returns true if the user is allowed to place tab windows inside other tab windows.- Returns:
- true if tab windows are allowed to be placed in other tab windows
-
getDoubleClickRestoresWindow
public boolean getDoubleClickRestoresWindow()
Returns true if double clicking on a window tab in a window bar restores the window.- Returns:
- true if double clicking on a window tab in a window bar restores the window
-
setDoubleClickRestoresWindow
public RootWindowProperties setDoubleClickRestoresWindow(boolean enabled)
If set to true, double clicking on a window tab in a window bar restores the window.- Parameters:
enabled
- if true, double clicking on a window tab in a window bar restores the window- Returns:
- this
-
setRecursiveTabsEnabled
public RootWindowProperties setRecursiveTabsEnabled(boolean enabled)
If set to true, the user is allowed to place tab windows inside other tab windows.- Parameters:
enabled
- if true, the user is allowed to place tab windows inside other tab windows- Returns:
- this
-
getDragLabelProperties
public ComponentProperties getDragLabelProperties()
Returns the property values for the drag label.- Returns:
- the property values for the drag label
-
getComponentProperties
public ComponentProperties getComponentProperties()
Returns the property values for the root window component.- Returns:
- the property values for the root window component
-
getShapedPanelProperties
public ShapedPanelProperties getShapedPanelProperties()
Returns the property values for the root window shaped panel.- Returns:
- the property values for the root window shaped panel
- Since:
- IDW 1.2.0
-
getWindowAreaProperties
public ComponentProperties getWindowAreaProperties()
Returns the component property values for the window area component.- Returns:
- the component property values for the window area component
-
getWindowAreaShapedPanelProperties
public ShapedPanelProperties getWindowAreaShapedPanelProperties()
Returns the shaped panel property values for the window area component.- Returns:
- the shaped panel property values for the window area component
-
setEdgeSplitDistance
public RootWindowProperties setEdgeSplitDistance(int size)
Sets the distance from the window edge inside which a mouse drag will trigger a window split.- Parameters:
size
- the distance from the window edge inside which a mouse drag will trigger a window split- Returns:
- this
-
getEdgeSplitDistance
public int getEdgeSplitDistance()
Returns the distance from the window edge inside which a mouse drag will trigger a window split.- Returns:
- the distance from the window edge inside which a mouse drag will trigger a window split
-
getAbortDragKey
public int getAbortDragKey()
Returns the key code for the key that aborts a drag.- Returns:
- the key code for the key that aborts a drag
-
setAbortDragKey
public RootWindowProperties setAbortDragKey(int key)
Sets the key code for the key that aborts a drag.- Parameters:
key
- the key code for the key that aborts a drag- Returns:
- this
-
getWindowBarProperties
public WindowBarProperties getWindowBarProperties()
Returns the default window bar property values.- Returns:
- the default window bar property values
- Since:
- IDW 1.1.0
-
getDragRectangleShapedPanelProperties
public ShapedPanelProperties getDragRectangleShapedPanelProperties()
Shaped panel properties for the drag rectangle. Setting a painter disables the default drag rectangle.- Returns:
- the drag rectangle shaped panel properties
- Since:
- IDW 1.2.0
-
-