oracle.dss.gauge
Class BaseLabel

java.lang.Object
  oracle.dss.gauge.BaseGaugeComponent
      oracle.dss.gauge.BaseText
          oracle.dss.gauge.BaseLabel

All Implemented Interfaces:

FontAttribute

Direct Known Subclasses:

BottomLabel, MetricLabel, TopLabel

public class BaseLabel
extends BaseText

Since:

11.0

Field Summary

protected static java.lang.String	lp_abovegauge
protected static java.lang.String	lp_belowgauge
protected static java.lang.String	lp_insidegauge
protected static java.lang.String	lp_insidegauge_left
protected static java.lang.String	lp_insidegauge_right
protected static java.lang.String	lp_none
protected static java.lang.String	lp_withbottomlabel
protected int	m_defaultPosition
protected java.lang.String	m_positionKey

Fields inherited from class oracle.dss.gauge.BaseText

m_defaultFont, m_defaultFontColor, m_fontColorKey, m_fontKey, m_isGaugeSetComponent

Fields inherited from class oracle.dss.gauge.BaseGaugeComponent

m_commonGauge, m_compType

Constructor Summary

BaseLabel(CommonGauge gauge, int compType)

Method Summary

static int	convertLabelPositionToInt(java.lang.String position)
static java.lang.String	convertLabelPositionToString(int position)
int	getPosition() Gets the position of the label.
void	setPosition(int position) Sets the position of the metric label.

Methods inherited from class oracle.dss.gauge.BaseText

getFont, getFontColor, setFont, setFontColor

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

m_defaultPosition

protected int m_defaultPosition

m_positionKey

protected java.lang.String m_positionKey

lp_none

protected static final java.lang.String lp_none

See Also:

Constant Field Values

For internal use only. Application developers should not use this

lp_belowgauge

protected static final java.lang.String lp_belowgauge

See Also:

Constant Field Values

For internal use only. Application developers should not use this

lp_abovegauge

protected static final java.lang.String lp_abovegauge

See Also:

Constant Field Values

For internal use only. Application developers should not use this

lp_insidegauge

protected static final java.lang.String lp_insidegauge

See Also:

Constant Field Values

For internal use only. Application developers should not use this

lp_insidegauge_left

protected static final java.lang.String lp_insidegauge_left

See Also:

Constant Field Values

For internal use only. Application developers should not use this

lp_insidegauge_right

protected static final java.lang.String lp_insidegauge_right

See Also:

Constant Field Values

For internal use only. Application developers should not use this

lp_withbottomlabel

protected static final java.lang.String lp_withbottomlabel

See Also:

Constant Field Values

For internal use only. Application developers should not use this

Constructor Detail

BaseLabel

public BaseLabel(CommonGauge gauge,
                 int compType)

Method Detail

getPosition

public int getPosition()

Gets the position of the label.

Returns:

Integer representing where the label should be placed; valid constants are in the Gauge class starting with LP_.

setPosition

public void setPosition(int position)

Sets the position of the metric label.

Parameters:

position - Integer representing where the metric label should be placed; valid constants are in this class starting with LP_.

convertLabelPositionToInt

public static int convertLabelPositionToInt(java.lang.String position)

For internal use only. Application developers should not use this

Converts Metric Label position String constants to Integer constants. This is used by get/setXML().

convertLabelPositionToString

public static java.lang.String convertLabelPositionToString(int position)

For internal use only. Application developers should not use this

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