Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 1 (11.1.1.0.0)

E12063-01


oracle.dss.gauge
Class DialGauge

java.lang.Object
  extended by oracle.dss.gauge.GaugeType
      extended by oracle.dss.gauge.DialGauge


public class DialGauge
extends GaugeType

This implementation of GaugeType represents a dial gauge.


Field Summary
protected static int GAUGEFRAME_GAP
           

 

Fields inherited from class oracle.dss.gauge.GaugeType
_bottomLabelBounds, _btmLblDim, _csParser, _engine, _gaugeFrameBounds, _hasLowerReflection, _innerBounds, _lowerFrameDim, _lowerLabelFrameBounds, _metLblDim, _metricLabelBounds, _moveTransform, _scaleTransform, _titleSeparatorBounds, _topLabelBounds, _topLblDim, _upperFrameDim, _upperLabelFrameBounds, 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, SHADOW_OFFSET, TICK_MARK_LENGTH, VERTICAL_GAP

 

Constructor Summary
DialGauge(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  int _getPlotAreaCenter(java.util.Map map)
           
protected  java.util.Collection _getThresholdObjects(java.util.Map map)
          Generates the DrawableObject instances necessary to render an Threshold.
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.awt.geom.GeneralPath convertShapeToPath(java.awt.geom.GeneralPath path, java.awt.geom.Arc2D shape, java.awt.geom.Arc2D shape2)
           
protected  int getAngleExtent()
           
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)
          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 getPlotAreaObject(java.util.Map map, int type)
          Generates the DrawableObject instances necessary to render a PlotArea.
protected  int getSpaceAroundGauge(java.util.Map map, java.awt.Graphics2D g)
          Returns the space in pixels around the gauge and within the gaugeFrame for a full circle gauge with gaugeFrame.
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
_addObjects, _blendColors, _calcCustomShapesLabelBounds, _calcGaugeFrameBounds, _calcLabelDimensions, _getBottomLabelBounds, _getGaugeFrameBounds, _getIndicatorColor, _getLowerLabelFrameBounds, _getMetricLabelBounds, _getTopLabelBounds, _getUpperLabelFrameBounds, _hasGaugeFrame, _reserveLabelSpaceBelowGaugeFrame, getBackgroundObject, getFrameHeight, getGaugeSetGap, getLabelObjects, getOverlayEffectObjects, getScalingTransform, getSpaceAboveGauge, getSpaceBelowGauge, getSpaceBelowPlotArea, getSpaceLeftOfGauge, getSpaceRightOfGauge, getTextShadow, getThresholdAttribute, getTickLabelWidth, getTickMarkObject, getTranslateTransform, setCustomShapesParser

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

GAUGEFRAME_GAP

protected static final int GAUGEFRAME_GAP
See Also:
Constant Field Values

Constructor Detail

DialGauge

public DialGauge(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_.

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

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)
Generates the DrawableObject instances necessary to render an Indicator.
Specified by:
getIndicatorObject in class GaugeType
Parameters:
map - Map of attributes for this gauge
Returns:
Collection of DrawableObject instances

_getThresholdObjects

protected java.util.Collection _getThresholdObjects(java.util.Map map)
Generates the DrawableObject instances necessary to render an Threshold.
Parameters:
map - Map of attributes for this gauge
Returns:
Collection 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

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

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

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

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)
Description copied from class: GaugeType
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

getSpaceAroundGauge

protected int getSpaceAroundGauge(java.util.Map map,
                                  java.awt.Graphics2D g)
Returns the space in pixels around the gauge and within the gaugeFrame for a full circle gauge with gaugeFrame.
Parameters:
map -
g -
Returns:

_getPlotAreaCenter

protected int _getPlotAreaCenter(java.util.Map map)
Overrides:
_getPlotAreaCenter in class GaugeType

getAngleExtent

protected int getAngleExtent()

convertShapeToPath

protected java.awt.geom.GeneralPath convertShapeToPath(java.awt.geom.GeneralPath path,
                                                       java.awt.geom.Arc2D shape,
                                                       java.awt.geom.Arc2D shape2)

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 1 (11.1.1.0.0)

E12063-01


Copyright © 1997, 2008, Oracle. All rights reserved.