net.infonode.tabbedpanel

Class TabAreaProperties

public class TabAreaProperties extends PropertyMapContainer

TabAreaProperties holds all visual properties for a tabbed panel's tab area. TabbedPanelProperties contains TabAreaProperties.

Version: $Revision: 1.28 $

Author: $Author: jesper $

See Also: TabbedPanel TabbedPanelProperties

Field Summary
static PropertyMapPropertyCOMPONENT_PROPERTIES
Properties for the component
static HoverListenerPropertyHOVER_LISTENER
Hover listener property
static PropertyMapGroupPROPERTIES
A property group for all properties in TabAreaProperties
static PropertyMapPropertySHAPED_PANEL_PROPERTIES
Properties for the shaped panel
static TabAreaVisiblePolicyPropertyTAB_AREA_VISIBLE_POLICY
Tab area visible property
Constructor Summary
TabAreaProperties()
Constructs an empty TabAreaProperties object
TabAreaProperties(PropertyMap object)
Constructs a TabAreaProperties object with the given object as property storage
TabAreaProperties(TabAreaProperties inheritFrom)
Constructs a TabAreaProperties object that inherits its properties from the given TabAreaProperties object
Method Summary
TabAreaPropertiesaddSuperObject(TabAreaProperties superObject)
Adds a super object from which property values are inherited.
ComponentPropertiesgetComponentProperties()
Gets the component properties
HoverListenergetHoverListener()

Sets the hover listener that will be triggered when the tab area is hovered by the mouse.

The tabbed panel that the hovered tab area is part of will be the source of the hover event sent to the hover listener.

ShapedPanelPropertiesgetShapedPanelProperties()
Gets the shaped panel properties
TabAreaVisiblePolicygetTabAreaVisiblePolicy()
Gets the tab area visible policy for the tab area, i.e. when the tab area is to be visible
TabAreaPropertiesremoveSuperObject()
Removes the last added super object.
TabAreaPropertiesremoveSuperObject(TabAreaProperties superObject)
Removes the given super object.
TabAreaPropertiessetHoverListener(HoverListener listener)

Sets the hover listener that will be triggered when the tab area is hoverd by the mouse.

The tabbed panel that the hovered tab area is part of will be the source of the hover event sent to the hover listener.

TabAreaPropertiessetTabAreaVisiblePolicy(TabAreaVisiblePolicy policy)
Sets the tab area visible policy for the tab area, i.e. when the tab area is to be visible

Field Detail

COMPONENT_PROPERTIES

public static final PropertyMapProperty COMPONENT_PROPERTIES
Properties for the component

See Also: TabAreaProperties

HOVER_LISTENER

public static final HoverListenerProperty HOVER_LISTENER
Hover listener property

Since: ITP 1.3.0

See Also: TabAreaProperties TabAreaProperties

PROPERTIES

public static final PropertyMapGroup PROPERTIES
A property group for all properties in TabAreaProperties

SHAPED_PANEL_PROPERTIES

public static final PropertyMapProperty SHAPED_PANEL_PROPERTIES
Properties for the shaped panel

Since: ITP 1.2.0

See Also: TabAreaProperties

TAB_AREA_VISIBLE_POLICY

public static final TabAreaVisiblePolicyProperty TAB_AREA_VISIBLE_POLICY
Tab area visible property

Since: ITP 1.4.0

See Also: setTabAreaVisiblePolicy getTabAreaVisiblePolicy

Constructor Detail

TabAreaProperties

public TabAreaProperties()
Constructs an empty TabAreaProperties object

TabAreaProperties

public TabAreaProperties(PropertyMap object)
Constructs a TabAreaProperties object with the given object as property storage

Parameters: object object to store properties in

TabAreaProperties

public TabAreaProperties(TabAreaProperties inheritFrom)
Constructs a TabAreaProperties object that inherits its properties from the given TabAreaProperties object

Parameters: inheritFrom TabAreaProperties object to inherit properties from

Method Detail

addSuperObject

public TabAreaProperties addSuperObject(TabAreaProperties superObject)
Adds a super object from which property values are inherited.

Parameters: superObject the object from which to inherit property values

Returns: this

getComponentProperties

public ComponentProperties getComponentProperties()
Gets the component properties

Returns: component properties

getHoverListener

public HoverListener getHoverListener()

Sets the hover listener that will be triggered when the tab area is hovered by the mouse.

The tabbed panel that the hovered tab area is part of will be the source of the hover event sent to the hover listener.

Returns: the hover listener

Since: ITP 1.3.0

getShapedPanelProperties

public ShapedPanelProperties getShapedPanelProperties()
Gets the shaped panel properties

Returns: shaped panel properties

Since: ITP 1.2.0

getTabAreaVisiblePolicy

public TabAreaVisiblePolicy getTabAreaVisiblePolicy()
Gets the tab area visible policy for the tab area, i.e. when the tab area is to be visible

Returns: the tab area visible policy

Since: ITP 1.4.0

removeSuperObject

public TabAreaProperties removeSuperObject()
Removes the last added super object.

Returns: this

removeSuperObject

public TabAreaProperties removeSuperObject(TabAreaProperties superObject)
Removes the given super object.

Parameters: superObject super object to remove

Returns: this

Since: ITP 1.3.0

setHoverListener

public TabAreaProperties setHoverListener(HoverListener listener)

Sets the hover listener that will be triggered when the tab area is hoverd by the mouse.

The tabbed panel that the hovered tab area is part of will be the source of the hover event sent to the hover listener.

Parameters: listener the hover listener

Returns: this TabAreaProperties

Since: ITP 1.3.0

setTabAreaVisiblePolicy

public TabAreaProperties setTabAreaVisiblePolicy(TabAreaVisiblePolicy policy)
Sets the tab area visible policy for the tab area, i.e. when the tab area is to be visible

Parameters: policy the tab area visible policy

Returns: this TabAreaProperties

Since: ITP 1.4.0