net.infonode.tabbedpanel.titledtab

Class 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 PropertyMapPropertyCOMPONENT_PROPERTIES
Tab component properties.
static DirectionPropertyDIRECTION
Direction property
static AlignmentPropertyHORIZONTAL_ALIGNMENT
Horizontal alignment property
static IconPropertyICON
Icon property
static IntegerPropertyICON_TEXT_GAP
Icon text gap property
static AlignmentPropertyICON_TEXT_RELATIVE_ALIGNMENT
Icon text relative alignment property
static BooleanPropertyICON_VISIBLE
Icon visible property
static PropertyMapGroupPROPERTIES
A property group for all properties in TitledTabStateProperties
static PropertyMapPropertySHAPED_PANEL_PROPERTIES
Tab shaped panel properties.
static StringPropertyTEXT
Text property
static IntegerPropertyTEXT_TITLE_COMPONENT_GAP
Text title component gap property
static BooleanPropertyTEXT_VISIBLE
Text visible property
static AlignmentPropertyTITLE_COMPONENT_TEXT_RELATIVE_ALIGNMENT
Title component text relative alignment property
static BooleanPropertyTITLE_COMPONENT_VISIBLE
Title component visible property
static BooleanPropertyTOOL_TIP_ENABLED
Tool tip enabled property
static StringPropertyTOOL_TIP_TEXT
Tool tip text property
static AlignmentPropertyVERTICAL_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
TitledTabStatePropertiesaddSuperObject(TitledTabStateProperties superObject)
Adds a super object from which property values are inherited.
ComponentPropertiesgetComponentProperties()
Gets the component properties.
DirectiongetDirection()
Gets the direction, i.e. the line layout of the titled tab components.
AlignmentgetHorizontalAlignment()
Gets the text's and icon's horizontal alignment
IcongetIcon()
Gets the icon
intgetIconTextGap()
Gets the gap in pixels between the icon and the text
AlignmentgetIconTextRelativeAlignment()
Gets the icon alignment relative to the text.
booleangetIconVisible()
Gets if icon is visible or not visible
ShapedPanelPropertiesgetShapedPanelProperties()
Gets the shaped panel properties.
StringgetText()
Gets the text
intgetTextTitleComponentGap()
Gets the gap in pixels between the text/icon and the title component
booleangetTextVisible()
Gets if text is visible or not visible
AlignmentgetTitleComponentTextRelativeAlignment()
Gets the title components alignment relative to the text/icon
booleangetTitleComponentVisible()
Gets if title component is visible or not visible
booleangetToolTipEnabled()
Gets if tool tip text is enabled or disabled
StringgetToolTipText()
Gets the tool tip text
AlignmentgetVerticalAlignment()
Gets the text's and icon's vertical alignment
TitledTabStatePropertiesremoveSuperObject()
Removes the last added super object.
TitledTabStatePropertiesremoveSuperObject(TitledTabStateProperties superObject)
Removes the given super object.
TitledTabStatePropertiessetDirection(Direction direction)
Sets the direction, i.e. the line layout of the titled tab's components.
TitledTabStatePropertiessetHorizontalAlignment(Alignment alignment)
Sets the text's and icon's horizontal alignment
TitledTabStatePropertiessetIcon(Icon icon)
Sets the icon
TitledTabStatePropertiessetIconTextGap(int gap)
Sets the gap in pixels between the icon and the text
TitledTabStatePropertiessetIconTextRelativeAlignment(Alignment alignment)
Sets the icon alignment relative to the text.
TitledTabStatePropertiessetIconVisible(boolean visible)
Sets if icon is visible or not visible
TitledTabStatePropertiessetText(String text)
Sets the text
TitledTabStatePropertiessetTextTitleComponentGap(int gap)
Sets the gap in pixels between the text/icon and the title component
TitledTabStatePropertiessetTextVisible(boolean visible)
Sets if text is visible or not visible
TitledTabStatePropertiessetTitleComponentTextRelativeAlignment(Alignment alignment)
Sets the title components alignment relative to the text/icon
TitledTabStatePropertiessetTitleComponentVisible(boolean visible)
Sets if title component is visible or not visible
TitledTabStatePropertiessetToolTipEnabled(boolean enabled)
Sets if tool tip text is enabled or disabled
TitledTabStatePropertiessetToolTipText(String text)
Sets the tool tip text
TitledTabStatePropertiessetVerticalAlignment(Alignment alignment)
Sets the text's and icon's vertical alignment

Field Detail

COMPONENT_PROPERTIES

public static final PropertyMapProperty COMPONENT_PROPERTIES
Tab component properties.

DIRECTION

public static final DirectionProperty DIRECTION
Direction property

See Also: TitledTabStateProperties TitledTabStateProperties

HORIZONTAL_ALIGNMENT

public static final AlignmentProperty HORIZONTAL_ALIGNMENT
Horizontal alignment property

See Also: TitledTabStateProperties TitledTabStateProperties

ICON

public static final IconProperty ICON
Icon property

See Also: TitledTabStateProperties TitledTabStateProperties

ICON_TEXT_GAP

public static final IntegerProperty ICON_TEXT_GAP
Icon text gap property

See Also: TitledTabStateProperties TitledTabStateProperties

ICON_TEXT_RELATIVE_ALIGNMENT

public static final AlignmentProperty ICON_TEXT_RELATIVE_ALIGNMENT
Icon text relative alignment property

See Also: TitledTabStateProperties TitledTabStateProperties

ICON_VISIBLE

public static final BooleanProperty ICON_VISIBLE
Icon visible property

Since: ITP 1.1.0

See Also: TitledTabStateProperties TitledTabStateProperties

PROPERTIES

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

SHAPED_PANEL_PROPERTIES

public static final PropertyMapProperty SHAPED_PANEL_PROPERTIES
Tab shaped panel properties.

Since: ITP 1.2.0

TEXT

public static final StringProperty TEXT
Text property

See Also: TitledTabStateProperties TitledTabStateProperties

TEXT_TITLE_COMPONENT_GAP

public static final IntegerProperty TEXT_TITLE_COMPONENT_GAP
Text title component gap property

See Also: TitledTabStateProperties TitledTabStateProperties

TEXT_VISIBLE

public static final BooleanProperty TEXT_VISIBLE
Text visible property

Since: ITP 1.1.0

See Also: TitledTabStateProperties TitledTabStateProperties

TITLE_COMPONENT_TEXT_RELATIVE_ALIGNMENT

public static final AlignmentProperty TITLE_COMPONENT_TEXT_RELATIVE_ALIGNMENT
Title component text relative alignment property

See Also: TitledTabStateProperties TitledTabStateProperties

TITLE_COMPONENT_VISIBLE

public static final BooleanProperty TITLE_COMPONENT_VISIBLE
Title component visible property

Since: ITP 1.1.0

See Also: TitledTabStateProperties TitledTabStateProperties

TOOL_TIP_ENABLED

public static final BooleanProperty TOOL_TIP_ENABLED
Tool tip enabled property

See Also: TitledTabStateProperties TitledTabStateProperties

TOOL_TIP_TEXT

public static final StringProperty TOOL_TIP_TEXT
Tool tip text property

See Also: TitledTabStateProperties TitledTabStateProperties

VERTICAL_ALIGNMENT

public static final AlignmentProperty VERTICAL_ALIGNMENT
Vertical alignment property

See Also: TitledTabStateProperties TitledTabStateProperties

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

getComponentProperties

public ComponentProperties getComponentProperties()
Gets the component properties.

Returns: component properties

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

getHorizontalAlignment

public Alignment getHorizontalAlignment()
Gets the text's and icon's horizontal alignment

Returns: text and icon alignment

getIcon

public Icon getIcon()
Gets the icon

Returns: icon or null if no icon

getIconTextGap

public int getIconTextGap()
Gets the gap in pixels between the icon and the text

Returns: number of pixels

getIconTextRelativeAlignment

public Alignment getIconTextRelativeAlignment()
Gets the icon alignment relative to the text.

Returns: icon alignment relative to text

getIconVisible

public boolean getIconVisible()
Gets if icon is visible or not visible

Returns: true if visible, otherwise false

Since: ITP 1.1.0

getShapedPanelProperties

public ShapedPanelProperties getShapedPanelProperties()
Gets the shaped panel properties.

Returns: shaped panel properties

Since: ITP 1.2.0

getText

public String getText()
Gets the text

Returns: text or null if no text

getTextTitleComponentGap

public int getTextTitleComponentGap()
Gets the gap in pixels between the text/icon and the title component

Returns: number of pixels

getTextVisible

public boolean getTextVisible()
Gets if text is visible or not visible

Returns: true if visible, otherwise false

Since: ITP 1.1.0

getTitleComponentTextRelativeAlignment

public Alignment getTitleComponentTextRelativeAlignment()
Gets the title components alignment relative to the text/icon

Returns: title component alignment relative to text/icon

getTitleComponentVisible

public boolean getTitleComponentVisible()
Gets if title component is visible or not visible

Returns: true if enabled, otherwise false

Since: ITP 1.1.0

getToolTipEnabled

public boolean getToolTipEnabled()
Gets if tool tip text is enabled or disabled

Returns: true if enabled, otherwise false

getToolTipText

public String getToolTipText()
Gets the tool tip text

Returns: tool tip text

getVerticalAlignment

public Alignment getVerticalAlignment()
Gets the text's and icon's vertical alignment

Returns: text and icon vertical alignment

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

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

setHorizontalAlignment

public TitledTabStateProperties setHorizontalAlignment(Alignment alignment)
Sets the text's and icon's horizontal alignment

Parameters: alignment text and icon alignment

Returns: this TitledTabStateProperties

setIcon

public TitledTabStateProperties setIcon(Icon icon)
Sets the icon

Parameters: icon icon or null for no icon

Returns: this TitledTabStateProperties

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

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

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

setText

public TitledTabStateProperties setText(String text)
Sets the text

Parameters: text text or null for no text

Returns: this TitledTabStateProperties

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

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

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

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

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

setToolTipText

public TitledTabStateProperties setToolTipText(String text)
Sets the tool tip text

Parameters: text tool tip text

Returns: this TitledTabStateProperties

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