net.infonode.docking.properties

Class ViewProperties

public class ViewProperties extends PropertyMapContainer

Properties and property values for views.

Version: $Revision: 1.21 $

Author: $Author: jesper $

Field Summary
static BooleanProperty	ALWAYS_SHOW_TITLE If true the view will always be placed in a TabWindow so that it's title is shown.
static IconProperty	ICON The view icon.
static PropertyMapGroup	PROPERTIES Property group containing all view properties.
static StringProperty	TITLE The view title.
static PropertyMapProperty	VIEW_TITLE_BAR_PROPERTIES Properties for the view title bar

Constructor Summary
	ViewProperties() Creates an empty property object.
	ViewProperties(PropertyMap map) Creates a property object containing the map.
	ViewProperties(ViewProperties inheritFrom) Creates a property object that inherit values from another property object.

Method Summary
ViewProperties	addSuperObject(ViewProperties properties) Adds a super object from which property values are inherited.
boolean	getAlwaysShowTitle() Returns true if the view shows it's title even though it's not in a tabbed panel with other windows.
Icon	getIcon() Returns the view icon.
String	getTitle() Returns the view title.
ViewTitleBarProperties	getViewTitleBarProperties() Returns the property values for the title bar in the view
ViewProperties	removeSuperObject() Removes the last added super object.
ViewProperties	removeSuperObject(ViewProperties superObject) Removes a super object.
ViewProperties	setAlwaysShowTitle(boolean showTitle) Set to true the view should always be placed in a TabWindow so that it's title is shown.
ViewProperties	setIcon(Icon icon) Sets the view icon.
ViewProperties	setTitle(String title) Sets the view title.

Field Detail

ALWAYS_SHOW_TITLE

public static final BooleanProperty ALWAYS_SHOW_TITLE

If true the view will always be placed in a TabWindow so that it's title is shown.

ICON

public static final IconProperty ICON

The view icon.

PROPERTIES

public static final PropertyMapGroup PROPERTIES

Property group containing all view properties.

TITLE

public static final StringProperty TITLE

The view title.

VIEW_TITLE_BAR_PROPERTIES

public static final PropertyMapProperty VIEW_TITLE_BAR_PROPERTIES

Properties for the view title bar

Since: IDW 1.4.0

See Also: ViewProperties

Constructor Detail

ViewProperties

public ViewProperties()

Creates an empty property object.

ViewProperties

public ViewProperties(PropertyMap map)

Creates a property object containing the map.

Parameters: map the property map

ViewProperties

public ViewProperties(ViewProperties 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 ViewProperties addSuperObject(ViewProperties properties)

Adds a super object from which property values are inherited.

Parameters: properties the object from which to inherit property values

Returns: this

getAlwaysShowTitle

public boolean getAlwaysShowTitle()

Returns true if the view shows it's title even though it's not in a tabbed panel with other windows.

Returns: true if the view shows it's title even though it's not in a tabbed panel with other windows

getIcon

public Icon getIcon()

Returns the view icon.

Returns: the view icon

getTitle

public String getTitle()

Returns the view title.

Returns: the view title

getViewTitleBarProperties

public ViewTitleBarProperties getViewTitleBarProperties()

Returns the property values for the title bar in the view

Returns: the property values for the title bar in the view

Since: IDW 1.4.0

removeSuperObject

public ViewProperties removeSuperObject()

Deprecated: Use removeSuperObject instead.

Removes the last added super object.

Returns: this

Since: IDW 1.1.0

removeSuperObject

public ViewProperties removeSuperObject(ViewProperties superObject)

Removes a super object.

Parameters: superObject the super object to remove

Returns: this

Since: IDW 1.3.0

setAlwaysShowTitle

public ViewProperties setAlwaysShowTitle(boolean showTitle)

Set to true the view should always be placed in a TabWindow so that it's title is shown.

Parameters: showTitle true the view should always be placed in a TabWindow so that it's title is shown

Returns: this

setIcon

public ViewProperties setIcon(Icon icon)

Sets the view icon.

Parameters: icon the view icon

Returns: this

setTitle

public ViewProperties setTitle(String title)

Sets the view title.

Parameters: title the view title

Returns: this