net.infonode.docking.properties

Class SplitWindowProperties

public class SplitWindowProperties extends PropertyMapContainer

Properties and property values for split windows.

Version: $Revision: 1.20 $

Author: $Author: jesper $

Field Summary
static BooleanPropertyCONTINUOUS_LAYOUT_ENABLED
When enabled causes the windows to change size continuously while dragging the split window divider.
static BooleanPropertyDIVIDER_LOCATION_DRAG_ENABLED
When enabled the user can drag the SplitWindow divider to a new location.
static IntegerPropertyDIVIDER_SIZE
The split pane divider size.
static ColorPropertyDRAG_INDICATOR_COLOR
The split pane drag indicator color.
static PropertyMapGroupPROPERTIES
Property group containing all split window properties.
Constructor Summary
SplitWindowProperties()
Creates an empty property object.
SplitWindowProperties(PropertyMap map)
Creates a property map containing the map.
SplitWindowProperties(SplitWindowProperties inheritFrom)
Creates a property object that inherit values from another property object.
Method Summary
SplitWindowPropertiesaddSuperObject(SplitWindowProperties properties)
Adds a super object from which property values are inherited.
booleangetContinuousLayoutEnabled()
Returns true if continuous layout is enabled.
booleangetDividerLocationDragEnabled()
Returns true if the user can drag the SplitWindow divider to a new location.
intgetDividerSize()
Returns the split pane divider size.
ColorgetDragIndicatorColor()
Returns the split pane drag indicator color.
SplitWindowPropertiesremoveSuperObject()
Removes the last added super object.
SplitWindowPropertiesremoveSuperObject(SplitWindowProperties superObject)
Removes a super object.
SplitWindowPropertiessetContinuousLayoutEnabled(boolean enabled)
Enables/disables continuous layout.
SplitWindowPropertiessetDividerLocationDragEnabled(boolean enabled)
When enabled the user can drag the SplitWindow divider to a new location.
SplitWindowPropertiessetDividerSize(int size)
Sets the split pane divider size.
SplitWindowPropertiessetDragIndicatorColor(Color color)
Sets the split pane drag indicator color.

Field Detail

CONTINUOUS_LAYOUT_ENABLED

public static final BooleanProperty CONTINUOUS_LAYOUT_ENABLED
When enabled causes the windows to change size continuously while dragging the split window divider.

Since: IDW 1.1.0

DIVIDER_LOCATION_DRAG_ENABLED

public static final BooleanProperty DIVIDER_LOCATION_DRAG_ENABLED
When enabled the user can drag the SplitWindow divider to a new location.

Since: IDW 1.2.0

DIVIDER_SIZE

public static final IntegerProperty DIVIDER_SIZE
The split pane divider size.

DRAG_INDICATOR_COLOR

public static final ColorProperty DRAG_INDICATOR_COLOR
The split pane drag indicator color.

Since: IDW 1.4.0

PROPERTIES

public static final PropertyMapGroup PROPERTIES
Property group containing all split window properties.

Constructor Detail

SplitWindowProperties

public SplitWindowProperties()
Creates an empty property object.

SplitWindowProperties

public SplitWindowProperties(PropertyMap map)
Creates a property map containing the map.

Parameters: map the property map

SplitWindowProperties

public SplitWindowProperties(SplitWindowProperties 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 SplitWindowProperties addSuperObject(SplitWindowProperties properties)
Adds a super object from which property values are inherited.

Parameters: properties the object from which to inherit property values

Returns: this

getContinuousLayoutEnabled

public boolean getContinuousLayoutEnabled()
Returns true if continuous layout is enabled.

Returns: true if continuous layout is enabled

Since: IDW 1.1.0

getDividerLocationDragEnabled

public boolean getDividerLocationDragEnabled()
Returns true if the user can drag the SplitWindow divider to a new location.

Returns: true if the user can drag the SplitWindow divider to a new location

Since: IDW 1.2.0

getDividerSize

public int getDividerSize()
Returns the split pane divider size.

Returns: the split pane divider size

getDragIndicatorColor

public Color getDragIndicatorColor()
Returns the split pane drag indicator color.

Returns: the split pane drag indicator color

Since: IDW 1.4.0

removeSuperObject

public SplitWindowProperties removeSuperObject()

Deprecated: Use {@link #removeSuperObject(SplitWindowProperties)} instead.

Removes the last added super object.

Returns: this

Since: IDW 1.1.0

removeSuperObject

public SplitWindowProperties removeSuperObject(SplitWindowProperties superObject)
Removes a super object.

Parameters: superObject the super object to remove

Returns: this

Since: IDW 1.3.0

setContinuousLayoutEnabled

public SplitWindowProperties setContinuousLayoutEnabled(boolean enabled)
Enables/disables continuous layout.

Parameters: enabled if true continuous layout is enabled

Returns: this

Since: IDW 1.1.0

setDividerLocationDragEnabled

public SplitWindowProperties setDividerLocationDragEnabled(boolean enabled)
When enabled the user can drag the SplitWindow divider to a new location.

Parameters: enabled if true the user can drag the SplitWindow divider to a new location

Returns: this

Since: IDW 1.2.0

setDividerSize

public SplitWindowProperties setDividerSize(int size)
Sets the split pane divider size.

Parameters: size the split pane divider size

Returns: this

setDragIndicatorColor

public SplitWindowProperties setDragIndicatorColor(Color color)
Sets the split pane drag indicator color.

Parameters: color the color for the drag indicator

Returns: this

Since: IDW 1.4.0