net.infonode.docking.properties

Class TabWindowProperties

public class TabWindowProperties extends PropertyMapContainer

Properties and property values for tab windows.

Version: $Revision: 1.22 $

Author: $Author: jesper $

Field Summary
static PropertyMapPropertyCLOSE_BUTTON_PROPERTIES
The close button property values.
static PropertyMapPropertyDOCK_BUTTON_PROPERTIES
The dock button property values.
static PropertyMapPropertyMAXIMIZE_BUTTON_PROPERTIES
The maximize button property values.
static PropertyMapPropertyMINIMIZE_BUTTON_PROPERTIES
The minimize button property values.
static PropertyMapGroupPROPERTIES
Property group containing all tab window properties.
static BooleanPropertyRESPECT_CHILD_WINDOW_MINIMUM_SIZE
The respect child windows minimum sizes property.
static PropertyMapPropertyRESTORE_BUTTON_PROPERTIES
The restore button property values.
static PropertyMapPropertyTABBED_PANEL_PROPERTIES
Property values for the tabbed panel in the tab window.
static PropertyMapPropertyTAB_PROPERTIES
Default property values for the window tabs in the tab window.
static PropertyMapPropertyUNDOCK_BUTTON_PROPERTIES
The undock button property values.
Constructor Summary
TabWindowProperties()
Creates an empty property object.
TabWindowProperties(PropertyMap map)
Creates a property object containing the map.
TabWindowProperties(TabWindowProperties inheritFrom)
Creates a property object that inherit values from another property object.
Method Summary
TabWindowPropertiesaddSuperObject(TabWindowProperties properties)
Adds a super object from which property values are inherited.
WindowTabButtonPropertiesgetCloseButtonProperties()
Returns the close button property values.
WindowTabButtonPropertiesgetDockButtonProperties()
Returns the dock button property values.
WindowTabButtonPropertiesgetMaximizeButtonProperties()
Returns the maximize button property values.
WindowTabButtonPropertiesgetMinimizeButtonProperties()
Returns the minimize button property values.
booleangetRespectChildWindowMinimumSize()

Returns true if the TabWindow will respect its child windows minimum sizes.

WindowTabButtonPropertiesgetRestoreButtonProperties()
Returns the restore button property values.
TabbedPanelPropertiesgetTabbedPanelProperties()
Returns the property values for the tabbed panel in the tab window.
WindowTabPropertiesgetTabProperties()
Returns the default property values for the window tabs in the tab window.
WindowTabButtonPropertiesgetUndockButtonProperties()
Returns the undock button property values.
TabWindowPropertiesremoveSuperObject()
Removes the last added super object.
TabWindowPropertiesremoveSuperObject(TabWindowProperties superObject)
Removes a super object.
TabWindowPropertiessetRespectChildWindowMinimumSize(boolean repsectMinimuSize)

Enables/disables the TabWindow will respect its child windows minimum sizes.

Field Detail

CLOSE_BUTTON_PROPERTIES

public static final PropertyMapProperty CLOSE_BUTTON_PROPERTIES
The close button property values.

Since: IDW 1.1.0

DOCK_BUTTON_PROPERTIES

public static final PropertyMapProperty DOCK_BUTTON_PROPERTIES
The dock button property values.

Since: IDW 1.4.0

MAXIMIZE_BUTTON_PROPERTIES

public static final PropertyMapProperty MAXIMIZE_BUTTON_PROPERTIES
The maximize button property values.

Since: IDW 1.1.0

MINIMIZE_BUTTON_PROPERTIES

public static final PropertyMapProperty MINIMIZE_BUTTON_PROPERTIES
The minimize button property values.

Since: IDW 1.1.0

PROPERTIES

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

RESPECT_CHILD_WINDOW_MINIMUM_SIZE

public static final BooleanProperty RESPECT_CHILD_WINDOW_MINIMUM_SIZE
The respect child windows minimum sizes property.

Since: IDW 1.5.0

RESTORE_BUTTON_PROPERTIES

public static final PropertyMapProperty RESTORE_BUTTON_PROPERTIES
The restore button property values.

Since: IDW 1.1.0

TABBED_PANEL_PROPERTIES

public static final PropertyMapProperty TABBED_PANEL_PROPERTIES
Property values for the tabbed panel in the tab window.

TAB_PROPERTIES

public static final PropertyMapProperty TAB_PROPERTIES
Default property values for the window tabs in the tab window.

UNDOCK_BUTTON_PROPERTIES

public static final PropertyMapProperty UNDOCK_BUTTON_PROPERTIES
The undock button property values.

Since: IDW 1.4.0

Constructor Detail

TabWindowProperties

public TabWindowProperties()
Creates an empty property object.

TabWindowProperties

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

Parameters: map the property map

TabWindowProperties

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

Parameters: properties the object from which to inherit property values

Returns: this

getCloseButtonProperties

public WindowTabButtonProperties getCloseButtonProperties()
Returns the close button property values.

Returns: the close button property values

Since: IDW 1.1.0

getDockButtonProperties

public WindowTabButtonProperties getDockButtonProperties()
Returns the dock button property values.

Returns: the dock button property values

Since: IDW 1.4.0

getMaximizeButtonProperties

public WindowTabButtonProperties getMaximizeButtonProperties()
Returns the maximize button property values.

Returns: the maximize button property values

Since: IDW 1.1.0

getMinimizeButtonProperties

public WindowTabButtonProperties getMinimizeButtonProperties()
Returns the minimize button property values.

Returns: the minimize button property values

Since: IDW 1.1.0

getRespectChildWindowMinimumSize

public boolean getRespectChildWindowMinimumSize()

Returns true if the TabWindow will respect its child windows minimum sizes.

When true the content area of the TabWindow cannot be resized smaller than the maximum of all its child windows minimum sizes.

Returns: true if the TabWindow respects its child windows minimum sizes

Since: IDW 1.5.0

getRestoreButtonProperties

public WindowTabButtonProperties getRestoreButtonProperties()
Returns the restore button property values.

Returns: the restore button property values

Since: IDW 1.1.0

getTabbedPanelProperties

public TabbedPanelProperties getTabbedPanelProperties()
Returns the property values for the tabbed panel in the tab window.

Returns: the property values for the tabbed panel in the tab window

getTabProperties

public WindowTabProperties getTabProperties()
Returns the default property values for the window tabs in the tab window.

Returns: the default property values for the window tabs in the tab window

getUndockButtonProperties

public WindowTabButtonProperties getUndockButtonProperties()
Returns the undock button property values.

Returns: the undock button property values

Since: IDW 1.4.0

removeSuperObject

public TabWindowProperties removeSuperObject()

Deprecated: Use removeSuperObject instead.

Removes the last added super object.

Returns: this

Since: IDW 1.1.0

removeSuperObject

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

Parameters: superObject the super object to remove

Returns: this

Since: IDW 1.3.0

setRespectChildWindowMinimumSize

public TabWindowProperties setRespectChildWindowMinimumSize(boolean repsectMinimuSize)

Enables/disables the TabWindow will respect its child windows minimum sizes.

When true the content area of the TabWindow cannot be resized smaller than the maximum of all its child windows minimum sizes.

Parameters: repsectMinimuSize if true the TabWindow will respect its child windows minimum sizes

Returns: this

Since: IDW 1.5.0