oracle.dss.gauge
Class MetricLabel

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

All Implemented Interfaces:

FontAttribute

public class MetricLabel
extends BaseLabel

Since:

11.0

Field Summary

Fields inherited from class oracle.dss.gauge.BaseLabel

a_aboveGauge, a_belowGauge, a_insideGauge, a_insideGaugeLeft, a_insideGaugeRight, a_none, a_withBottomLabel, 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

MetricLabel(CommonGauge gauge)

Method Summary

int	getNumberType() Gets the type of number displayed in metric label.
int	getPosition() Returns the position of the label.
ViewFormat	getViewFormat() Retrieves a ViewFormat object for tick labels.
void	setNumberType(int type) Sets the type of number to be displayed in metric label.
void	setPosition(int position) Specifies the position of the label.
void	setViewFormat(ViewFormat viewFormat) Specifies a ViewFormat object for tick labels.

Methods inherited from class oracle.dss.gauge.BaseLabel

convertLabelPositionToInt, convertLabelPositionToString

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

MetricLabel

public MetricLabel(CommonGauge gauge)

Method Detail

getViewFormat

public ViewFormat getViewFormat()

Retrieves a ViewFormat object for tick labels. The ViewFormat objects allow you to format numbers.

Returns:

A ViewFormat object for tick labels.

setViewFormat

public void setViewFormat(ViewFormat viewFormat)

Specifies a ViewFormat object for tick labels. The ViewFormat objects allow you to format numbers.

Parameters:

viewFormat - A ViewFormat object for this label.

getNumberType

public int getNumberType()

Gets the type of number displayed in metric label.

Returns:

Integer representing the type of number intended for display in this gauge; valid values are constants in Gauge beginning with NT_

setNumberType

public void setNumberType(int type)

Sets the type of number to be displayed in metric label.

Parameters:

type - Integer representing the type of number intended for display in this gauge; valid values are constants in the Gauge class beginning with NT_

getPosition

public int getPosition()

Returns the position of the label.

Overrides:

getPosition in class BaseLabel

Returns:

the integer constant that represents where the label is placed. The following values are supported for all gauge types: GaugeAttributes.LP_NONE, GaugeAttributes.LP_BELOW_GAUGE, GaugeAttributes.LP_WITH_BOTTOM_LABEL, GaugeAttributes.LP_INSIDE_GAUGE. For statusmeter gauges, the following values are also supported: GaugeAttributes.LP_INSIDE_GAUGE_LEFT, GaugeAttributes.LP_INSIDE_GAUGE_RIGHT.

setPosition

public void setPosition(int position)

Specifies the position of the label.

Overrides:

setPosition in class BaseLabel

Parameters:

position - the integer constant that represents where the label is placed. The following values are supported for all gauge types: GaugeAttributes.LP_NONE, GaugeAttributes.LP_BELOW_GAUGE, GaugeAttributes.LP_WITH_BOTTOM_LABEL, GaugeAttributes.LP_INSIDE_GAUGE. For statusmeter gauges, the following values are also supported: GaugeAttributes.LP_INSIDE_GAUGE_LEFT, GaugeAttributes.LP_INSIDE_GAUGE_RIGHT.