oracle.dss.gauge
Class LabelGauge

java.lang.Object
  oracle.dss.gauge.GaugeType
      oracle.dss.gauge.LabelGauge

public class LabelGauge
extends GaugeType

Internal Use Only. This gauge type is intended for use exclusively by the DVT PivotTable component.

Since:

11.1

Field Summary

protected static int

GAP_GAUGESET_LABEL

Fields inherited from class oracle.dss.gauge.GaugeType

_bottomLabelBounds, _btmLblDim, _csParser, _engine, _gaugeBundle, _gaugeFrameBounds, _hasLowerReflection, _innerBounds, _layout, _lowerFrameDim, _lowerLabelFrameBounds, _metLblDim, _metricLabelBounds, _moveTransform, _scaleTransform, _titleSeparatorBounds, _topLabelBounds, _topLblDim, _upperFrameDim, _upperLabelFrameBounds, _utilBundle, DEF_TICK_LABEL, DIR_BOTTOM, DIR_LEFT, DIR_RIGHT, DIR_TOP, HEIGHT_LOWERLABELFRAME_REFLECTION, HEIGHT_TITLESEPARATOR, LABEL_SPACE, LED_GAUGESET_GAP, m_bBlended, m_locale, SHADOW_OFFSET, TICK_MARK_LENGTH

Constructor Summary

LabelGauge(GaugeEngine engine)

Method Summary

protected java.awt.Rectangle	_getPlotAreaBounds(java.awt.Rectangle gaugeFrameBounds, java.util.Map map, java.awt.Graphics2D g) Calculates and returns the bounding box of the plotArea.
protected java.awt.Dimension	autoLayout(java.awt.Graphics2D g, java.awt.Rectangle rect, java.util.Map map) Figures out the size of the gauge based on the size of each component.
protected java.util.Collection	getGaugeFrameObject(java.util.Map map) Generates the DrawableObject instances necessary to render the frame behind the gauge.
protected java.util.Collection	getGaugeLinkObject(java.util.Map map, java.awt.Rectangle outerBounds) Generates the DrawableObject instances necessary to render the frame behind the gauge.
protected int	getGaugeRadius(int availWidth, int availHeight) Allows a gauge type to determine the radius of the gauge.
protected int	getGaugeSetGap(java.util.Map map, java.awt.Graphics2D g, int dir) Returns the space between gauges in a gaugeSet, and the space bordering each gauge.
int	getGaugeType() Returns the type of this gauge type implementation.
protected java.util.Collection	getIndicatorObject(java.util.Map map, int metricIndex) Generates the DrawableObject instances necessary to render an Indicator.
protected java.awt.Rectangle	getInnerBounds(java.util.Map map, java.awt.Rectangle rect, int reqAboveSpace, int reqBelowSpace, int reqLeftSpace, int reqRightSpace) Allows a gauge type implementation to determine the area in which to draw the actual gauge.
protected java.util.Collection	getLabelObjects(java.util.Map map, java.awt.Rectangle outerBounds) Generates the DrawableObject instances necessary to render gauge labels.
protected int	getMaxNumberOfSteps() Allows a customization of the maximum number of steps to use for the tick labels and marks for this gauge type.
protected DrawableObject	getNoDataLabelObject(java.util.Map map) Generates the DrawableObject instances necessary to render a No Data label.
protected java.util.Collection	getPlotAreaObject(java.util.Map map, int type) Generates the DrawableObject instances necessary to render a PlotArea.
protected java.util.Collection	getTickLabelObjects(java.util.Map map) Generates the DrawableObject instances necessary to render Tick Labels.
protected java.util.Collection	getTickMarkObjects(java.util.Map map) Generates the DrawableObject instances necessary to render Tick Marks.

Methods inherited from class oracle.dss.gauge.GaugeType

_blendColors, _calcCustomShapesLabelBounds, _calcLabelDimensions, _getIndicatorColor, _getIndicatorColor, _getMetricLabelBounds, _getPlotAreaCenter, _getTopLabelBounds, _getUpperLabelFrameBounds, _hasGaugeFrame, createTickMark, getBackgroundObject, getFrameHeight, getOverlayEffectObjects, getScalingTransform, getScalingTransform, getSpaceAboveGauge, getSpaceBelowGauge, getSpaceLeftOfGauge, getSpaceRightOfGauge, getThresholdAttribute, getTickLabelWidth, getTranslateTransform, setCustomShapesParser, setLocale, updateResourceBundle

Methods inherited from class java.lang.Object

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

Field Detail

GAP_GAUGESET_LABEL

protected static final int GAP_GAUGESET_LABEL

See Also:

Constant Field Values

Constructor Detail

LabelGauge

public LabelGauge(GaugeEngine engine)

Method Detail

getGaugeType

public int getGaugeType()

Returns the type of this gauge type implementation.

Specified by:

getGaugeType in class GaugeType

Returns:

Integer representing the gauge type;

autoLayout

protected java.awt.Dimension autoLayout(java.awt.Graphics2D g,
                                        java.awt.Rectangle rect,
                                        java.util.Map map)

Figures out the size of the gauge based on the size of each component. Each gauge type will be responsible for determining this figure, which should include the total space taken up by the gauge, including any labels around it.

Overrides:

autoLayout in class GaugeType

Parameters:

rect - Rectangle in which to base the layout

map - attribute map

getLabelObjects

protected java.util.Collection getLabelObjects(java.util.Map map,
                                               java.awt.Rectangle outerBounds)

Generates the DrawableObject instances necessary to render gauge labels.

Overrides:

getLabelObjects in class GaugeType

Parameters:

map - Map of attributes for this gauge

outerBounds - Rectangle in which the entire gauge and surrounding objects are drawn

Returns:

DrawableObject instances

getPlotAreaObject

protected java.util.Collection getPlotAreaObject(java.util.Map map,
                                                 int type)

Generates the DrawableObject instances necessary to render a PlotArea.

Specified by:

getPlotAreaObject in class GaugeType

Parameters:

map - Map of attributes for this gauge

type - Type of plot area to generate. Can be FILL_ONLY, BORDER_ONLY, and FILL_AND_BORDER

Returns:

Array of DrawableObject instances

getIndicatorObject

protected java.util.Collection getIndicatorObject(java.util.Map map,
                                                  int metricIndex)

Generates the DrawableObject instances necessary to render an Indicator.

Specified by:

getIndicatorObject in class GaugeType

Parameters:

map - Map of attributes for this gauge

metricIndex - Index of the indicator

Returns:

Array of DrawableObject instances

getTickLabelObjects

protected java.util.Collection getTickLabelObjects(java.util.Map map)

Generates the DrawableObject instances necessary to render Tick Labels.

Specified by:

getTickLabelObjects in class GaugeType

Parameters:

map - Map of attributes for this gauge

Returns:

Array of DrawableObject instances

getTickMarkObjects

protected java.util.Collection getTickMarkObjects(java.util.Map map)

Generates the DrawableObject instances necessary to render Tick Marks.

Specified by:

getTickMarkObjects in class GaugeType

Parameters:

map - Map of attributes for this gauge

Returns:

Collection of DrawableObject instances

getNoDataLabelObject

protected DrawableObject getNoDataLabelObject(java.util.Map map)

Generates the DrawableObject instances necessary to render a No Data label.

Specified by:

getNoDataLabelObject in class GaugeType

Parameters:

map - Map of attributes for this gauge

Returns:

Array of DrawableObject instances

getGaugeFrameObject

protected java.util.Collection getGaugeFrameObject(java.util.Map map)

Generates the DrawableObject instances necessary to render the frame behind the gauge.

Specified by:

getGaugeFrameObject in class GaugeType

Parameters:

map - Map of attributes for this gauge

Returns:

Collection of DrawableObject instances

getGaugeLinkObject

protected java.util.Collection getGaugeLinkObject(java.util.Map map,
                                                  java.awt.Rectangle outerBounds)

Generates the DrawableObject instances necessary to render the frame behind the gauge.

Specified by:

getGaugeLinkObject in class GaugeType

Parameters:

map - Map of attributes for this gauge

outerBounds - Rectangle representing gauge and its background

Returns:

Collection of DrawableObject instances

getGaugeRadius

protected int getGaugeRadius(int availWidth,
                             int availHeight)

Allows a gauge type to determine the radius of the gauge.

Specified by:

getGaugeRadius in class GaugeType

Parameters:

availHeight - Integer representing the height available for drawing the actual gauge

availWidth - Integer representing the width available for drawing the actual gauge

Returns:

Integer representing the radius of the gauge.

getInnerBounds

protected java.awt.Rectangle getInnerBounds(java.util.Map map,
                                            java.awt.Rectangle rect,
                                            int reqAboveSpace,
                                            int reqBelowSpace,
                                            int reqLeftSpace,
                                            int reqRightSpace)

Allows a gauge type implementation to determine the area in which to draw the actual gauge.

Specified by:

getInnerBounds in class GaugeType

Parameters:

reqRightSpace - Integer indicating the space required to the right of the gauge

reqLeftSpace - Integer indicating the space required to the left of the gauge

reqBelowSpace - Integer indicating the space required below the gauge

reqAboveSpace - Integer indicating the space required above the gauge

rect - Rectangle indicating the initial working area

Returns:

Rectangle representing the area in which to draw the gauge

getMaxNumberOfSteps

protected int getMaxNumberOfSteps()

Allows a customization of the maximum number of steps to use for the tick labels and marks for this gauge type.

Specified by:

getMaxNumberOfSteps in class GaugeType

Returns:

Integer representing maximum number of tick steps

getGaugeSetGap

protected int getGaugeSetGap(java.util.Map map,
                             java.awt.Graphics2D g,
                             int dir)

Returns the space between gauges in a gaugeSet, and the space bordering each gauge.

Overrides:

getGaugeSetGap in class GaugeType

Parameters:

map - Map instance containing gauge attributes

g - Instance of Graphics2D to use for various font calculations

dir - int gap for which side of the gauge

Returns:

_getPlotAreaBounds

protected java.awt.Rectangle _getPlotAreaBounds(java.awt.Rectangle gaugeFrameBounds,
                                                java.util.Map map,
                                                java.awt.Graphics2D g)

Calculates and returns the bounding box of the plotArea. This method reserves space for everything inside the gaugeFrame, and returns the remaining box as the bounds of the plotArea.

Overrides:

_getPlotAreaBounds in class GaugeType

Parameters:

gaugeFrameBounds -

map -

Returns: