Package net.simplace.core.ui.jfreechart

Class BasicChartStyle

java.lang.Object

net.simplace.core.ui.jfreechart.AbstractChartStyle

net.simplace.core.ui.jfreechart.BasicChartStyle

All Implemented Interfaces:

ChartStyle

public class BasicChartStyle
extends AbstractChartStyle

This class provides a basis chart style for line, area an bar charts.

Version:

1.0

Author:

Martin Schmitz

Nested Class Summary

Nested classes/interfaces inherited from interface net.simplace.core.ui.jfreechart.ChartStyle

ChartStyle.ChartType

Field Summary

Fields

Modifier and Type	Field	Description
protected org.jfree.chart.plot.PlotOrientation	iOrientation	Stores the orientation of the chart.
protected boolean	iStacked	Stores whether the chart is stacked.
protected boolean	iStepped	Stores whether the chart is stepped.

Fields inherited from class net.simplace.core.ui.jfreechart.AbstractChartStyle

iLegend, iObservable, iTitle, iTooltips, iType, iURLs, iXAxisTitle, iYAxisTitle

Constructor Summary

Constructors

Constructor	Description
BasicChartStyle()	Creates a normal line style with default values.
BasicChartStyle(ChartStyle.ChartType aType)	Creates a normal, vertical line, bar or area style.
BasicChartStyle(ChartStyle.ChartType aType, boolean aStacked, boolean aStepped, org.jfree.chart.plot.PlotOrientation aOrientation)	Creates a line, area or bar chart style.
BasicChartStyle(ChartStyle.ChartType aType, boolean aStacked, boolean aStepped, org.jfree.chart.plot.PlotOrientation aOrientation, String aTitle, String aXTitle, String aYTitle, boolean aLegend, boolean aTooltips, boolean aURLs)	Creates a chart style.

Method Summary

Modifier and Type	Method	Description
org.jfree.chart.JFreeChart	applyToDataset(List<org.jfree.data.general.Dataset> aDataset)	Generates a chart using the given data and the style represented by this class.
org.jfree.chart.plot.PlotOrientation	getOrientation()	Returns the orientation of the chart.
boolean	isStacked()	Returns whether the chart is stacked.
boolean	isStepped()	Returns whether the chart is stepped.
void	setOrientation(org.jfree.chart.plot.PlotOrientation aOrientation)	Sets the orientation of the chart.
void	setStacked(boolean aStacked)	Sets whether the chart is stacked.
void	setStepped(boolean aStepped)	Sets whether the chart is stepped.
void	setType(ChartStyle.ChartType aType)	Sets the type of the chart style.

Methods inherited from class net.simplace.core.ui.jfreechart.AbstractChartStyle

getTitle, getType, getXAxisTitle, getYAxisTitle, hasLegend, hasTooltips, hasURLs, setLegend, setObservable, setTitle, setTooltips, setURLs, setXAxisTitle, setYAxisTitle

Methods inherited from class java.lang.Object

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

Field Details

iOrientation

protected org.jfree.chart.plot.PlotOrientation iOrientation

Stores the orientation of the chart.

iStacked

protected boolean iStacked

Stores whether the chart is stacked. Line charts can never be stacked.

iStepped

protected boolean iStepped

Stores whether the chart is stepped. Bar charts are always stepped.

Constructor Details

BasicChartStyle

public BasicChartStyle()

Creates a normal line style with default values.

BasicChartStyle

public BasicChartStyle(ChartStyle.ChartType aType)

Creates a normal, vertical line, bar or area style.

Parameters:

aType - type of the chart layout

BasicChartStyle

public BasicChartStyle(ChartStyle.ChartType aType,
 boolean aStacked,
 boolean aStepped,
 org.jfree.chart.plot.PlotOrientation aOrientation)

Creates a line, area or bar chart style.

Parameters:

aType - style type

aStacked - flag whether the chart is stacked (ignored for line charts)

aStepped - flag whether the chart is stepped (ignored for bar charts)

aOrientation - orientation of the chart (PlotOrientation.VERTICAL or PlotOrientation.HORIZONTAL)

BasicChartStyle

public BasicChartStyle(ChartStyle.ChartType aType,
 boolean aStacked,
 boolean aStepped,
 org.jfree.chart.plot.PlotOrientation aOrientation,
 String aTitle,
 String aXTitle,
 String aYTitle,
 boolean aLegend,
 boolean aTooltips,
 boolean aURLs)

Creates a chart style.

Parameters:

aType - style type

aStacked - flag whether the chart is stacked (ignored for line charts)

aStepped - flag whether the chart is stepped (ignored for bar charts)

aOrientation - orientation of the chart (PlotOrientation.VERTICAL or PlotOrientation.HORIZONTAL)

aTitle - title for the chart

aXTitle - title for the chart's X-axis

aYTitle - title for the chart's Y-axis

aLegend - flag whether a legend is generated

aTooltips - flag whether toolstips are generated

aURLs - flag whether URLs are generated

Method Details

setType

public void setType(ChartStyle.ChartType aType)

Sets the type of the chart style.

Overrides:

setType in class AbstractChartStyle

Parameters:

aType - the chart type

Throws:

IllegalArgumentException - if aType is not of ChartStyle.ChartType.LINE, ChartStyle.ChartType.AREA or ChartStyle.ChartType.BAR

isStacked

public boolean isStacked()

Returns whether the chart is stacked.

Returns:

false for line charts

setStacked

public void setStacked(boolean aStacked)

Sets whether the chart is stacked. Sets the iStacked property to false for line charts, even aStacked is true.

Parameters:

aStacked -

isStepped

public boolean isStepped()

Returns whether the chart is stepped.

Returns:

true for bar charts

setStepped

public void setStepped(boolean aStepped)

Sets whether the chart is stepped. Sets the iStepped property to true for bar charts, even aStepped is false.

Parameters:

aStepped -

getOrientation

public org.jfree.chart.plot.PlotOrientation getOrientation()

Returns the orientation of the chart.

Returns:

setOrientation

public void setOrientation(org.jfree.chart.plot.PlotOrientation aOrientation)

Sets the orientation of the chart.

Parameters:

aOrientation -

applyToDataset

public org.jfree.chart.JFreeChart applyToDataset(List<org.jfree.data.general.Dataset> aDataset)

Generates a chart using the given data and the style represented by this class.

Parameters:

aDataset - the data for the chart

Returns:

JFreeChart

Throws:

UnsupportedOperationException - if the style can not be applied to the given dataset