JRBaseMeterPlot (JasperReports 4.6.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.sf.jasperreports.charts.base
Class JRBaseMeterPlot

java.lang.Object
  net.sf.jasperreports.engine.base.JRBaseChartPlot
      net.sf.jasperreports.charts.base.JRBaseMeterPlot

All Implemented Interfaces:: Serializable, Cloneable, JRMeterPlot, JRChangeEventsSupport, JRChartPlot, JRCloneable

Direct Known Subclasses:: JRDesignMeterPlot

public class JRBaseMeterPlot
extends JRBaseChartPlot
implements JRMeterPlot
extends JRBaseChartPlot
implements JRMeterPlot

An immutable representation of the layout of a Meter chart.

Version:: $Id: JRBaseMeterPlot.java 5180 2012-03-29 13:23:12Z teodord $
Author:: Barry Klawans (bklawans@users.sourceforge.net)
See Also:: Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.jasperreports.engine.base.JRBaseChartPlot
`JRBaseChartPlot.JRBaseSeriesColor`

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

Field Summary
`protected JRDataRange`	`dataRange` The range displayed by the Meter.
`protected List<JRMeterInterval>`	`intervals` The defined intervals for the Meter.
`protected Integer`	`meterAngleInteger` The extend of the meter face in degrees.
`protected Color`	`meterBackgroundColor` The color to use for the face of the meter.
`protected Color`	`needleColor` The color to use for the pointer on the meter.
`protected MeterShapeEnum`	`shapeValue` The shape to use when drawing the Meter.
`protected Color`	`tickColor` The color to use for each tick on the face of the meter.
`protected Integer`	`tickCount` The number of major ticks on the meter scale.
`protected Double`	`tickIntervalDouble` How often to draw ticks around the face of the meter.
`protected JRFont`	`tickLabelFont` The font to use when writing tick labels.
`protected String`	`units` Optional description of what the meter is displaying.
`protected JRValueDisplay`	`valueDisplay` Formatting information for the textual display of the value.

Fields inherited from class net.sf.jasperreports.engine.base.JRBaseChartPlot
`backcolor, backgroundAlphaFloat, chart, foregroundAlphaFloat, labelRotationDouble, orientationValue, PROPERTY_BACKCOLOR, PROPERTY_BACKGROUND_ALPHA, PROPERTY_FOREGROUND_ALPHA, PROPERTY_LABEL_ROTATION, PROPERTY_ORIENTATION, PROPERTY_SERIES_COLORS, seriesColors`

Constructor Summary
`JRBaseMeterPlot(JRChartPlot plot, JRChart chart)` Constructs a copy of an existing meter.
`JRBaseMeterPlot(JRMeterPlot meterPlot, JRBaseObjectFactory factory)` Constructs a copy of an existing meter and registers all expressions maintained by the meter plot with a factory.

Method Summary
`Object`	`clone(JRChart parentChart)`
`void`	`collectExpressions(JRExpressionCollector collector)` Adds all the expression used by this plot with the specified collector.
`JRDataRange`	`getDataRange()` Returns the range of values that the Meter can display.
`List<JRMeterInterval>`	`getIntervals()` Returns a list of all the intervals contained in this Meter.
`Integer`	`getMeterAngleInteger()` Returns the size of the Meter face in degrees.
`Color`	`getMeterBackgroundColor()` Returns the background color of the meter.
`Color`	`getNeedleColor()` Returns the color used when drawing the meter's pointer.
`MeterShapeEnum`	`getShapeValue()` Returns the shape of the Meter.
`Color`	`getTickColor()` Returns the color used when drawing tick marks on the meter.
`Integer`	`getTickCount()` Returns the number of major ticks on the meter scale.
`Double`	`getTickIntervalDouble()` Returns the spacing between the ticks on the face of the meter.
`JRFont`	`getTickLabelFont()` Returns the font used to write tick labels on the meter.
`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 class net.sf.jasperreports.engine.base.JRBaseChartPlot
`addSeriesColor, clearSeriesColors, clone, getBackcolor, getBackgroundAlphaFloat, getChart, getEventSupport, getForegroundAlphaFloat, getLabelRotationDouble, getOrientation, getOrientationValue, getOwnBackcolor, getSeriesColors, setBackcolor, setBackgroundAlpha, setForegroundAlpha, setLabelRotation, setOrientation, setOrientation, setSeriesColors`

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

Methods inherited from interface net.sf.jasperreports.engine.JRChartPlot
`addSeriesColor, clearSeriesColors, getBackcolor, getBackgroundAlphaFloat, getChart, getForegroundAlphaFloat, getLabelRotationDouble, getOrientation, getOrientationValue, getOwnBackcolor, getSeriesColors, setBackcolor, setBackgroundAlpha, setForegroundAlpha, setLabelRotation, setOrientation, setOrientation, setSeriesColors`

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

Field Detail

dataRange

protected JRDataRange dataRange

The range displayed by the Meter.

valueDisplay

protected JRValueDisplay valueDisplay

Formatting information for the textual display of the value.

shapeValue

protected MeterShapeEnum shapeValue

The shape to use when drawing the Meter. Only applied if the meter is over 180 degrees wide and less than a full circle.

intervals

protected List<JRMeterInterval> intervals

The defined intervals for the Meter. Each interval indicates a subsection of the meter and a color to use for that section.

meterAngleInteger

protected Integer meterAngleInteger

The extend of the meter face in degrees. It will always be centered around the straight up position.

units

protected String units

Optional description of what the meter is displaying. It will be appended to the textual representation of the value.

tickIntervalDouble

protected Double tickIntervalDouble

How often to draw ticks around the face of the meter. The interval is relative to the meter range - if the meter displays 100 to 200 and the tickInterval is 20, there will be 4 ticks at 120, 140, 160 and 180.

meterBackgroundColor

protected Color meterBackgroundColor

The color to use for the face of the meter.

needleColor

protected Color needleColor

The color to use for the pointer on the meter.

tickColor

protected Color tickColor

The color to use for each tick on the face of the meter.

tickCount

protected Integer tickCount

The number of major ticks on the meter scale.

tickLabelFont

protected JRFont tickLabelFont

The font to use when writing tick labels.

Constructor Detail

JRBaseMeterPlot

public JRBaseMeterPlot(JRChartPlot plot,
                       JRChart chart)

Constructs a copy of an existing meter.

Parameters:: plot - the plot to copy

JRBaseMeterPlot

public JRBaseMeterPlot(JRMeterPlot meterPlot,
                       JRBaseObjectFactory factory)

Constructs a copy of an existing meter and registers all expressions maintained by the meter plot with a factory.

Parameters:: meterPlot - the meter to copy; factory - the factory to register expressions with

Method Detail