oracle.dss.gauge
Class LegendArea

java.lang.Object
  oracle.dss.gauge.BaseGaugeComponent
      oracle.dss.gauge.BaseFrame
          oracle.dss.gauge.LegendArea

public class LegendArea
extends BaseFrame

Since:

11.0

Field Summary

Fields inherited from class oracle.dss.gauge.BaseFrame

m_borderColorKey, m_defaultBorderColor, m_defaultFillColor, m_defaultVisible, m_fillColorKey, m_isGaugeSetComponent, m_sfx, m_sfxID, m_visibleKey

Fields inherited from class oracle.dss.gauge.BaseGaugeComponent

m_commonGauge, m_compType

Constructor Summary

LegendArea(CommonGauge gauge)

Method Summary

static int	convertPositionToInt(java.lang.String position)
static java.lang.String	convertPositionToString(int position)
int	getPosition() Gets the position of the legend.
void	setPosition(int position) Sets the position of the metric label.

Methods inherited from class oracle.dss.gauge.BaseFrame

getBorderColor, getFillColor, getSFX, isVisible, setBorderColor, setFillColor, setVisible

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

LegendArea

public LegendArea(CommonGauge gauge)

Method Detail

getPosition

public int getPosition()

Gets the position of the legend.

Returns:

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

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 the Gauge class starting with LAP_.

convertPositionToInt

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

For internal use only. Application developers should not use this

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

convertPositionToString

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

For internal use only. Application developers should not use this

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