oracle.dss.gauge
Class Indicator

java.lang.Object
  oracle.dss.gauge.BaseGaugeComponent
      oracle.dss.gauge.Indicator

public class Indicator
extends BaseGaugeComponent

Since:

4.0s

Field Summary

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

Fields inherited from class oracle.dss.gauge.BaseGaugeComponent

m_commonGauge, m_compType

Constructor Summary

Indicator(CommonGauge gauge)

Method Summary

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()

Methods inherited from class oracle.dss.gauge.BaseGaugeComponent

getComponentName, getComponentType, selectObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

it_line

protected static final java.lang.String it_line

See Also:

Constant Field Values

For internal use only. Application developers should not use this

it_fill

protected static final java.lang.String it_fill

See Also:

Constant Field Values

For internal use only. Application developers should not use this

it_needle

protected static final java.lang.String it_needle

See Also:

Constant Field Values

For internal use only. Application developers should not use this

m_sfx

protected java.util.ArrayList<SFX> m_sfx

For internal use only. Application developers should not use this

These are the SFX maps for indicators

m_base_sfx

protected SFX m_base_sfx

m_bar_sfx

protected java.util.ArrayList<SFX> m_bar_sfx

Constructor Detail

Indicator

public Indicator(CommonGauge gauge)

Method Detail

size

protected int size()

Returns:

size The number of indicators

For internal use only. Application developers should not use this

Retrieve the number of indicators, which is determined by the maximum value of index plus one user specified in any set attributes API previously. Does not necessary equals to the number of indicators. Used in producing export XML

getFillColor

public java.awt.Color getFillColor()

Retrieves the fill color of this indicator. Gets the value of the first indicator if there are multiple indicators.

Returns:

The fill color of this indicator.

getFillColor

public java.awt.Color getFillColor(int index)

Retrieves the fill color of this indicator.

Parameters:

index - the index for the indicator.

Returns:

The fill color of this indicator.

setFillColor

public void setFillColor(java.awt.Color color)

Specifies the fill color of this indicator. Sets the value of the first indicator if there are multiple indicators.

Parameters:

color - The color of this indicator.

setFillColor

public void setFillColor(java.awt.Color color,
                         int index)

Specifies the fill color of this indicator.

Parameters:

index - The index of this indicator.

color - The color of this indicator.

getBorderColor

public java.awt.Color getBorderColor()

Retrieves the border color of this indicator. Gets the value of the first indicator if there are multiple indicators.

Returns:

The border color of this indicator.

getBorderColor

public java.awt.Color getBorderColor(int index)

Retrieves the border color of this indicator.

Parameters:

index - The index of this indicator.

Returns:

The border color of this indicator.

setBorderColor

public void setBorderColor(java.awt.Color color)

Specifies the border color of this indicator. Sets the value of the first indicator if there are multiple indicators.

Parameters:

color - The border color of this indicator.

setBorderColor

public void setBorderColor(java.awt.Color color,
                           int index)

Specifies the border color of this indicator.

Parameters:

index - The index of this indicator.

color - The border color of this indicator.

getType

public int getType()

Retrieves the type of this indicator. Only applies for Dial Gauges. Gets the value of the first indicator if there are multiple indicators.

Returns:

The type of this indicator. GaugeAttributes.
IT_LINE: Specifies an indicator that is a line.
IT_FILL: Specifies an indicator that fills the area up to the specified gauge value.
IT_NEEDLE: Specifies a thick needle indicator.
These are value constants for INDICATOR_TYPE key

getType

public int getType(int index)

Retrieves the type of this indicator. Only applies for Dial Gauges.

Parameters:

index - The index of this indicator.

Returns:

The type of this indicator. GaugeAttributes.
IT_LINE: Specifies an indicator that is a line.
IT_FILL: Specifies an indicator that fills the area up to the specified gauge value.
IT_NEEDLE: Specifies a thick needle indicator.
These are value constants for INDICATOR_TYPE key

setType

public void setType(int type)

Specifies the type of this indicator. Only applies for Dial Gauges. Sets the value of the first indicator if there are multiple indicators.

Parameters:

type - The type of this indicator. GaugeAttributes.
IT_LINE: Specifies an indicator that is a line.
IT_FILL: Specifies an indicator that fills the area up to the specified gauge value.
IT_NEEDLE: Specifies a thick needle indicator.
These are value constants for INDICATOR_TYPE key

setType

public void setType(int type,
                    int index)

Specifies the type of this indicator. Only applies for Dial Gauges.

Parameters:

index - The index of this indicator.

type - The type of this indicator. GaugeAttributes.
IT_LINE: Specifies an indicator that is a line.
IT_FILL: Specifies an indicator that fills the area up to the specified gauge value.
IT_NEEDLE: Specifies a thick needle indicator.
These are value constants for INDICATOR_TYPE key

isUseThresholdFillColor

public boolean isUseThresholdFillColor()

Returns whether or not the fill color of threshold in which the metric falls should override the indicator color. Gets the value of the first indicator if there are multiple indicators.

isUseThresholdFillColor

public boolean isUseThresholdFillColor(int index)

Returns whether or not the fill color of threshold in which the metric falls should override the indicator color.

Parameters:

index - The index of this indicator.

setUseThresholdFillColor

public void setUseThresholdFillColor(boolean use)

Specifies whether or not the fill color of threshold in which the metric falls should override the indicator color. Sets the value of the first indicator if there are multiple indicators.

Parameters:

use - TRUE if threshold color should be used, FALSE otherwise

setUseThresholdFillColor

public 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.

Parameters:

index - The index of this indicator.

use - TRUE if threshold color should be used, FALSE otherwise

getBarFillColor

public java.awt.Color getBarFillColor()

Retrieves the bar fill color of this indicator. The bar fill color is used when the gauge type is STATUSMETER. Gets the value of the first indicator if there are multiple indicators.

Returns:

The bar fill color of this indicator.

getBarFillColor

public java.awt.Color getBarFillColor(int index)

Retrieves the bar fill color of this indicator. The bar fill color is used when the gauge type is STATUSMETER.

Parameters:

index - The index of this indicator.

Returns:

The bar fill color of this indicator.

setBarFillColor

public void setBarFillColor(java.awt.Color color)

Specifies the bar fill color of this indicator. The bar fill color is used when the gauge type is STATUSMETER. Sets the value of the first indicator if there are multiple indicators.

Parameters:

color - The color of this bar indicator.

setBarFillColor

public void setBarFillColor(java.awt.Color color,
                            int index)

Specifies the bar fill color of this indicator. The bar fill color is used when the gauge type is STATUSMETER.

Parameters:

index - The index of this indicator.

color - The color of this bar indicator.

getBarBorderColor

public java.awt.Color getBarBorderColor()

Retrieves the bar border color of this indicator. The bar border color is used when the gauge type is STATUSMETER. Gets the value of the first indicator if there are multiple indicators.

Returns:

The bar border color of this indicator.

getBarBorderColor

public java.awt.Color getBarBorderColor(int index)

Retrieves the bar border color of this indicator. The bar border color is used when the gauge type is STATUSMETER.

Parameters:

index - The index of this indicator.

Returns:

The bar border color of this indicator.

setBarBorderColor

public void setBarBorderColor(java.awt.Color color)

Specifies the bar border color of this indicator. The bar border color is used when the gauge type is STATUSMETER. Sets the value of the first indicator if there are multiple indicators.

Parameters:

color - The border color of this bar indicator.

setBarBorderColor

public void setBarBorderColor(java.awt.Color color,
                              int index)

Specifies the bar border color of this indicator. The bar border color is used when the gauge type is STATUSMETER.

Parameters:

index - The index of this indicator.

color - The border color of this bar indicator.

getBaseFillColor

public java.awt.Color getBaseFillColor()

Retrieves the fill color of the indicator base. This is used when the indicator type is DIAL

Returns:

The fill color of the indicator base.

setBaseFillColor

public void setBaseFillColor(java.awt.Color color)

Specifies the fill color of the indicator base. This is used when the indicator type is DIAL

Parameters:

color - The color of the indicator base.

getBaseBorderColor

public java.awt.Color getBaseBorderColor()

Retrieves the border color of the indicator base. This is used when the indicator type is DIAL

Returns:

The border color of the indicator base.

setBaseBorderColor

public void setBaseBorderColor(java.awt.Color color)

Specifies the border color of the indicator base. This is used when the indicator type is DIAL

Parameters:

color - The border color of the indicator base.

isBaseVisible

public boolean isBaseVisible()

Retrieves whether or not the base should be visible.

Returns:

TRUE if the base should be visible, FALSE otherwise.

setBaseVisible

public void setBaseVisible(boolean visible)

Specifies whether or not the indicatorBase should be visible.

Parameters:

visible - TRUE if the base should be visible, FALSE otherwise.

convertTypeToInt

public static int convertTypeToInt(java.lang.String type)

For internal use only. Application developers should not use this

Converts Indicator Type String constants to Integer constants. This is used by get/setXML().

convertTypeToString

public static java.lang.String convertTypeToString(int type)

For internal use only. Application developers should not use this

Converts Indicator Type value into its String representation. This is used by get/setXML().

getSFX

public SFX getSFX()

Retrieves the 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.

Returns:

The IndicatorSFX object for this component.

getSFX

public SFX getSFX(int index)

Retrieves the IndicatorSFX object for this component. The IndicatorSFX object specifies attributes for special effects.

Parameters:

index - The index of this indicator.

Returns:

The IndicatorSFX object for this component.

getBaseSFX

public SFX getBaseSFX()

Retrieves the IndicatorSFX object for the indicator base. The IndicatorSFX object specifies attributes for special effects.

Returns:

The IndicatorSFX object for the indicator base.

getBarSFX

public SFX getBarSFX()

Retrieves the 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.

Returns:

The IndicatorSFX object for the indicator bar.

getBarSFX

public SFX getBarSFX(int index)

Retrieves the IndicatorSFX object for the indicator bar. The IndicatorSFX object specifies attributes for special effects.

Parameters:

index - The index of this indicator.

Returns:

The IndicatorSFX object for the indicator bar.