oracle.dss.gauge
Class StatusMeterGauge

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

public class StatusMeterGauge
extends GaugeType

Since:

11.0

Field Summary

Fields inherited from class oracle.dss.gauge.GaugeType

_bottomLabelBounds, _btmLblDim, _csParser, _engine, _gaugeBundle, _gaugeFrameBounds, _hasLowerReflection, _innerBounds, _lowerFrameDim, _lowerLabelFrameBounds, _metLblDim, _metricLabelBounds, _moveTransform, _scaleTransform, _titleSeparatorBounds, _topLabelBounds, _topLblDim, _upperFrameDim, _upperLabelFrameBounds, _utilBundle, DEF_TICK_LABEL, DIR_BOTTOM, DIR_LEFT, DIR_RIGHT, DIR_TOP, GAP_GAUGEFRAME_LOWERLABELFRAME, GAP_GAUGESET_BOTTOM, GAP_GAUGESET_LEFT, GAP_GAUGESET_RIGHT, GAP_GAUGESET_TOP, GAP_LOWERLABELFRAME_REFLECTION, GAP_TITLESEPARATOR_GAUGEFRAME, GAP_TOPLABEL_TITLESEPARATOR, GAUGESET_GAP, HEIGHT_LOWERLABELFRAME_REFLECTION, HEIGHT_TITLESEPARATOR, HORIZONTAL_GAP, LABEL_SPACE, LED_GAUGESET_GAP, m_bBlended, m_locale, SHADOW_OFFSET, TICK_MARK_LENGTH, VERTICAL_GAP

Constructor Summary

StatusMeterGauge(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.util.Collection	_getThresholdObjects(java.util.Map map, java.awt.geom.Area plotAreaMask) Generates the DrawableObject instances necessary to render an Threshold.
protected void	createTickMarkObjects(java.util.List<DrawableObject> objects, java.util.Map map, int tickMarkType, double yPos) Generates the DrawableObject instances necessary to render a specific set of Tick Marks, based on the given tick mark type.
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.
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 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	getOverlayEffectObjects(java.util.Map map) Generates the DrawableObject instances for any overlay effects on the gauge.
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, _calcGaugeFrameBounds, _calcLabelDimensions, _getBottomLabelBounds, _getGaugeFrameBounds, _getIndicatorColor, _getIndicatorColor, _getLowerLabelFrameBounds, _getMetricLabelBounds, _getPlotAreaCenter, _getTopLabelBounds, _getUpperLabelFrameBounds, _hasGaugeFrame, _reserveLabelSpaceBelowGaugeFrame, autoLayout, createTickMark, getBackgroundObject, getFrameHeight, getGaugeSetGap, getLabelObjects, getScalingTransform, getScalingTransform, getSpaceAboveGauge, getSpaceBelowGauge, getSpaceBelowPlotArea, getSpaceLeftOfGauge, getSpaceRightOfGauge, getTextShadow, getThresholdAttribute, getTickLabelWidth, getTranslateTransform, setCustomShapesParser, setLocale, updateResourceBundle

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusMeterGauge

public StatusMeterGauge(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; valid constants are those in this class beginning with TYPE_.

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:

Collection 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:

Collection of DrawableObject instances

_getThresholdObjects

protected java.util.Collection _getThresholdObjects(java.util.Map map,
                                                    java.awt.geom.Area plotAreaMask)

Generates the DrawableObject instances necessary to render an Threshold.

Parameters:

map - Map of attributes for this gauge

plotAreaMask - a shape within which to draw the thresholds

Returns:

Collection of DrawableObject instances

getOverlayEffectObjects

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

Generates the DrawableObject instances for any overlay effects on the gauge.

Overrides:

getOverlayEffectObjects in class GaugeType

Parameters:

map - Map of attributes for this gauge

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:

Collection 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

createTickMarkObjects

protected void createTickMarkObjects(java.util.List<DrawableObject> objects,
                                     java.util.Map map,
                                     int tickMarkType,
                                     double yPos)

Generates the DrawableObject instances necessary to render a specific set of Tick Marks, based on the given tick mark type.

Parameters:

objects - the List of DrawableObjects to add the tick marks into

map - Map of attributes for this gauge

tickMarkType - Type of tick mark. Can be TC_MIN_MAX, TC_INCREMENTS, TC_THRESHOLD, or TC_METRIC from the GaugeAttributes class.

yPos - double y-coordinate where the tickMark starts

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

_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:

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

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