net.infonode.docking.properties

Class ViewTitleBarProperties

public class ViewTitleBarProperties extends PropertyMapContainer

Properties and property values for a view title bar.

Since: IDW 1.4.0

Version: $Revision: 1.14 $

Author: johan

Field Summary
static IntegerPropertyCONTENT_TITLE_BAR_GAP
Content title bar gap property
static DirectionPropertyDIRECTION
Direction property
static PropertyMapPropertyFOCUSED_PROPERTIES
Focused properties.
static HoverListenerPropertyHOVER_LISTENER
Hover listener property
static DimensionProviderPropertyMINIMUM_SIZE_PROVIDER
Title bar minimum size property
static PropertyMapPropertyNORMAL_PROPERTIES
Normal properties
static DirectionPropertyORIENTATION
Orientation property
static PropertyMapGroupPROPERTIES
Property group containing all view title bar properties.
static BooleanPropertyVISIBLE
Visible property
Constructor Summary
ViewTitleBarProperties()
Creates an empty property object.
ViewTitleBarProperties(PropertyMap map)
Creates a property object containing the map.
ViewTitleBarProperties(ViewTitleBarProperties inheritFrom)
Creates a property object that inherit values from another property object.
Method Summary
ViewTitleBarPropertiesaddSuperObject(ViewTitleBarProperties properties)
Adds a super object from which property values are inherited.
intgetContentTitleBarGap()
Returns the gap between the view's content and the title bar
DirectiongetDirection()

Returns the layout direction

The icon, text and components are laid out in a line that will be rotated in the given direction.

ViewTitleBarStatePropertiesgetFocusedProperties()

Returns the property values for the title bar's focused state

Note:These properties are added as super object to the normal properties when the view has focus.

HoverListenergetHoverListener()

Gets the hover listener that will be triggered when the title bar is hovered by the mouse.

The view that contains the title bar will be the source of the hover event sent to the hover listener.

DimensionProvidergetMinimumSizeProvider()
Gets the dimension provider for the title bar's minimum size
ViewTitleBarStatePropertiesgetNormalProperties()
Returns the property values for the title bar's normal state
DirectiongetOrientation()
Returns the orientation i.e. on what side of the view's content the title bar will be placed
booleangetVisible()
Returns if the title bar should be visible or not
ViewTitleBarPropertiesremoveSuperObject(ViewTitleBarProperties superObject)
Removes a super object.
ViewTitleBarPropertiessetContentTitleBarGap(int gap)
Sets the gap between the view's content and the title bar
ViewTitleBarPropertiessetDirection(Direction direction)

Sets the layout direction

The icon, text and components are laid out in a line that will be rotated in the given direction.

ViewTitleBarPropertiessetHoverListener(HoverListener listener)

Sets the hover listener that will be triggered when the title bar is hoverd by the mouse.

The view that contains the title bar will be the source of the hover event sent to the hover listener.

ViewTitleBarPropertiessetMinimumSizeProvider(DimensionProvider size)
Sets the title bar's minimum size dimension provider
ViewTitleBarPropertiessetOrientation(Direction orientation)
Sets the orientation i.e. on what side of the view's content the title bar will be placed
ViewTitleBarPropertiessetVisible(boolean visible)
Sets if the title bar should be visible or not

Field Detail

CONTENT_TITLE_BAR_GAP

public static final IntegerProperty CONTENT_TITLE_BAR_GAP
Content title bar gap property

See Also: ViewTitleBarProperties ViewTitleBarProperties

DIRECTION

public static final DirectionProperty DIRECTION
Direction property

See Also: ViewTitleBarProperties ViewTitleBarProperties

FOCUSED_PROPERTIES

public static final PropertyMapProperty FOCUSED_PROPERTIES
Focused properties. Added as super object to normal properties when view has focus

See Also: ViewTitleBarProperties

HOVER_LISTENER

public static final HoverListenerProperty HOVER_LISTENER
Hover listener property

See Also: ViewTitleBarProperties ViewTitleBarProperties

MINIMUM_SIZE_PROVIDER

public static final DimensionProviderProperty MINIMUM_SIZE_PROVIDER
Title bar minimum size property

See Also: setMinimumSizeProvider getMinimumSizeProvider

NORMAL_PROPERTIES

public static final PropertyMapProperty NORMAL_PROPERTIES
Normal properties

See Also: ViewTitleBarProperties

ORIENTATION

public static final DirectionProperty ORIENTATION
Orientation property

See Also: ViewTitleBarProperties ViewTitleBarProperties

PROPERTIES

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

VISIBLE

public static final BooleanProperty VISIBLE
Visible property

See Also: ViewTitleBarProperties ViewTitleBarProperties

Constructor Detail

ViewTitleBarProperties

public ViewTitleBarProperties()
Creates an empty property object.

ViewTitleBarProperties

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

Parameters: map the property map

ViewTitleBarProperties

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

Parameters: properties the object from which to inherit property values

Returns: this

getContentTitleBarGap

public int getContentTitleBarGap()
Returns the gap between the view's content and the title bar

Returns: gap in pixels

getDirection

public Direction getDirection()

Returns the layout direction

The icon, text and components are laid out in a line that will be rotated in the given direction. The text and icon is rotated and the components are only moved.

Returns: the layout direction

getFocusedProperties

public ViewTitleBarStateProperties getFocusedProperties()

Returns the property values for the title bar's focused state

Note:These properties are added as super object to the normal properties when the view has focus.

Returns: the property values for the title bar's focused state

getHoverListener

public HoverListener getHoverListener()

Gets the hover listener that will be triggered when the title bar is hovered by the mouse.

The view that contains the title bar will be the source of the hover event sent to the hover listener.

Returns: the hover listener

See Also: HoverEvent

getMinimumSizeProvider

public DimensionProvider getMinimumSizeProvider()
Gets the dimension provider for the title bar's minimum size

Returns: the minimum size provider or null if default title bar minimum size is to be used instead

getNormalProperties

public ViewTitleBarStateProperties getNormalProperties()
Returns the property values for the title bar's normal state

Returns: the property values for the title bar's normal state

getOrientation

public Direction getOrientation()
Returns the orientation i.e. on what side of the view's content the title bar will be placed

Returns: the orientation

getVisible

public boolean getVisible()
Returns if the title bar should be visible or not

Returns: True if visible, otherwise false

removeSuperObject

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

Parameters: superObject the super object to remove

Returns: this

setContentTitleBarGap

public ViewTitleBarProperties setContentTitleBarGap(int gap)
Sets the gap between the view's content and the title bar

Parameters: gap gap in pixels

Returns: this

setDirection

public ViewTitleBarProperties setDirection(Direction direction)

Sets the layout direction

The icon, text and components are laid out in a line that will be rotated in the given direction. The text and icon is rotated and the components are only moved.

Parameters: direction the layout direction

Returns: this

setHoverListener

public ViewTitleBarProperties setHoverListener(HoverListener listener)

Sets the hover listener that will be triggered when the title bar is hoverd by the mouse.

The view that contains the title bar will be the source of the hover event sent to the hover listener.

Parameters: listener the hover listener

Returns: this

See Also: HoverEvent

setMinimumSizeProvider

public ViewTitleBarProperties setMinimumSizeProvider(DimensionProvider size)
Sets the title bar's minimum size dimension provider

Parameters: size the minimum size dimension provider or null if title bar's default minimum size should be used instead

Returns: this ViewTitleBarProperties

setOrientation

public ViewTitleBarProperties setOrientation(Direction orientation)
Sets the orientation i.e. on what side of the view's content the title bar will be placed

Parameters: orientation the orientation

Returns: this

setVisible

public ViewTitleBarProperties setVisible(boolean visible)
Sets if the title bar should be visible or not

Parameters: visible True for visible, otherwise false

Returns: this