Package net.infonode.docking.properties
Class FloatingWindowProperties
- java.lang.Object
-
- net.infonode.properties.propertymap.PropertyMapContainer
-
- net.infonode.docking.properties.FloatingWindowProperties
-
public class FloatingWindowProperties extends PropertyMapContainer
Properties and property values for floating windows.- Since:
- IDW 1.4.0
-
-
Field Summary
Fields Modifier and Type Field Description static BooleanProperty
AUTO_CLOSE_ENABLED
Auto close enabledstatic PropertyMapProperty
COMPONENT_PROPERTIES
Properties for the componentstatic PropertyMapGroup
PROPERTIES
Property group containing all floating window properties.static PropertyMapProperty
SHAPED_PANEL_PROPERTIES
Properties for the shaped panelstatic BooleanProperty
USE_FRAME
If true the floating window will be created as a JFrame, otherwise a JDialog will be created.
-
Constructor Summary
Constructors Constructor Description FloatingWindowProperties()
Creates an empty property object.FloatingWindowProperties(FloatingWindowProperties inheritFrom)
Creates a property object that inherit values from another property object.FloatingWindowProperties(PropertyMap map)
Creates a property map containing the map.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FloatingWindowProperties
addSuperObject(FloatingWindowProperties properties)
Adds a super object from which property values are inherited.boolean
getAutoCloseEnabled()
Returns true if the floating window should be automatically closed when it doesn't contain any child window.ComponentProperties
getComponentProperties()
Gets the component propertiesShapedPanelProperties
getShapedPanelProperties()
Gets the shaped panel propertiesboolean
getUseFrame()
Returns true if the floating window should be created as a JFrame, otherwise a JDialog is used.FloatingWindowProperties
removeSuperObject(FloatingWindowProperties superObject)
Removes a super object.FloatingWindowProperties
setAutoCloseEnabled(boolean enabled)
Enables/disables if the floating window should be automatically closed when it doesn't contain any child window.FloatingWindowProperties
setUseFrame(boolean enabled)
Set to true if the floating window should be created as a JFrame, otherwise a JDialog is used.-
Methods inherited from class net.infonode.properties.propertymap.PropertyMapContainer
getMap
-
-
-
-
Field Detail
-
PROPERTIES
public static final PropertyMapGroup PROPERTIES
Property group containing all floating window properties.
-
COMPONENT_PROPERTIES
public static final PropertyMapProperty COMPONENT_PROPERTIES
Properties for the component- See Also:
getComponentProperties()
-
SHAPED_PANEL_PROPERTIES
public static final PropertyMapProperty SHAPED_PANEL_PROPERTIES
Properties for the shaped panel- See Also:
getShapedPanelProperties()
-
AUTO_CLOSE_ENABLED
public static final BooleanProperty AUTO_CLOSE_ENABLED
Auto close enabled
-
USE_FRAME
public static final BooleanProperty USE_FRAME
If true the floating window will be created as a JFrame, otherwise a JDialog will be created. Note that the value of this property only takes effect when the FloatingWindow is created, it doesn't affect existing FloatingWindows (but this might change in future versions).- Since:
- IDW 1.5.0
-
-
Constructor Detail
-
FloatingWindowProperties
public FloatingWindowProperties()
Creates an empty property object.
-
FloatingWindowProperties
public FloatingWindowProperties(PropertyMap map)
Creates a property map containing the map.- Parameters:
map
- the property map
-
FloatingWindowProperties
public FloatingWindowProperties(FloatingWindowProperties 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 FloatingWindowProperties addSuperObject(FloatingWindowProperties 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 FloatingWindowProperties removeSuperObject(FloatingWindowProperties superObject)
Removes a super object.- Parameters:
superObject
- the super object to remove- Returns:
- this
-
getComponentProperties
public ComponentProperties getComponentProperties()
Gets the component properties- Returns:
- component properties
-
getShapedPanelProperties
public ShapedPanelProperties getShapedPanelProperties()
Gets the shaped panel properties- Returns:
- shaped panel properties
-
getAutoCloseEnabled
public boolean getAutoCloseEnabled()
Returns true if the floating window should be automatically closed when it doesn't contain any child window.- Returns:
- true if auto close is enabled, otherwise false
-
setAutoCloseEnabled
public FloatingWindowProperties setAutoCloseEnabled(boolean enabled)
Enables/disables if the floating window should be automatically closed when it doesn't contain any child window.- Parameters:
enabled
- true for auto close, otherwise disabled- Returns:
- this
-
getUseFrame
public boolean getUseFrame()
Returns true if the floating window should be created as a JFrame, otherwise a JDialog is used.- Returns:
- true if a JFrame should be used
- Since:
- IDW 1.5.0
-
setUseFrame
public FloatingWindowProperties setUseFrame(boolean enabled)
Set to true if the floating window should be created as a JFrame, otherwise a JDialog is used. Note that the value of this property only takes effect when the FloatingWindow is created, it doesn't affect existing FloatingWindows (but this might change in future versions).- Parameters:
enabled
- true if a JFrame should be used- Returns:
- this
- Since:
- IDW 1.5.0
-
-