Package com.motivewave.platform.sdk.common

Class TagInfo

java.lang.Object

com.motivewave.platform.sdk.common.BaseInfo

com.motivewave.platform.sdk.common.TagInfo

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

IndicatorInfo, SeriesInfo

public abstract class TagInfo
extends BaseInfo

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TagInfo(String tag, boolean showTag, boolean showTagValue, TextStyle style, boolean enabled)

Method Summary

Modifier and Type	Method	Description
TagInfo	clone()	Creates a clone (copy) of this object.
String	getTag()	Gets the descriptive tag to be shown.
Color	getTagBgColor()	Gets the background color for the tag.
Font	getTagFont()	Gets the font for the tag label.
TextStyle	getTagStyle()	Gets the text style for the tag (includes font, text and bg color).
Color	getTagTextColor()	Gets the text color for the tag.
boolean	isShowTag()	Indicates if the tag should be shown.
boolean	isShowTagValue()	Indicates if the latest value should be shown in the tag.
TagInfo	setShowTag(boolean showTag)	Creates a copy of the object and sets the showTag attribute.
TagInfo	setShowTagValue(boolean showTagValue)	Creates a copy of the object and sets the showTagValue attribute.
TagInfo	setTag(String tag)	Creates a copy of the object and sets the tag attribute.
TagInfo	setTagBgColor(Color c)	Creates a copy of the object and sets the tag attribute.
TagInfo	setTagTextColor(Color c)	Creates a copy of the object and sets the tag attribute.

Methods inherited from class com.motivewave.platform.sdk.common.BaseInfo

enabled, equals, getKey, hashCode, isEnabled, setEnabled, setKey, toJson, toJson, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

TagInfo

protected TagInfo(String tag,
 boolean showTag,
 boolean showTagValue,
 TextStyle style,
 boolean enabled)

Method Details

getTagFont

public Font getTagFont()

Gets the font for the tag label.

Returns:

font

isShowTag

public boolean isShowTag()

Indicates if the tag should be shown.

Returns:

true if the tag should be shown

isShowTagValue

public boolean isShowTagValue()

Indicates if the latest value should be shown in the tag.

Returns:

true if the latest value should be added to the tag

getTag

public String getTag()

Gets the descriptive tag to be shown.

Returns:

descriptive tag

getTagTextColor

public Color getTagTextColor()

Gets the text color for the tag.

Returns:

text color for the tag

getTagBgColor

public Color getTagBgColor()

Gets the background color for the tag.

Returns:

background color for the tag

getTagStyle

public TextStyle getTagStyle()

Gets the text style for the tag (includes font, text and bg color).

Returns:

text style for the tag

setShowTag

public TagInfo setShowTag(boolean showTag)

Creates a copy of the object and sets the showTag attribute.

Parameters:

showTag - true if the tag should be displayed

Returns:

copy of the object

setShowTagValue

public TagInfo setShowTagValue(boolean showTagValue)

Creates a copy of the object and sets the showTagValue attribute.

Parameters:

showTag - true if the tag value should be displayed

Returns:

copy of the object

setTag

public TagInfo setTag(String tag)

Creates a copy of the object and sets the tag attribute.

Parameters:

tag - text to be displayed in the tag

Returns:

copy of the object

setTagTextColor

public TagInfo setTagTextColor(Color c)

Creates a copy of the object and sets the tag attribute.

Parameters:

tag - text to be displayed in the tag

Returns:

copy of the object

setTagBgColor

public TagInfo setTagBgColor(Color c)

Creates a copy of the object and sets the tag attribute.

Parameters:

tag - text to be displayed in the tag

Returns:

copy of the object

clone

public TagInfo clone()

Creates a clone (copy) of this object.

Overrides:

clone in class BaseInfo

Returns:

clone of this object