net.infonode.docking.properties
Class WindowBarProperties

java.lang.Object
  extended bynet.infonode.properties.propertymap.PropertyMapContainer
      extended bynet.infonode.docking.properties.WindowBarProperties

public class WindowBarProperties
extends PropertyMapContainer

Properties and property values for window bars.

Version:
$Revision: 1.33 $

Field Summary
static PropertyMapProperty COMPONENT_PROPERTIES
          The window bar component property values.
static IntegerProperty CONTENT_PANEL_EDGE_RESIZE_DISTANCE
          Inside this distance from the content panel edge the user can resize the content panel.
static BooleanProperty CONTINUOUS_LAYOUT_ENABLED
          When enabled causes the windows to change size continuously while dragging the split window divider.
static ColorProperty DRAG_INDICATOR_COLOR
          The drag indicator color.
static IntegerProperty MINIMUM_WIDTH
          The minimum width of the window bar.
static PropertyMapGroup PROPERTIES
          Property group containing all window bar properties.
static PropertyMapProperty TAB_WINDOW_PROPERTIES
          Properties for the tab window used by this window bar.
 
Constructor Summary
WindowBarProperties()
          Creates an empty property object.
WindowBarProperties(PropertyMap map)
          Creates a property object containing the map.
WindowBarProperties(WindowBarProperties inheritFrom)
          Creates a property object that inherit values from another property object.
 
Method Summary
 WindowBarProperties addSuperObject(WindowBarProperties properties)
          Adds a super object from which property values are inherited.
static WindowBarProperties createDefault(Direction location)
          Creates a property object which inherits the default property values.
 ComponentProperties getComponentProperties()
          Returns the property values for the window bar component.
 int getContentPanelEdgeResizeDistance()
          Returns the distance from the content panel edge which inside the user can resize the content panel.
 boolean getContinuousLayoutEnabled()
          Returns true if continuous layout is enabled.
 Color getDragIndicatorColor()
          Returns the resizer's drag indicator color.
 int getMinimumWidth()
          Returns the minimum width of the window bar.
 TabWindowProperties getTabWindowProperties()
          Returns the tab window property values.
 WindowBarProperties removeSuperObject()
          Deprecated. Use removeSuperObject(WindowBarProperties) instead.
 WindowBarProperties removeSuperObject(WindowBarProperties superObject)
          Removes a super object.
 WindowBarProperties setContentPanelEdgeResizeEdgeDistance(int width)
          Sets the distance from the content panel edge which inside the user can resize the content panel.
 WindowBarProperties setContinuousLayoutEnabled(boolean enabled)
          Enables/disables continuous layout.
 WindowBarProperties setDragIndicatorColor(Color color)
          Sets the resizer's drag indicator color.
 WindowBarProperties setMinimumWidth(int width)
          Sets the minimum width of the window bar.
 
Methods inherited from class net.infonode.properties.propertymap.PropertyMapContainer
getMap
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROPERTIES

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


COMPONENT_PROPERTIES

public static final PropertyMapProperty COMPONENT_PROPERTIES
The window bar component property values.


CONTENT_PANEL_EDGE_RESIZE_DISTANCE

public static final IntegerProperty CONTENT_PANEL_EDGE_RESIZE_DISTANCE
Inside this distance from the content panel edge the user can resize the content panel.


MINIMUM_WIDTH

public static final IntegerProperty MINIMUM_WIDTH
The minimum width of the window bar. If greater than 0, the window bar will always be visible and the user can drag windows to it.


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.4.0

DRAG_INDICATOR_COLOR

public static final ColorProperty DRAG_INDICATOR_COLOR
The drag indicator color.

Since:
IDW 1.4.0

TAB_WINDOW_PROPERTIES

public static final PropertyMapProperty TAB_WINDOW_PROPERTIES
Properties for the tab window used by this window bar.

Constructor Detail

WindowBarProperties

public WindowBarProperties()
Creates an empty property object.


WindowBarProperties

public WindowBarProperties(PropertyMap map)
Creates a property object containing the map.

Parameters:
map - the property map

WindowBarProperties

public WindowBarProperties(WindowBarProperties inheritFrom)
Creates a property object that inherit values from another property object.

Parameters:
inheritFrom - the object from which to inherit property values
Method Detail

createDefault

public static WindowBarProperties createDefault(Direction location)
Creates a property object which inherits the default property values.

Parameters:
location - the location of the window bar
Returns:
a property object which inherits the default property values

addSuperObject

public WindowBarProperties addSuperObject(WindowBarProperties 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 WindowBarProperties removeSuperObject()
Deprecated. Use removeSuperObject(WindowBarProperties) instead.

Removes the last added super object.

Returns:
this
Since:
IDW 1.1.0

removeSuperObject

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

Parameters:
superObject - the super object to remove
Returns:
this
Since:
IDW 1.3.0

getContentPanelEdgeResizeDistance

public int getContentPanelEdgeResizeDistance()
Returns the distance from the content panel edge which inside the user can resize the content panel.

Returns:
the distance from the content panel edge which inside the user can resize the content panel

setContentPanelEdgeResizeEdgeDistance

public WindowBarProperties setContentPanelEdgeResizeEdgeDistance(int width)
Sets the distance from the content panel edge which inside the user can resize the content panel.

Parameters:
width - the distance from the content panel edge which inside the user can resize the content panel
Returns:
this

getMinimumWidth

public int getMinimumWidth()
Returns the minimum width of the window bar.

Returns:
the minimum width of the window bar

setMinimumWidth

public WindowBarProperties setMinimumWidth(int width)
Sets the minimum width of the window bar.

Parameters:
width - the minimum width of the window bar
Returns:
this

getTabWindowProperties

public TabWindowProperties getTabWindowProperties()
Returns the tab window property values.

Returns:
the tab window property values

getComponentProperties

public ComponentProperties getComponentProperties()
Returns the property values for the window bar component.

Returns:
the property values for the window bar component

setDragIndicatorColor

public WindowBarProperties setDragIndicatorColor(Color color)
Sets the resizer's drag indicator color.

Parameters:
color - the color for the drag indicator
Returns:
this
Since:
IDW 1.4.0

getDragIndicatorColor

public Color getDragIndicatorColor()
Returns the resizer's drag indicator color.

Returns:
the drag indicator color
Since:
IDW 1.4.0

getContinuousLayoutEnabled

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

Returns:
true if continuous layout is enabled
Since:
IDW 1.4.0

setContinuousLayoutEnabled

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

Parameters:
enabled - if true continuous layout is enabled
Returns:
this
Since:
IDW 1.4.0


Copyright © 2007 NNL Technology AB. All Rights Reserved.