public class ReferenceObject extends ComplexExtendedProperties
AF_NS, DVT_NS, F_NS
Constructor and Description |
---|
ReferenceObject() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAssociation()
Description:
A constant that identifies the component that this reference object is associated with.
|
java.lang.String |
getColor()
Description:
Specifies the color for the reference object.
|
java.lang.Object |
getHighValue()
Description:
Identifies the high end of the range of values for the area covered by this reference area.
|
java.lang.String |
getId()
Description:
Specifies the identifier for the component
|
java.lang.String |
getIndex()
Description:
Uniquely identifies a reference object within a specific reference object set.
|
java.lang.String |
getLineStyle()
Description:
Specifies the type of lineto be displayed for this reference object.
|
java.lang.Object |
getLineValue()
Description:
Specifies the value at which the reference line is displayed.
|
int |
getLineWidth()
Description:
Specifies the width of the reference line in pixels.
|
java.lang.String |
getLineWidthAsString()
Description:
Specifies the width of the reference line in pixels.
|
java.lang.String |
getLocation()
Description:
Specifies whether the reference line is to appear in front of or behind the graph.
|
java.lang.Object |
getLowValue()
Description:
Identifies the low end of the range of values for the area covered by this reference area.
|
int |
getSeries()
Description:
The zero-based index of the series that this reference object is associated.
|
java.lang.String |
getSeriesAsString()
Description:
The zero-based index of the series that this reference object is associated.
|
java.lang.String |
getShortDesc()
Description:
Specifies the short description that is to appear in the tooltip for this reference object as an alternative text for the value.
|
SpecialEffects |
getSpecialEffects()
Description:
Use the specialEffects tag to set gradient properties of a subcomponent of a graph or gauge.
|
java.lang.String |
getTagName() |
java.lang.String |
getText()
Description:
Specifies the text that is to appear in the legend for this reference object.
|
java.lang.String |
getType()
Description:
Identifies whether the reference object represents a line or an area.
|
boolean |
isDisplayedInLegend()
Description:
Indicates whether the reference object is to be displayed in the legend.
|
java.lang.String |
isDisplayedInLegendAsString()
Description:
Indicates whether the reference object is to be displayed in the legend.
|
void |
setAssociation(java.lang.String association)
Description:
A constant that identifies the component that this reference object is associated with.
|
void |
setColor(java.lang.String color)
Description:
Specifies the color for the reference object.
|
void |
setDisplayedInLegend(boolean displayedInLegend)
Description:
Indicates whether the reference object is to be displayed in the legend.
|
void |
setDisplayedInLegendAsString(java.lang.String displayedInLegend)
Description:
Indicates whether the reference object is to be displayed in the legend.
|
void |
setHighValue(java.lang.Object highValue)
Description:
Identifies the high end of the range of values for the area covered by this reference area.
|
void |
setId(java.lang.String id)
Description:
Specifies the identifier for the component
|
void |
setIndex(java.lang.String index)
Description:
Uniquely identifies a reference object within a specific reference object set.
|
void |
setLineStyle(java.lang.String lineStyle)
Description:
Specifies the type of lineto be displayed for this reference object.
|
void |
setLineValue(java.lang.Object lineValue)
Description:
Specifies the value at which the reference line is displayed.
|
void |
setLineWidth(int lineWidth)
Description:
Specifies the width of the reference line in pixels.
|
void |
setLineWidthAsString(java.lang.String lineWidth)
Description:
Specifies the width of the reference line in pixels.
|
void |
setLocation(java.lang.String location)
Description:
Specifies whether the reference line is to appear in front of or behind the graph.
|
void |
setLowValue(java.lang.Object lowValue)
Description:
Identifies the low end of the range of values for the area covered by this reference area.
|
void |
setSeries(int series)
Description:
The zero-based index of the series that this reference object is associated.
|
void |
setSeriesAsString(java.lang.String series)
Description:
The zero-based index of the series that this reference object is associated.
|
void |
setShortDesc(java.lang.String shortDesc)
Description:
Specifies the short description that is to appear in the tooltip for this reference object as an alternative text for the value.
|
void |
setSpecialEffects(SpecialEffects specialEffects)
Description:
Use the specialEffects tag to set gradient properties of a subcomponent of a graph or gauge.
|
void |
setText(java.lang.String text)
Description:
Specifies the text that is to appear in the legend for this reference object.
|
void |
setType(java.lang.String type)
Description:
Identifies whether the reference object represents a line or an area.
|
_applyToRootElement, _applyToRootElement, applyChanges, applyChanges, applyChanges, applyChanges, applyChanges, cloneFrom, getAttribute, getComplexChild, getComplexChild, getComplexChildAsList, populateAttributesAndChildTags, removeComplexChildList, setAttribute, setComplexChild, setComplexChild, setComplexChildAsList
public java.lang.String getTagName()
getTagName
in class ComplexExtendedProperties
public java.lang.String getAssociation()
public void setAssociation(java.lang.String association)
association
- the value of the association attribute of the Tag this class represents.public java.lang.String getColor()
public void setColor(java.lang.String color)
color
- the value of the color attribute of the Tag this class represents.public boolean isDisplayedInLegend()
public void setDisplayedInLegend(boolean displayedInLegend)
displayedInLegend
- the value of the displayedInLegend attribute of the Tag this class represents.public java.lang.String isDisplayedInLegendAsString()
public void setDisplayedInLegendAsString(java.lang.String displayedInLegend)
displayedInLegend
- the value of the displayedInLegend attribute of the Tag this class represents.public java.lang.Object getHighValue()
public void setHighValue(java.lang.Object highValue)
highValue
- the value of the highValue attribute of the Tag this class represents.public java.lang.String getId()
public void setId(java.lang.String id)
id
- the value of the id attribute of the Tag this class represents.public java.lang.String getIndex()
public void setIndex(java.lang.String index)
index
- the value of the index attribute of the Tag this class represents.public java.lang.String getLineStyle()
public void setLineStyle(java.lang.String lineStyle)
lineStyle
- the value of the lineStyle attribute of the Tag this class represents.public java.lang.Object getLineValue()
public void setLineValue(java.lang.Object lineValue)
lineValue
- the value of the lineValue attribute of the Tag this class represents.public int getLineWidth() throws java.lang.NumberFormatException
java.lang.NumberFormatException
public void setLineWidth(int lineWidth)
lineWidth
- the value of the lineWidth attribute of the Tag this class represents.public java.lang.String getLineWidthAsString() throws java.lang.NumberFormatException
java.lang.NumberFormatException
public void setLineWidthAsString(java.lang.String lineWidth)
lineWidth
- the value of the lineWidth attribute of the Tag this class represents.public java.lang.String getLocation()
public void setLocation(java.lang.String location)
location
- the value of the location attribute of the Tag this class represents.public java.lang.Object getLowValue()
public void setLowValue(java.lang.Object lowValue)
lowValue
- the value of the lowValue attribute of the Tag this class represents.public int getSeries() throws java.lang.NumberFormatException
java.lang.NumberFormatException
public void setSeries(int series)
series
- the value of the series attribute of the Tag this class represents.public java.lang.String getSeriesAsString() throws java.lang.NumberFormatException
java.lang.NumberFormatException
public void setSeriesAsString(java.lang.String series)
series
- the value of the series attribute of the Tag this class represents.public java.lang.String getShortDesc()
public void setShortDesc(java.lang.String shortDesc)
shortDesc
- the value of the shortDesc attribute of the Tag this class represents.public java.lang.String getText()
public void setText(java.lang.String text)
text
- the value of the text attribute of the Tag this class represents.public java.lang.String getType()
public void setType(java.lang.String type)
type
- the value of the type attribute of the Tag this class represents.public SpecialEffects getSpecialEffects()
public void setSpecialEffects(SpecialEffects specialEffects)
specialEffects
- the SpecialEffects of the Tag this class represents.