net.infonode.tabbedpanel

Class TabAreaComponentsProperties

public class TabAreaComponentsProperties extends PropertyMapContainer

TabAreaComponentsProperties holds all visual properties for the area in a tabbed panel's tab area where the tab area components (scroll buttons, tab drop down list and components set by calling setTabAreaComponents in a tabbed panel) are shown. TabbedPanelProperties contains TabAreaComponentsProperties.

Since: ITP 1.1.0

Version: $Revision: 1.15 $

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 TabAreaComponentsProperties
static PropertyMapPropertySHAPED_PANEL_PROPERTIES
Properties for the shaped panel
static BooleanPropertySTRETCH_ENABLED
Stretch enabled property
Constructor Summary
TabAreaComponentsProperties()
Constructs an empty TabAreaComponentsProperties object
TabAreaComponentsProperties(PropertyMap object)
Constructs a TabAreaComponentsProperties object with the given object as property storage
TabAreaComponentsProperties(TabAreaComponentsProperties inheritFrom)
Constructs a TabAreaComponentsProperties object that inherits its properties from the given TabAreaComponentsProperties object
Method Summary
TabAreaComponentsPropertiesaddSuperObject(TabAreaComponentsProperties superObject)
Adds a super object from which property values are inherited.
ComponentPropertiesgetComponentProperties()
Gets the component properties
HoverListenergetHoverListener()

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

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

ShapedPanelPropertiesgetShapedPanelProperties()
Gets the shaped panel properties
booleangetStretchEnabled()
Gets if components should be stretched to same height as tabs if tabs are higher than components.
TabAreaComponentsPropertiesremoveSuperObject()
Removes the last added super object.
TabAreaComponentsPropertiesremoveSuperObject(TabAreaComponentsProperties superObject)
Removes the given super object.
TabAreaComponentsPropertiessetHoverListener(HoverListener listener)

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

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

TabAreaComponentsPropertiessetStretchEnabled(boolean enabled)
Sets if components should be stretched to same height as tabs if tabs are higher than components.

Field Detail

COMPONENT_PROPERTIES

public static final PropertyMapProperty COMPONENT_PROPERTIES
Properties for the component

See Also: TabAreaComponentsProperties

HOVER_LISTENER

public static final HoverListenerProperty HOVER_LISTENER
Hover listener property

Since: ITP 1.3.0

See Also: TabAreaComponentsProperties TabAreaComponentsProperties

PROPERTIES

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

SHAPED_PANEL_PROPERTIES

public static final PropertyMapProperty SHAPED_PANEL_PROPERTIES
Properties for the shaped panel

Since: ITP 1.2.0

See Also: TabAreaComponentsProperties

STRETCH_ENABLED

public static final BooleanProperty STRETCH_ENABLED
Stretch enabled property

See Also: TabAreaComponentsProperties TabAreaComponentsProperties

Constructor Detail

TabAreaComponentsProperties

public TabAreaComponentsProperties()
Constructs an empty TabAreaComponentsProperties object

TabAreaComponentsProperties

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

Parameters: object object to store properties in

TabAreaComponentsProperties

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

Parameters: inheritFrom TabAreaComponentsProperties object to inherit properties from

Method Detail

addSuperObject

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

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

The tabbed panel that the hovered tab area components 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

getStretchEnabled

public boolean getStretchEnabled()
Gets if components should be stretched to same height as tabs if tabs are higher than components.

Returns: true if stretch is enabled, otherwise false

removeSuperObject

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

Returns: this

removeSuperObject

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

Parameters: superObject super object to remove

Returns: this

Since: ITP 1.3.0

setHoverListener

public TabAreaComponentsProperties setHoverListener(HoverListener listener)

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

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

Parameters: listener the hover listener

Returns: this TabAreaComponentsProperties

Since: ITP 1.3.0

setStretchEnabled

public TabAreaComponentsProperties setStretchEnabled(boolean enabled)
Sets if components should be stretched to same height as tabs if tabs are higher than components.

Parameters: enabled true for stretch, otherwise false

Returns: this TabAreaComponentsProperties