net.sf.jasperreports.charts
Interface JRMeterPlot

All Superinterfaces:

JRChartPlot

All Known Implementing Classes:

JRBaseMeterPlot, JRDesignMeterPlot, JRFillMeterPlot

public interface JRMeterPlot
extends JRChartPlot

Represents the display options of a Meter Chart. A meter chart consists of a dial, a needle pointing to the current value on the dial, and the value itself. The Meter can be broken up into shaded regions to highlight portions of the range.

Version:

$Id: JRMeterPlot.java 1792 2007-07-30 08:57:32Z teodord $

Author:

Barry Klawans (bklawans@users.sourceforge.net)

Nested Class Summary

Nested classes/interfaces inherited from interface net.sf.jasperreports.engine.JRChartPlot

JRChartPlot.JRSeriesColor

Field Summary

static byte	SHAPE_CHORD The portion of the circle described by the Meter that is not occupied by the Meter is drawn as a chord.
static byte	SHAPE_CIRCLE The portion of the circle described by the Meter that is not occupied by the Meter is drawn as a circle.
static byte	SHAPE_PIE The portion of the circle described by the Meter that is not occupied by the Meter is not drawn.

Method Summary

JRDataRange	getDataRange() Returns the range of values that the Meter can display.
java.util.List	getIntervals() Returns a list of all the intervals contained in this Meter.
int	getMeterAngle() Returns the size of the Meter face in degrees.
java.awt.Color	getMeterBackgroundColor() Returns the background color of the meter.
java.awt.Color	getNeedleColor() Returns the color used when drawing the meter's pointer.
byte	getShape() Returns the shape of the Meter.
java.awt.Color	getTickColor() Returns the color used when drawing tick marks on the meter.
double	getTickInterval() Returns the spacing between the ticks on the face of the meter.
java.lang.String	getUnits() Returns the name of the units that the Meter is displaying.
JRValueDisplay	getValueDisplay() Returns a description of how the value of the Meter is displayed.

Methods inherited from interface net.sf.jasperreports.engine.JRChartPlot

addSeriesColor, clearSeriesColors, clone, collectExpressions, getBackcolor, getBackgroundAlpha, getChart, getForegroundAlpha, getLabelRotation, getOrientation, getOwnBackcolor, getSeriesColors, setBackcolor, setBackgroundAlpha, setForegroundAlpha, setLabelRotation, setOrientation, setSeriesColors

Field Detail

SHAPE_CHORD

static final byte SHAPE_CHORD

The portion of the circle described by the Meter that is not occupied by the Meter is drawn as a chord. (A straight line connects the ends.)

See Also:

Constant Field Values

SHAPE_CIRCLE

static final byte SHAPE_CIRCLE

The portion of the circle described by the Meter that is not occupied by the Meter is drawn as a circle.

See Also:

Constant Field Values

SHAPE_PIE

static final byte SHAPE_PIE

The portion of the circle described by the Meter that is not occupied by the Meter is not drawn.

See Also:

Constant Field Values

Method Detail

getDataRange

JRDataRange getDataRange()

Returns the range of values that the Meter can display.

Returns:

the range of values that the Meter can display

getValueDisplay

JRValueDisplay getValueDisplay()

Returns a description of how the value of the Meter is displayed. This includes any font and color information, the location of the value, a formatting mask and an optional "units" string to append to the value.

Returns:

a description of how the value of the Meter is displayed.

getShape

byte getShape()

Returns the shape of the Meter. The shape is only relevant if the Meter face is over 180 degrees wide, and controls how the portiong of the circle described by the Meter but outside of the Meter is drawn. (If the meter is 240 degrees wide the shape setting controls how the remaining 120 degrees is displayed.)

The value returned is one of the SHAPE_ constants defined in this class.

Returns:

a description of how the value of the Meter is displayed.

getIntervals

java.util.List getIntervals()

Returns a list of all the intervals contained in this Meter. The return value is never null but can be an empty list. Each element in the list is a net.sf.jasperreports.charts.util.JRMeterInterval

Returns:

a list of all the intervals contained in this Meter

getMeterAngle

int getMeterAngle()

Returns the size of the Meter face in degrees.

Returns:

the size of the Meter face in degrees

getUnits

java.lang.String getUnits()

Returns the name of the units that the Meter is displaying. This value will be appended to the value when displayed.

Returns:

the name of the units that the Meter is displaying

getTickInterval

double getTickInterval()

Returns the spacing between the ticks on the face of the meter. The spacing is relative to the range that the meter is displaying - if the range is 0 to 500 and the tick interval is 50 then 10 ticks will be displayed.

Returns:

the spacing between the ticks on the face of the meter

getMeterBackgroundColor

java.awt.Color getMeterBackgroundColor()

Returns the background color of the meter. This is the color of the meter's face.

Returns:

the background color of the meter.

getNeedleColor

java.awt.Color getNeedleColor()

Returns the color used when drawing the meter's pointer.

Returns:

the color used when drawing the meter's pointer

getTickColor

java.awt.Color getTickColor()

Returns the color used when drawing tick marks on the meter.

Returns:

the color used when drawing tick marks on the meter