org.odftoolkit.simple.chart

Class Chart

java.lang.Object

org.odftoolkit.simple.chart.Chart

public class Chart
extends Object

Chart represents the chart feature of the ODF document. Chart provides methods to get/set chart title, get/set chart data, etc.

Since:

0.6

Method Summary

Modifier and Type	Method and Description
String	getAxisTitle(String dimType) chart axis manipulation, temporarily only consider the axis title
DataSet	getChartData() chart data manipulation, get the chart data
String	getChartID() chart id manipulation, get the current chart id
String	getChartTitle() chart title manipulation, get the current chart title
ChartType	getChartType() chart type manipulation, get the current chart type
boolean	IsApply3DEffect() 3D effect manipulation, get whether the chart apples 3D effect
boolean	isUseLegend() chart legend manipulation
void	refreshChart() Refresh chart view and data setting.
void	setApply3DEffect(boolean _3deffect) 3D effect manipulation, set to apply 3D effect
void	setAxisTitle(String dimType, String title) chart axis manipulation, set the chart axis title according to the give dimension
void	setChartData(DataSet dataset) chart data manipulation, set chart data
boolean	setChartTitle(String title) chart title manipulation, get the current chart title
void	setChartType(ChartType type) chart type manipulation, set a chart type when chart type is changed, all the corresponding chart behaviors and properties should be changed accordingly
void	setUseLegend(boolean useLegend) chart legend manipulation, get whether the chart use legend

Methods inherited from class java.lang.Object

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

Method Detail

IsApply3DEffect

public boolean IsApply3DEffect()

3D effect manipulation, get whether the chart apples 3D effect

Returns:

return true if the chart is applied 3D effect

getAxisTitle

public String getAxisTitle(String dimType)

chart axis manipulation, temporarily only consider the axis title

Parameters:

dimType - the chart axis dimension, x, y or z

Returns:

return axis title according to the given dimension,null if the specific dimensional axis has no title

getChartData

public DataSet getChartData()

chart data manipulation, get the chart data

Returns:

return the chart data

getChartTitle

public String getChartTitle()

chart title manipulation, get the current chart title

Returns:

return the chart title

getChartType

public ChartType getChartType()

chart type manipulation, get the current chart type

Returns:

the chart type

getChartID

public String getChartID()

chart id manipulation, get the current chart id

Returns:

the chart id

isUseLegend

public boolean isUseLegend()

chart legend manipulation

Returns:

returns true if it is using legend, otherwise returns false

setApply3DEffect

public void setApply3DEffect(boolean _3deffect)

3D effect manipulation, set to apply 3D effect

Parameters:

_3deffect - a flag specifying whether or not apply a 3D effect

setAxisTitle

public void setAxisTitle(String dimType,
                         String title)

chart axis manipulation, set the chart axis title according to the give dimension

Parameters:

dimType - the chart axis dimension, x,y, or z

title - the title of axis

setChartData

public void setChartData(DataSet dataset)

chart data manipulation, set chart data

Parameters:

dataset - the data set for the chart, which is a 2 dimensional data container

setChartTitle

public boolean setChartTitle(String title)

chart title manipulation, get the current chart title

Returns:

return the chart title

setChartType

public void setChartType(ChartType type)

chart type manipulation, set a chart type when chart type is changed, all the corresponding chart behaviors and properties should be changed accordingly

Parameters:

type - the type of chart

setUseLegend

public void setUseLegend(boolean useLegend)

chart legend manipulation, get whether the chart use legend

Parameters:

useLegend - a flag specifying whether or not use legend

refreshChart

public void refreshChart()

Refresh chart view and data setting.