Package net.sf.jasperreports.charts.base

Class JRBaseChartPlot

java.lang.Object

net.sf.jasperreports.charts.base.JRBaseChartPlot

All Implemented Interfaces:

Serializable, Cloneable, JRChartPlot, JRChangeEventsSupport, JRCloneable

Direct Known Subclasses:

JRBaseAreaPlot, JRBaseBarPlot, JRBaseBubblePlot, JRBaseCandlestickPlot, JRBaseHighLowPlot, JRBaseLinePlot, JRBaseMeterPlot, JRBaseMultiAxisPlot, JRBasePiePlot, JRBaseScatterPlot, JRBaseThermometerPlot, JRBaseTimeSeriesPlot

public abstract class JRBaseChartPlot
extends Object
implements JRChartPlot, Serializable, JRChangeEventsSupport

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JRBaseChartPlot.JRBaseSeriesColor

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

JRChartPlot.JRSeriesColor

Field Summary

Fields

Modifier and Type	Field	Description
protected Color	backcolor
protected Float	backgroundAlpha
protected JRChart	chart
protected Float	foregroundAlpha
protected Double	labelRotation
protected PlotOrientationEnum	orientation
static String	PROPERTY_BACKCOLOR
static String	PROPERTY_BACKGROUND_ALPHA
static String	PROPERTY_FOREGROUND_ALPHA
static String	PROPERTY_LABEL_ROTATION
static String	PROPERTY_ORIENTATION
static String	PROPERTY_SERIES_COLORS
protected SortedSet<JRChartPlot.JRSeriesColor>	seriesColors

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JRBaseChartPlot(JRChartPlot plot, ChartsBaseObjectFactory factory)
protected	JRBaseChartPlot(JRChartPlot plot, JRChart chart)

Method Summary

Modifier and Type	Method	Description
void	addSeriesColor(JRChartPlot.JRSeriesColor seriesColor)	Adds the specified series color to the plot.
void	clearSeriesColors()	Removes all defined series colors.
Object	clone()
Object	clone(JRChart parentChart)
Color	getBackcolor()	Gets the chart background color.
Float	getBackgroundAlpha()	Gets the transparency factor for this plot background.
JRChart	getChart()	Gets the chart associated with this chart plot, if available.
JRPropertyChangeSupport	getEventSupport()	Returns the property change support object for this instance.
Float	getForegroundAlpha()	Gets the transparency factor for this plot foreground.
Double	getLabelRotation()	Deprecated. Replaced by JRCategoryAxisFormat.getCategoryAxisTickLabelRotation().
PlotOrientationEnum	getOrientation()	Gets the plot orientation (horizontal or vertical).
Color	getOwnBackcolor()
SortedSet<JRChartPlot.JRSeriesColor>	getSeriesColors()	Returns a list of all the defined series colors.
protected ChartsStyleResolver	getStyleResolver()
void	setBackcolor(Color backcolor)	Sets the chart background color.
void	setBackgroundAlpha(Float backgroundAlpha)	Sets the transparency factor for this plot background.
void	setForegroundAlpha(Float foregroundAlpha)	Sets the transparency factor for this plot foreground.
void	setLabelRotation(Double labelRotation)	Deprecated. Replaced by JRCategoryAxisFormat.setCategoryAxisTickLabelRotation(Double).
void	setOrientation(PlotOrientationEnum orientation)	Sets the plot orientation (horizontal or vertical).
void	setSeriesColors(Collection<JRChartPlot.JRSeriesColor> colors)	Set the list of series colors.

Methods inherited from class java.lang.Object

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

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

collectExpressions

Field Detail

PROPERTY_BACKCOLOR

public static final String PROPERTY_BACKCOLOR

See Also:

Constant Field Values

PROPERTY_BACKGROUND_ALPHA

public static final String PROPERTY_BACKGROUND_ALPHA

See Also:

Constant Field Values

PROPERTY_FOREGROUND_ALPHA

public static final String PROPERTY_FOREGROUND_ALPHA

See Also:

Constant Field Values

PROPERTY_LABEL_ROTATION

public static final String PROPERTY_LABEL_ROTATION

See Also:

Constant Field Values

PROPERTY_ORIENTATION

public static final String PROPERTY_ORIENTATION

See Also:

Constant Field Values

PROPERTY_SERIES_COLORS

public static final String PROPERTY_SERIES_COLORS

See Also:

Constant Field Values

chart

protected JRChart chart

backcolor

protected Color backcolor

orientation

protected PlotOrientationEnum orientation

backgroundAlpha

protected Float backgroundAlpha

foregroundAlpha

protected Float foregroundAlpha

labelRotation

protected Double labelRotation

seriesColors

protected SortedSet<JRChartPlot.JRSeriesColor> seriesColors

Constructor Detail

JRBaseChartPlot

protected JRBaseChartPlot(JRChartPlot plot,
                          JRChart chart)

JRBaseChartPlot

protected JRBaseChartPlot(JRChartPlot plot,
                          ChartsBaseObjectFactory factory)

Method Detail

getStyleResolver

protected ChartsStyleResolver getStyleResolver()

getChart

public JRChart getChart()

Description copied from interface: JRChartPlot

Gets the chart associated with this chart plot, if available. Implementations can return null on this method, especially if the chart plot is reused by multiple charts, which is not recommended since it prevents style properties inheritence from parent chart.

Specified by:

getChart in interface JRChartPlot

getBackcolor

public Color getBackcolor()

Description copied from interface: JRChartPlot

Gets the chart background color.

Specified by:

getBackcolor in interface JRChartPlot

getOwnBackcolor

public Color getOwnBackcolor()

Specified by:

getOwnBackcolor in interface JRChartPlot

setBackcolor

public void setBackcolor(Color backcolor)

Description copied from interface: JRChartPlot

Sets the chart background color.

Specified by:

setBackcolor in interface JRChartPlot

getOrientation

public PlotOrientationEnum getOrientation()

Description copied from interface: JRChartPlot

Gets the plot orientation (horizontal or vertical).

Specified by:

getOrientation in interface JRChartPlot

setOrientation

public void setOrientation(PlotOrientationEnum orientation)

Description copied from interface: JRChartPlot

Sets the plot orientation (horizontal or vertical).

Specified by:

setOrientation in interface JRChartPlot

getBackgroundAlpha

public Float getBackgroundAlpha()

Description copied from interface: JRChartPlot

Gets the transparency factor for this plot background. The range is from 0 to 1, where 0 means transparent and 1 opaque. The default is 1.

Specified by:

getBackgroundAlpha in interface JRChartPlot

Returns:

a float value between 0 and 1.

setBackgroundAlpha

public void setBackgroundAlpha(Float backgroundAlpha)

Description copied from interface: JRChartPlot

Sets the transparency factor for this plot background. The range is from 0 to 1, where 0 means transparent and 1 opaque. The default is 1.

Specified by:

setBackgroundAlpha in interface JRChartPlot

getForegroundAlpha

public Float getForegroundAlpha()

Description copied from interface: JRChartPlot

Gets the transparency factor for this plot foreground. The range is from 0 to 1, where 0 means transparent and 1 opaque. The default is 1.

Specified by:

getForegroundAlpha in interface JRChartPlot

Returns:

a float value between 0 and 1.

setForegroundAlpha

public void setForegroundAlpha(Float foregroundAlpha)

Description copied from interface: JRChartPlot

Sets the transparency factor for this plot foreground. The range is from 0 to 1, where 0 means transparent and 1 opaque. The default is 1.

Specified by:

setForegroundAlpha in interface JRChartPlot

getLabelRotation

public Double getLabelRotation()

Deprecated.

Replaced by JRCategoryAxisFormat.getCategoryAxisTickLabelRotation().

Gets the angle in degrees to rotate the data axis labels. The range is -360 to 360. A positive value angles the label so it reads downwards wile a negative value angles the label so it reads upwards. Only charts that use a category based axis (such as line or bar charts) support label rotation.

Specified by:

getLabelRotation in interface JRChartPlot

setLabelRotation

public void setLabelRotation(Double labelRotation)

Deprecated.

Replaced by JRCategoryAxisFormat.setCategoryAxisTickLabelRotation(Double).

Sets the angle in degrees to rotate the data axis labels. The range is -360 to 360. A positive value angles the label so it reads downwards wile a negative value angles the label so it reads upwards. Only charts that use a category based axis (such as line or bar charts) support label rotation.

Specified by:

setLabelRotation in interface JRChartPlot

getSeriesColors

public SortedSet<JRChartPlot.JRSeriesColor> getSeriesColors()

Returns a list of all the defined series colors. Every entry in the list is of type JRChartPlot.JRSeriesColor. If there are no defined series colors this method will return an empty list, not null.

Specified by:

getSeriesColors in interface JRChartPlot

clearSeriesColors

public void clearSeriesColors()

Removes all defined series colors.

Specified by:

clearSeriesColors in interface JRChartPlot

addSeriesColor

public void addSeriesColor(JRChartPlot.JRSeriesColor seriesColor)

Adds the specified series color to the plot.

Specified by:

addSeriesColor in interface JRChartPlot

setSeriesColors

public void setSeriesColors(Collection<JRChartPlot.JRSeriesColor> colors)

Description copied from interface: JRChartPlot

Set the list of series colors.

Specified by:

setSeriesColors in interface JRChartPlot

Parameters:

colors - the list of series colors (JRChartPlot.JRSeriesColor instances}

clone

public Object clone()

Specified by:

clone in interface JRCloneable

Overrides:

clone in class Object

clone

public Object clone(JRChart parentChart)

Specified by:

clone in interface JRChartPlot

getEventSupport

public JRPropertyChangeSupport getEventSupport()

Description copied from interface: JRChangeEventsSupport

Returns the property change support object for this instance.

Specified by:

getEventSupport in interface JRChangeEventsSupport

Returns:

the property change support object for this instance