net.infonode.docking.properties
Class ViewTitleBarStateProperties

java.lang.Object
  net.infonode.properties.propertymap.PropertyMapContainer
      net.infonode.docking.properties.ViewTitleBarStateProperties

public class ViewTitleBarStateProperties
extends PropertyMapContainer

Properties and property values for a view title bar state.

Since:

IDW 1.4.0

Version:

$Revision: 1.6 $

Author:

johan

Field Summary

static IntegerProperty	BUTTON_SPACING Button spacing
static PropertyMapProperty	CLOSE_BUTTON_PROPERTIES The close button property values.
static PropertyMapProperty	COMPONENT_PROPERTIES Properties for the component
static PropertyMapProperty	DOCK_BUTTON_PROPERTIES The dock button property values.
static IconProperty	ICON The title bar icon.
static IntegerProperty	ICON_TEXT_GAP Icon text gap property
static AlignmentProperty	ICON_TEXT_HORIZONTAL_ALIGNMENT Icon Text Horizontal alignment property
static BooleanProperty	ICON_VISIBLE Icon visible property
static PropertyMapProperty	MAXIMIZE_BUTTON_PROPERTIES The minimize button property values.
static PropertyMapProperty	MINIMIZE_BUTTON_PROPERTIES The minimize button property values.
static PropertyMapGroup	PROPERTIES Property group containing all view title bar state properties.
static PropertyMapProperty	RESTORE_BUTTON_PROPERTIES The restore button property values.
static PropertyMapProperty	SHAPED_PANEL_PROPERTIES Properties for the shaped panel
static StringProperty	TITLE The title bar title.
static BooleanProperty	TITLE_VISIBLE Title visible property
static PropertyMapProperty	UNDOCK_BUTTON_PROPERTIES The undock button property values.

Constructor Summary

ViewTitleBarStateProperties()
Creates an empty property object.

ViewTitleBarStateProperties(PropertyMap map)
Creates a property object containing the map.

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

Method Summary

ViewTitleBarStateProperties	addSuperObject(ViewTitleBarStateProperties properties) Adds a super object from which property values are inherited.
int	getButtonSpacing() Returns the spacing between the buttons on the title bar
WindowTabButtonProperties	getCloseButtonProperties() Returns the close button property values.
ComponentProperties	getComponentProperties() Gets the component properties
WindowTabButtonProperties	getDockButtonProperties() Returns the dock button property values.
javax.swing.Icon	getIcon() Returns the view icon.
int	getIconTextGap() Returns the gap between the icon and the title in the title bar
Alignment	getIconTextHorizontalAlignment() Gets the text's and icon's horizontal alignment
boolean	getIconVisible() Returns if the icon should be visible or not
WindowTabButtonProperties	getMaximizeButtonProperties() Returns the maximize button property values.
WindowTabButtonProperties	getMinimizeButtonProperties() Returns the minimize button property values.
WindowTabButtonProperties	getRestoreButtonProperties() Returns the restore button property values.
ShapedPanelProperties	getShapedPanelProperties() Gets the shaped panel properties
java.lang.String	getTitle() Returns the view title.
boolean	getTitleVisible() Returns if the title should be visible or not
WindowTabButtonProperties	getUndockButtonProperties() Returns the undock button property values.
ViewTitleBarStateProperties	removeSuperObject(ViewTitleBarStateProperties superObject) Removes a super object.
ViewTitleBarStateProperties	setButtonSpacing(int spacing) Sets the spacing between the buttons on the title bar
ViewTitleBarStateProperties	setIcon(javax.swing.Icon icon) Sets the icon.
ViewTitleBarStateProperties	setIconTextGap(int gap) Sets the gap between the icon and the title in the title bar
ViewTitleBarStateProperties	setIconTextHorizontalAlignment(Alignment alignment) Sets the text's and icon's horizontal alignment
ViewTitleBarStateProperties	setIconVisible(boolean visible) Sets if the icon should be visible or not
ViewTitleBarStateProperties	setTitle(java.lang.String title) Sets the title.
ViewTitleBarStateProperties	setTitleVisible(boolean visible) Sets if the title should be visible or not

Methods inherited from class net.infonode.properties.propertymap.PropertyMapContainer

getMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROPERTIES

public static final PropertyMapGroup PROPERTIES

Property group containing all view title bar state 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()

MINIMIZE_BUTTON_PROPERTIES

public static final PropertyMapProperty MINIMIZE_BUTTON_PROPERTIES

The minimize button property values.

See Also:

getMinimizeButtonProperties()

MAXIMIZE_BUTTON_PROPERTIES

public static final PropertyMapProperty MAXIMIZE_BUTTON_PROPERTIES

The minimize button property values.

See Also:

getMinimizeButtonProperties()

RESTORE_BUTTON_PROPERTIES

public static final PropertyMapProperty RESTORE_BUTTON_PROPERTIES

The restore button property values.

See Also:

getRestoreButtonProperties()

CLOSE_BUTTON_PROPERTIES

public static final PropertyMapProperty CLOSE_BUTTON_PROPERTIES

The close button property values.

See Also:

getCloseButtonProperties()

UNDOCK_BUTTON_PROPERTIES

public static final PropertyMapProperty UNDOCK_BUTTON_PROPERTIES

The undock button property values.

See Also:

getUndockButtonProperties()

DOCK_BUTTON_PROPERTIES

public static final PropertyMapProperty DOCK_BUTTON_PROPERTIES

The dock button property values.

See Also:

getDockButtonProperties()

TITLE

public static final StringProperty TITLE

The title bar title.

TITLE_VISIBLE

public static final BooleanProperty TITLE_VISIBLE

Title visible property

See Also:

setTitleVisible(boolean), getTitleVisible()

ICON

public static final IconProperty ICON

The title bar icon.

ICON_VISIBLE

public static final BooleanProperty ICON_VISIBLE

Icon visible property

See Also:

setIconVisible(boolean), getIconVisible()

ICON_TEXT_GAP

public static final IntegerProperty ICON_TEXT_GAP

Icon text gap property

See Also:

setIconTextGap(int), getIconTextGap()

ICON_TEXT_HORIZONTAL_ALIGNMENT

public static final AlignmentProperty ICON_TEXT_HORIZONTAL_ALIGNMENT

Icon Text Horizontal alignment property

See Also:

setIconTextHorizontalAlignment(net.infonode.util.Alignment), getIconTextHorizontalAlignment()

BUTTON_SPACING

public static final IntegerProperty BUTTON_SPACING

Button spacing

See Also:

setButtonSpacing(int), getButtonSpacing()

Constructor Detail

ViewTitleBarStateProperties

public ViewTitleBarStateProperties()

Creates an empty property object.

ViewTitleBarStateProperties

public ViewTitleBarStateProperties(PropertyMap map)

Creates a property object containing the map.

Parameters:

map - the property map

ViewTitleBarStateProperties

public ViewTitleBarStateProperties(ViewTitleBarStateProperties 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 ViewTitleBarStateProperties addSuperObject(ViewTitleBarStateProperties 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 ViewTitleBarStateProperties removeSuperObject(ViewTitleBarStateProperties 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

getMinimizeButtonProperties

public WindowTabButtonProperties getMinimizeButtonProperties()

Returns the minimize button property values.

Returns:

the minimize button property values

getMaximizeButtonProperties

public WindowTabButtonProperties getMaximizeButtonProperties()

Returns the maximize button property values.

Returns:

the maximize button property values

getRestoreButtonProperties

public WindowTabButtonProperties getRestoreButtonProperties()

Returns the restore button property values.

Returns:

the restore button property values

getCloseButtonProperties

public WindowTabButtonProperties getCloseButtonProperties()

Returns the close button property values.

Returns:

the close button property values

getUndockButtonProperties

public WindowTabButtonProperties getUndockButtonProperties()

Returns the undock button property values.

Returns:

the undock button property values

getDockButtonProperties

public WindowTabButtonProperties getDockButtonProperties()

Returns the dock button property values.

Returns:

the dock button property values

setButtonSpacing

public ViewTitleBarStateProperties setButtonSpacing(int spacing)

Sets the spacing between the buttons on the title bar

Parameters:

spacing - spacing in pixels

Returns:

this

getButtonSpacing

public int getButtonSpacing()

Returns the spacing between the buttons on the title bar

Returns:

spacing in pixels

setTitle

public ViewTitleBarStateProperties setTitle(java.lang.String title)

Sets the title.

Parameters:

title - the title

Returns:

this

getTitle

public java.lang.String getTitle()

Returns the view title.

Returns:

the view title

setTitleVisible

public ViewTitleBarStateProperties setTitleVisible(boolean visible)

Sets if the title should be visible or not

Parameters:

visible - True for visible, otherwise false

Returns:

this

getTitleVisible

public boolean getTitleVisible()

Returns if the title should be visible or not

Returns:

True if visible, otherwise false

setIcon

public ViewTitleBarStateProperties setIcon(javax.swing.Icon icon)

Sets the icon.

Parameters:

icon - the icon

Returns:

this

getIcon

public javax.swing.Icon getIcon()

Returns the view icon.

Returns:

the view icon

setIconVisible

public ViewTitleBarStateProperties setIconVisible(boolean visible)

Sets if the icon should be visible or not

Parameters:

visible - True for visible, otherwise false

Returns:

this

getIconVisible

public boolean getIconVisible()

Returns if the icon should be visible or not

Returns:

True if visible, otherwise false

setIconTextGap

public ViewTitleBarStateProperties setIconTextGap(int gap)

Sets the gap between the icon and the title in the title bar

Parameters:

gap - gap in pixels

Returns:

this

getIconTextGap

public int getIconTextGap()

Returns the gap between the icon and the title in the title bar

Returns:

gap in pixels

setIconTextHorizontalAlignment

public ViewTitleBarStateProperties setIconTextHorizontalAlignment(Alignment alignment)

Sets the text's and icon's horizontal alignment

Parameters:

alignment - text and icon alignment

Returns:

this

getIconTextHorizontalAlignment

public Alignment getIconTextHorizontalAlignment()

Gets the text's and icon's horizontal alignment

Returns:

text and icon alignment