net.infonode.tabbedpanel.titledtab
Class TitledTabStateProperties

java.lang.Object
  net.infonode.properties.propertymap.PropertyMapContainer
      net.infonode.tabbedpanel.titledtab.TitledTabStateProperties

public class TitledTabStateProperties
extends PropertyMapContainer

TitledTabStateProperties holds all properties that are unique for a titled tab state.

Version:

$Revision: 1.24 $

Author:

$Author: jesper $

See Also:

TitledTab, TitledTabProperties

Field Summary

static PropertyMapProperty	COMPONENT_PROPERTIES Tab component properties.
static DirectionProperty	DIRECTION Direction property
static AlignmentProperty	HORIZONTAL_ALIGNMENT Horizontal alignment property
static IconProperty	ICON Icon property
static IntegerProperty	ICON_TEXT_GAP Icon text gap property
static AlignmentProperty	ICON_TEXT_RELATIVE_ALIGNMENT Icon text relative alignment property
static BooleanProperty	ICON_VISIBLE Icon visible property
static PropertyMapGroup	PROPERTIES A property group for all properties in TitledTabStateProperties
static PropertyMapProperty	SHAPED_PANEL_PROPERTIES Tab shaped panel properties.
static StringProperty	TEXT Text property
static IntegerProperty	TEXT_TITLE_COMPONENT_GAP Text title component gap property
static BooleanProperty	TEXT_VISIBLE Text visible property
static AlignmentProperty	TITLE_COMPONENT_TEXT_RELATIVE_ALIGNMENT Title component text relative alignment property
static BooleanProperty	TITLE_COMPONENT_VISIBLE Title component visible property
static BooleanProperty	TOOL_TIP_ENABLED Tool tip enabled property
static StringProperty	TOOL_TIP_TEXT Tool tip text property
static AlignmentProperty	VERTICAL_ALIGNMENT Vertical alignment property

Constructor Summary

TitledTabStateProperties()
Constructs an empty TitledTabStateProperties object

TitledTabStateProperties(PropertyMap map)
Constructs a TitledTabStateProperties map with the give map as property storage

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

Method Summary

TitledTabStateProperties	addSuperObject(TitledTabStateProperties superObject) Adds a super object from which property values are inherited.
ComponentProperties	getComponentProperties() Gets the component properties.
Direction	getDirection() Gets the direction, i.e. the line layout of the titled tab components.
Alignment	getHorizontalAlignment() Gets the text's and icon's horizontal alignment
javax.swing.Icon	getIcon() Gets the icon
int	getIconTextGap() Gets the gap in pixels between the icon and the text
Alignment	getIconTextRelativeAlignment() Gets the icon alignment relative to the text.
boolean	getIconVisible() Gets if icon is visible or not visible
ShapedPanelProperties	getShapedPanelProperties() Gets the shaped panel properties.
java.lang.String	getText() Gets the text
int	getTextTitleComponentGap() Gets the gap in pixels between the text/icon and the title component
boolean	getTextVisible() Gets if text is visible or not visible
Alignment	getTitleComponentTextRelativeAlignment() Gets the title components alignment relative to the text/icon
boolean	getTitleComponentVisible() Gets if title component is visible or not visible
boolean	getToolTipEnabled() Gets if tool tip text is enabled or disabled
java.lang.String	getToolTipText() Gets the tool tip text
Alignment	getVerticalAlignment() Gets the text's and icon's vertical alignment
TitledTabStateProperties	removeSuperObject() Removes the last added super object.
TitledTabStateProperties	removeSuperObject(TitledTabStateProperties superObject) Removes the given super object.
TitledTabStateProperties	setDirection(Direction direction) Sets the direction, i.e. the line layout of the titled tab's components.
TitledTabStateProperties	setHorizontalAlignment(Alignment alignment) Sets the text's and icon's horizontal alignment
TitledTabStateProperties	setIcon(javax.swing.Icon icon) Sets the icon
TitledTabStateProperties	setIconTextGap(int gap) Sets the gap in pixels between the icon and the text
TitledTabStateProperties	setIconTextRelativeAlignment(Alignment alignment) Sets the icon alignment relative to the text.
TitledTabStateProperties	setIconVisible(boolean visible) Sets if icon is visible or not visible
TitledTabStateProperties	setText(java.lang.String text) Sets the text
TitledTabStateProperties	setTextTitleComponentGap(int gap) Sets the gap in pixels between the text/icon and the title component
TitledTabStateProperties	setTextVisible(boolean visible) Sets if text is visible or not visible
TitledTabStateProperties	setTitleComponentTextRelativeAlignment(Alignment alignment) Sets the title components alignment relative to the text/icon
TitledTabStateProperties	setTitleComponentVisible(boolean visible) Sets if title component is visible or not visible
TitledTabStateProperties	setToolTipEnabled(boolean enabled) Sets if tool tip text is enabled or disabled
TitledTabStateProperties	setToolTipText(java.lang.String text) Sets the tool tip text
TitledTabStateProperties	setVerticalAlignment(Alignment alignment) Sets the text's and icon's vertical alignment

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 TitledTabStateProperties

ICON

public static final IconProperty ICON

Icon property

See Also:

setIcon(javax.swing.Icon), getIcon()

TEXT

public static final StringProperty TEXT

Text property

See Also:

setText(java.lang.String), getText()

ICON_TEXT_GAP

public static final IntegerProperty ICON_TEXT_GAP

Icon text gap property

See Also:

setIconTextGap(int), getIconTextGap()

TOOL_TIP_TEXT

public static final StringProperty TOOL_TIP_TEXT

Tool tip text property

See Also:

setToolTipText(java.lang.String), getToolTipText()

TOOL_TIP_ENABLED

public static final BooleanProperty TOOL_TIP_ENABLED

Tool tip enabled property

See Also:

setToolTipEnabled(boolean), getToolTipEnabled()

ICON_VISIBLE

public static final BooleanProperty ICON_VISIBLE

Icon visible property

Since:

ITP 1.1.0

See Also:

setIconVisible(boolean), getIconVisible()

TEXT_VISIBLE

public static final BooleanProperty TEXT_VISIBLE

Text visible property

Since:

ITP 1.1.0

See Also:

setTextVisible(boolean), getTextVisible()

TITLE_COMPONENT_VISIBLE

public static final BooleanProperty TITLE_COMPONENT_VISIBLE

Title component visible property

Since:

ITP 1.1.0

See Also:

setTitleComponentVisible(boolean), getTitleComponentVisible()

HORIZONTAL_ALIGNMENT

public static final AlignmentProperty HORIZONTAL_ALIGNMENT

Horizontal alignment property

See Also:

setHorizontalAlignment(net.infonode.util.Alignment), getHorizontalAlignment()

VERTICAL_ALIGNMENT

public static final AlignmentProperty VERTICAL_ALIGNMENT

Vertical alignment property

See Also:

setVerticalAlignment(net.infonode.util.Alignment), getVerticalAlignment()

ICON_TEXT_RELATIVE_ALIGNMENT

public static final AlignmentProperty ICON_TEXT_RELATIVE_ALIGNMENT

Icon text relative alignment property

See Also:

setIconTextRelativeAlignment(net.infonode.util.Alignment), getIconTextRelativeAlignment()

TEXT_TITLE_COMPONENT_GAP

public static final IntegerProperty TEXT_TITLE_COMPONENT_GAP

Text title component gap property

See Also:

setTextTitleComponentGap(int), getTextTitleComponentGap()

TITLE_COMPONENT_TEXT_RELATIVE_ALIGNMENT

public static final AlignmentProperty TITLE_COMPONENT_TEXT_RELATIVE_ALIGNMENT

Title component text relative alignment property

See Also:

setTitleComponentTextRelativeAlignment(net.infonode.util.Alignment), getTitleComponentTextRelativeAlignment()

DIRECTION

public static final DirectionProperty DIRECTION

Direction property

See Also:

setDirection(net.infonode.util.Direction), getDirection()

COMPONENT_PROPERTIES

public static final PropertyMapProperty COMPONENT_PROPERTIES

Tab component properties.

SHAPED_PANEL_PROPERTIES

public static final PropertyMapProperty SHAPED_PANEL_PROPERTIES

Tab shaped panel properties.

Since:

ITP 1.2.0

Constructor Detail

TitledTabStateProperties

public TitledTabStateProperties()

Constructs an empty TitledTabStateProperties object

TitledTabStateProperties

public TitledTabStateProperties(PropertyMap map)

Constructs a TitledTabStateProperties map with the give map as property storage

Parameters:

map - map to store properties in

TitledTabStateProperties

public TitledTabStateProperties(TitledTabStateProperties inheritFrom)

Constructs a TitledTabStateProperties object that inherits its properties from the given TitledTabStateProperties object

Parameters:

inheritFrom - TitledTabStateProperties object to inherit properties from

Method Detail

addSuperObject

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

Removes the last added super object.

Returns:

this

removeSuperObject

public TitledTabStateProperties removeSuperObject(TitledTabStateProperties superObject)

Removes the given super object.

Parameters:

superObject - super object to remove

Returns:

this

Since:

ITP 1.3.0

setIcon

public TitledTabStateProperties setIcon(javax.swing.Icon icon)

Sets the icon

Parameters:

icon - icon or null for no icon

Returns:

this TitledTabStateProperties

getIcon

public javax.swing.Icon getIcon()

Gets the icon

Returns:

icon or null if no icon

setText

public TitledTabStateProperties setText(java.lang.String text)

Sets the text

Parameters:

text - text or null for no text

Returns:

this TitledTabStateProperties

getText

public java.lang.String getText()

Gets the text

Returns:

text or null if no text

setIconTextGap

public TitledTabStateProperties setIconTextGap(int gap)

Sets the gap in pixels between the icon and the text

Parameters:

gap - number of pixels

Returns:

this TitledTabStateProperties

getIconTextGap

public int getIconTextGap()

Gets the gap in pixels between the icon and the text

Returns:

number of pixels

setToolTipText

public TitledTabStateProperties setToolTipText(java.lang.String text)

Sets the tool tip text

Parameters:

text - tool tip text

Returns:

this TitledTabStateProperties

getToolTipText

public java.lang.String getToolTipText()

Gets the tool tip text

Returns:

tool tip text

setToolTipEnabled

public TitledTabStateProperties setToolTipEnabled(boolean enabled)

Sets if tool tip text is enabled or disabled

Parameters:

enabled - true for enabled, otherwise false

Returns:

this TitledTabStateProperties

getToolTipEnabled

public boolean getToolTipEnabled()

Gets if tool tip text is enabled or disabled

Returns:

true if enabled, otherwise false

setIconVisible

public TitledTabStateProperties setIconVisible(boolean visible)

Sets if icon is visible or not visible

Parameters:

visible - true for visible, otherwise false

Returns:

this TitledTabStateProperties

Since:

ITP 1.1.0

getIconVisible

public boolean getIconVisible()

Gets if icon is visible or not visible

Returns:

true if visible, otherwise false

Since:

ITP 1.1.0

setTextVisible

public TitledTabStateProperties setTextVisible(boolean visible)

Sets if text is visible or not visible

Parameters:

visible - true for visible, otherwise false

Returns:

this TitledTabStateProperties

Since:

ITP 1.1.0

getTextVisible

public boolean getTextVisible()

Gets if text is visible or not visible

Returns:

true if visible, otherwise false

Since:

ITP 1.1.0

setTitleComponentVisible

public TitledTabStateProperties setTitleComponentVisible(boolean visible)

Sets if title component is visible or not visible

Parameters:

visible - true for enabled, otherwise false

Returns:

this TitledTabStateProperties

Since:

ITP 1.1.0

getTitleComponentVisible

public boolean getTitleComponentVisible()

Gets if title component is visible or not visible

Returns:

true if enabled, otherwise false

Since:

ITP 1.1.0

setHorizontalAlignment

public TitledTabStateProperties setHorizontalAlignment(Alignment alignment)

Sets the text's and icon's horizontal alignment

Parameters:

alignment - text and icon alignment

Returns:

this TitledTabStateProperties

getHorizontalAlignment

public Alignment getHorizontalAlignment()

Gets the text's and icon's horizontal alignment

Returns:

text and icon alignment

setVerticalAlignment

public TitledTabStateProperties setVerticalAlignment(Alignment alignment)

Sets the text's and icon's vertical alignment

Parameters:

alignment - text and icon horizontal alignment

Returns:

this TitledTabStateProperties

getVerticalAlignment

public Alignment getVerticalAlignment()

Gets the text's and icon's vertical alignment

Returns:

text and icon vertical alignment

setIconTextRelativeAlignment

public TitledTabStateProperties setIconTextRelativeAlignment(Alignment alignment)

Sets the icon alignment relative to the text. Makes it possible to switch places between text and icon.

Parameters:

alignment - icon alignment relative to text

Returns:

this TitledTabStateProperties

getIconTextRelativeAlignment

public Alignment getIconTextRelativeAlignment()

Gets the icon alignment relative to the text.

Returns:

icon alignment relative to text

setTextTitleComponentGap

public TitledTabStateProperties setTextTitleComponentGap(int gap)

Sets the gap in pixels between the text/icon and the title component

Parameters:

gap - number of pixels

Returns:

this TitledTabStateProperties

getTextTitleComponentGap

public int getTextTitleComponentGap()

Gets the gap in pixels between the text/icon and the title component

Returns:

number of pixels

setTitleComponentTextRelativeAlignment

public TitledTabStateProperties setTitleComponentTextRelativeAlignment(Alignment alignment)

Sets the title components alignment relative to the text/icon

Parameters:

alignment - title component alignment relative to text/icon

Returns:

this TitledTabStateProperties

getTitleComponentTextRelativeAlignment

public Alignment getTitleComponentTextRelativeAlignment()

Gets the title components alignment relative to the text/icon

Returns:

title component alignment relative to text/icon

setDirection

public TitledTabStateProperties setDirection(Direction direction)

Sets the direction, i.e. the line layout of the titled tab's components. The text and icon will be rotated in the given direction and the title component will be moved.

Parameters:

direction - direction

Returns:

this TitledTabStateProperties

getDirection

public Direction getDirection()

Gets the direction, i.e. the line layout of the titled tab components. The text and icon are rotated in the given direction and the title component will be moved.

Returns:

direction

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