net.sf.jasperreports.charts
Interface JRThermometerPlot

All Superinterfaces:

java.lang.Cloneable, JRChartPlot, JRCloneable

All Known Implementing Classes:

JRBaseThermometerPlot, JRDesignThermometerPlot, JRFillThermometerPlot

public interface JRThermometerPlot
extends JRChartPlot

Represents the display options of a Thermometer chart. A Thermometer chart consists of the outline of a thermometer, a scale showing the reading of the thermometer, three optional ranges corresponding to "good", "warning" and "critical", and the textual display of the value.

Version:

$Id: JRThermometerPlot.java 3609 2010-03-23 09:01:15Z 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	LOCATION_BULB Deprecated. Replaced by ValueLocationEnum.BULB
static byte	LOCATION_LEFT Deprecated. Replaced by ValueLocationEnum.LEFT
static byte	LOCATION_NONE Deprecated. Replaced by ValueLocationEnum.NONE
static byte	LOCATION_RIGHT Deprecated. Replaced by ValueLocationEnum.RIGHT

Method Summary

JRDataRange	getDataRange() Returns the range of values displayed by this thermometer.
JRDataRange	getHighRange() Returns the high range, or null if undefined.
JRDataRange	getLowRange() Returns the low range, or null if undefined.
JRDataRange	getMediumRange() Returns the medium range, or null if undefined.
java.awt.Color	getMercuryColor() Returns the color of the "mercury" in the thermometer when the value is not in a defined range.
JRValueDisplay	getValueDisplay() Returns formatting information for the textual representation of the value.
byte	getValueLocation() Deprecated. Replaced by getValueLocationValue()
java.lang.Byte	getValueLocationByte() Deprecated. Replaced by getValueLocationValue()
ValueLocationEnum	getValueLocationValue() Returns the location where the value of the thermometer will be shown.
boolean	isShowValueLines() Deprecated. No longer used.

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

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

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

clone

Field Detail

LOCATION_NONE

static final byte LOCATION_NONE

Deprecated. Replaced by ValueLocationEnum.NONE

See Also:

Constant Field Values

LOCATION_LEFT

static final byte LOCATION_LEFT

Deprecated. Replaced by ValueLocationEnum.LEFT

See Also:

Constant Field Values

LOCATION_RIGHT

static final byte LOCATION_RIGHT

Deprecated. Replaced by ValueLocationEnum.RIGHT

See Also:

Constant Field Values

LOCATION_BULB

static final byte LOCATION_BULB

Deprecated. Replaced by ValueLocationEnum.BULB

See Also:

Constant Field Values

Method Detail

getDataRange

JRDataRange getDataRange()

Returns the range of values displayed by this thermometer. This range corresponds with the scale on the thermometer.

Returns:

the range of values displayed by this thermometer

getValueDisplay

JRValueDisplay getValueDisplay()

Returns formatting information for the textual representation of the value.

Returns:

formatting information for the value

isShowValueLines

boolean isShowValueLines()

Deprecated. No longer used.

getValueLocation

byte getValueLocation()

Deprecated. Replaced by getValueLocationValue()

getValueLocationByte

java.lang.Byte getValueLocationByte()

Deprecated. Replaced by getValueLocationValue()

getValueLocationValue

ValueLocationEnum getValueLocationValue()

Returns the location where the value of the thermometer will be shown. The return value will be one of net.sf.jasperreports.charts.type.ValueLocationEnum.NONE, net.sf.jasperreports.charts.type.ValueLocationEnum.LEFT, net.sf.jasperreports.charts.type.ValueLocationEnum.RIGHT or net.sf.jasperreports.charts.type.ValueLocationEnum.BULB.

Returns:

the location where the value of the thermometer will be shown

getMercuryColor

java.awt.Color getMercuryColor()

Returns the color of the "mercury" in the thermometer when the value is not in a defined range.

Returns:

the default color of the mercury in the thermometer

getLowRange

JRDataRange getLowRange()

Returns the low range, or null if undefined.

Returns:

the low range, or null if undefined.

getMediumRange

JRDataRange getMediumRange()

Returns the medium range, or null if undefined.

Returns:

the medium range, or null if undefined.

getHighRange

JRDataRange getHighRange()

Returns the high range, or null if undefined.

Returns:

the high range, or null if undefined.