net.infonode.tabbedpanel
Class TabAreaComponentsProperties

java.lang.Object
  net.infonode.properties.propertymap.PropertyMapContainer
      net.infonode.tabbedpanel.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 PropertyMapProperty	COMPONENT_PROPERTIES Properties for the component
static HoverListenerProperty	HOVER_LISTENER Hover listener property
static PropertyMapGroup	PROPERTIES A property group for all properties in TabAreaComponentsProperties
static PropertyMapProperty	SHAPED_PANEL_PROPERTIES Properties for the shaped panel
static BooleanProperty	STRETCH_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

TabAreaComponentsProperties	addSuperObject(TabAreaComponentsProperties superObject) Adds a super object from which property values are inherited.
ComponentProperties	getComponentProperties() Gets the component properties
HoverListener	getHoverListener() Gets the hover listener that will be triggered when the tab area components area is hovered by the mouse.
ShapedPanelProperties	getShapedPanelProperties() Gets the shaped panel properties
boolean	getStretchEnabled() Gets if components should be stretched to same height as tabs if tabs are higher than components.
TabAreaComponentsProperties	removeSuperObject() Removes the last added super object.
TabAreaComponentsProperties	removeSuperObject(TabAreaComponentsProperties superObject) Removes the given super object.
TabAreaComponentsProperties	setHoverListener(HoverListener listener) Sets the hover listener that will be triggered when the tab area components area is hoverd by the mouse.
TabAreaComponentsProperties	setStretchEnabled(boolean enabled) Sets if components should be stretched to same height as tabs if tabs are higher than components.

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

A property group for all properties in TabAreaComponentsProperties

STRETCH_ENABLED

public static final BooleanProperty STRETCH_ENABLED

Stretch enabled property

See Also:

setStretchEnabled(boolean), getStretchEnabled()

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

Since:

ITP 1.2.0

See Also:

getShapedPanelProperties()

HOVER_LISTENER

public static final HoverListenerProperty HOVER_LISTENER

Hover listener property

Since:

ITP 1.3.0

See Also:

setHoverListener(net.infonode.gui.hover.HoverListener), getHoverListener()

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

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

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

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

getComponentProperties

public ComponentProperties getComponentProperties()

Gets the component properties

Returns:

component properties

getShapedPanelProperties

public ShapedPanelProperties getShapedPanelProperties()

Gets the shaped panel properties

Returns:

shaped panel properties

Since:

ITP 1.2.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

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