public class Indicator extends BaseGaugeComponent
Modifier and Type | Field and Description |
---|---|
protected static java.lang.String |
a_fill |
protected static java.lang.String |
a_line |
protected static java.lang.String |
a_needle |
protected static java.lang.String |
it_fill |
protected static java.lang.String |
it_line |
protected static java.lang.String |
it_needle |
protected java.util.ArrayList<SFX> |
m_bar_sfx |
protected SFX |
m_base_sfx |
protected java.util.ArrayList<SFX> |
m_sfx |
m_commonGauge, m_compType
Constructor and Description |
---|
Indicator(CommonGauge gauge) |
Modifier and Type | Method and Description |
---|---|
static int |
convertTypeToInt(java.lang.String type) |
static java.lang.String |
convertTypeToString(int type) |
java.awt.Color |
getBarBorderColor()
Retrieves the bar border color of this indicator.
|
java.awt.Color |
getBarBorderColor(int index)
Retrieves the bar border color of this indicator.
|
java.awt.Color |
getBarFillColor()
Retrieves the bar fill color of this indicator.
|
java.awt.Color |
getBarFillColor(int index)
Retrieves the bar fill color of this indicator.
|
SFX |
getBarSFX()
Retrieves the
IndicatorSFX object for the indicator bar. |
SFX |
getBarSFX(int index)
Retrieves the
IndicatorSFX object for the indicator bar. |
java.awt.Color |
getBaseBorderColor()
Retrieves the border color of the indicator base.
|
java.awt.Color |
getBaseFillColor()
Retrieves the fill color of the indicator base.
|
SFX |
getBaseSFX()
Retrieves the
IndicatorSFX object for the indicator base. |
java.awt.Color |
getBorderColor()
Retrieves the border color of this indicator.
|
java.awt.Color |
getBorderColor(int index)
Retrieves the border color of this indicator.
|
java.awt.Color |
getFillColor()
Retrieves the fill color of this indicator.
|
java.awt.Color |
getFillColor(int index)
Retrieves the fill color of this indicator.
|
SFX |
getSFX()
Retrieves the
IndicatorSFX object for this component. |
SFX |
getSFX(int index)
Retrieves the
IndicatorSFX object for this component. |
int |
getType()
Retrieves the type of this indicator.
|
int |
getType(int index)
Retrieves the type of this indicator.
|
boolean |
isBaseVisible()
Retrieves whether or not the base should be visible.
|
boolean |
isUseThresholdFillColor()
Returns whether or not the fill color of threshold in which
the metric falls should override the indicator color.
|
boolean |
isUseThresholdFillColor(int index)
Returns whether or not the fill color of threshold in which
the metric falls should override the indicator color.
|
void |
setBarBorderColor(java.awt.Color color)
Specifies the bar border color of this indicator.
|
void |
setBarBorderColor(java.awt.Color color,
int index)
Specifies the bar border color of this indicator.
|
void |
setBarFillColor(java.awt.Color color)
Specifies the bar fill color of this indicator.
|
void |
setBarFillColor(java.awt.Color color,
int index)
Specifies the bar fill color of this indicator.
|
void |
setBaseBorderColor(java.awt.Color color)
Specifies the border color of the indicator base.
|
void |
setBaseFillColor(java.awt.Color color)
Specifies the fill color of the indicator base.
|
void |
setBaseVisible(boolean visible)
Specifies whether or not the indicatorBase should be visible.
|
void |
setBorderColor(java.awt.Color color)
Specifies the border color of this indicator.
|
void |
setBorderColor(java.awt.Color color,
int index)
Specifies the border color of this indicator.
|
void |
setFillColor(java.awt.Color color)
Specifies the fill color of this indicator.
|
void |
setFillColor(java.awt.Color color,
int index)
Specifies the fill color of this indicator.
|
void |
setType(int type)
Specifies the type of this indicator.
|
void |
setType(int type,
int index)
Specifies the type of this indicator.
|
void |
setUseThresholdFillColor(boolean use)
Specifies whether or not the fill color of threshold in which
the metric falls should override the indicator color.
|
void |
setUseThresholdFillColor(boolean use,
int index)
Specifies whether or not the fill color of threshold in which
the metric falls should override the indicator color.
|
protected int |
size() |
getComponentName, getComponentType, selectObject
protected static final java.lang.String it_line
protected static final java.lang.String it_fill
protected static final java.lang.String it_needle
protected static final java.lang.String a_line
protected static final java.lang.String a_fill
protected static final java.lang.String a_needle
protected java.util.ArrayList<SFX> m_sfx
protected SFX m_base_sfx
protected java.util.ArrayList<SFX> m_bar_sfx
public Indicator(CommonGauge gauge)
protected int size()
public java.awt.Color getFillColor()
public java.awt.Color getFillColor(int index)
index
- the index for the indicator.public void setFillColor(java.awt.Color color)
color
- The color of this indicator.public void setFillColor(java.awt.Color color, int index)
index
- The index of this indicator.color
- The color of this indicator.public java.awt.Color getBorderColor()
public java.awt.Color getBorderColor(int index)
index
- The index of this indicator.public void setBorderColor(java.awt.Color color)
color
- The border color of this indicator.public void setBorderColor(java.awt.Color color, int index)
index
- The index of this indicator.color
- The border color of this indicator.public int getType()
public int getType(int index)
index
- The index of this indicator.public void setType(int type)
type
- The type of this indicator.
GaugeAttributes.
public void setType(int type, int index)
index
- The index of this indicator.type
- The type of this indicator.
GaugeAttributes.
public boolean isUseThresholdFillColor()
public boolean isUseThresholdFillColor(int index)
index
- The index of this indicator.public void setUseThresholdFillColor(boolean use)
use
- TRUE
if threshold color
should be used, FALSE
otherwisepublic void setUseThresholdFillColor(boolean use, int index)
index
- The index of this indicator.use
- TRUE
if threshold color
should be used, FALSE
otherwisepublic java.awt.Color getBarFillColor()
public java.awt.Color getBarFillColor(int index)
index
- The index of this indicator.public void setBarFillColor(java.awt.Color color)
color
- The color of this bar indicator.public void setBarFillColor(java.awt.Color color, int index)
index
- The index of this indicator.color
- The color of this bar indicator.public java.awt.Color getBarBorderColor()
public java.awt.Color getBarBorderColor(int index)
index
- The index of this indicator.public void setBarBorderColor(java.awt.Color color)
color
- The border color of this bar indicator.public void setBarBorderColor(java.awt.Color color, int index)
index
- The index of this indicator.color
- The border color of this bar indicator.public java.awt.Color getBaseFillColor()
public void setBaseFillColor(java.awt.Color color)
color
- The color of the indicator base.public java.awt.Color getBaseBorderColor()
public void setBaseBorderColor(java.awt.Color color)
color
- The border color of the indicator base.public boolean isBaseVisible()
TRUE
if the base should be visible,
FALSE
otherwise.public void setBaseVisible(boolean visible)
visible
- TRUE
if the base should be visible,
FALSE
otherwise.public static int convertTypeToInt(java.lang.String type)
public static java.lang.String convertTypeToString(int type)
public SFX getSFX()
IndicatorSFX
object for this component.
The IndicatorSFX
object specifies attributes
for special effects.
Gets the value of the first indicator if there are multiple indicators.IndicatorSFX
object for this component.public SFX getSFX(int index)
IndicatorSFX
object for this component.
The IndicatorSFX
object specifies attributes
for special effects.index
- The index of this indicator.IndicatorSFX
object for this component.public SFX getBaseSFX()
IndicatorSFX
object for the indicator base.
The IndicatorSFX
object specifies attributes
for special effects.IndicatorSFX
object for the indicator base.public SFX getBarSFX()
IndicatorSFX
object for the indicator bar.
The IndicatorSFX
object specifies attributes
for special effects.
Gets the value of the first indicator if there are multiple indicators.IndicatorSFX
object for the indicator bar.public SFX getBarSFX(int index)
IndicatorSFX
object for the indicator bar.
The IndicatorSFX
object specifies attributes
for special effects.index
- The index of this indicator.IndicatorSFX
object for the indicator bar.