net.infonode.tabbedpanel
Class TabAreaProperties

java.lang.Object
  extended by net.infonode.properties.propertymap.PropertyMapContainer
      extended by net.infonode.tabbedpanel.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 PropertyMapProperty COMPONENT_PROPERTIES
          Properties for the component
static HoverListenerProperty HOVER_LISTENER
          Hover listener property
static PropertyMapGroup PROPERTIES
          A property group for all properties in TabAreaProperties
static PropertyMapProperty SHAPED_PANEL_PROPERTIES
          Properties for the shaped panel
static TabAreaVisiblePolicyProperty TAB_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
 TabAreaProperties addSuperObject(TabAreaProperties superObject)
          Adds a super object from which property values are inherited.
 ComponentProperties getComponentProperties()
          Gets the component properties
 HoverListener getHoverListener()
          Sets the hover listener that will be triggered when the tab area is hovered by the mouse.
 ShapedPanelProperties getShapedPanelProperties()
          Gets the shaped panel properties
 TabAreaVisiblePolicy getTabAreaVisiblePolicy()
          Gets the tab area visible policy for the tab area, i.e. when the tab area is to be visible
 TabAreaProperties removeSuperObject()
          Removes the last added super object.
 TabAreaProperties removeSuperObject(TabAreaProperties superObject)
          Removes the given super object.
 TabAreaProperties setHoverListener(HoverListener listener)
          Sets the hover listener that will be triggered when the tab area is hoverd by the mouse.
 TabAreaProperties setTabAreaVisiblePolicy(TabAreaVisiblePolicy policy)
          Sets the tab area visible policy for the tab area, i.e. when the tab area is to be visible
 
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 TabAreaProperties


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()

TAB_AREA_VISIBLE_POLICY

public static final TabAreaVisiblePolicyProperty TAB_AREA_VISIBLE_POLICY
Tab area visible property

Since:
ITP 1.4.0
See Also:
setTabAreaVisiblePolicy(TabAreaVisiblePolicy), 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

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

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 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

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

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

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