oracle.dss.gauge
Class TopLabel

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

All Implemented Interfaces:

FontAttribute

public class TopLabel
extends BaseLabel

Since:

11.0

Field Summary

Fields inherited from class oracle.dss.gauge.BaseLabel

lp_abovegauge, lp_belowgauge, lp_insidegauge, lp_insidegauge_left, lp_insidegauge_right, lp_none, lp_withbottomlabel, m_defaultPosition, 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

TopLabel(CommonGauge gauge)

Method Summary

java.lang.String	getText() Retrieves the text for the TopLabel.
java.lang.String	getText(int index) Retrieves the top label override for the gauge at the specified index of a gauge set.
void	setText(int index, java.lang.String label) Specifies the top label override for the gauge at the specified index of a gauge set.
void	setText(java.lang.String str) Specifies the text for the TopLabel.

Methods inherited from class oracle.dss.gauge.BaseLabel

convertLabelPositionToInt, convertLabelPositionToString, getPosition, setPosition

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

Constructor Detail

TopLabel

public TopLabel(CommonGauge gauge)

Method Detail

getText

public java.lang.String getText()

Retrieves the text for the TopLabel.

Returns:

String The text of this TopLabel.

setText

public void setText(java.lang.String str)

Specifies the text for the TopLabel.

Parameters:

str - The text of this TopLabel.

setText

public void setText(int index,
                    java.lang.String label)

Specifies the top label override for the gauge at the specified index of a gauge set.

Parameters:

index - The index of the top label to override in a gauge set.

label - The label to to apply.

getText

public java.lang.String getText(int index)

Retrieves the top label override for the gauge at the specified index of a gauge set.

Parameters:

index - The index of the top label to return.

Returns:

String The label at the passed in index. null if unspecified.