Package com.inet.report.chart.plot

Class GanttPlot

java.lang.Object

com.inet.report.chart.plot.AbstractPlot

com.inet.report.chart.plot.GanttPlot

All Implemented Interfaces:

ChartPlot, Serializable

public class GanttPlot
extends AbstractPlot

A general class for plotting data in the form of an start, end and progress value. This plot can use data from any class that implements the GanttDataset interface.

Since:

8.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.inet.report.chart.plot.AbstractPlot

AbstractPlot.GradientSetting

Field Summary

Fields

Modifier and Type	Field	Description
static final GanttStyle	DEFAULT_STYLE	Default chart style with this plot.

Fields inherited from class com.inet.report.chart.plot.AbstractPlot

DEFAULT_COLOR_SEQUENCE, DEFAULT_FOREGROUND_ALPHA, DEFAULT_ITEM_LABEL_COLOR, DEFAULT_ITEM_LABEL_FONT, DEFAULT_OUTLINE_COLOR, DEFAULT_OUTLINE_STYLE, DEFAULT_OUTLINE_WIDTH, TOKEN_PLOT

Constructor Summary

Constructors

Constructor	Description
GanttPlot()	Creates a gantt plot with default properties.
GanttPlot(GanttStyle style)	Creates a gantt plot with defined chart style.

Method Summary

Modifier and Type	Method	Description
GroupAxis	getCategoryAxis()	Returns the category axis of this plot.
ContinuousDateAxis	getDataAxis()	Returns the data axis of this plot.
GanttDataset	getDataset()	Returns a dataset of type GanttDataset.
int	getItemLabelAlignment()	Returns the labels alignment of the items displayed on this plot.
int	getItemLabelPosition()	Returns the item label position on the chart item.
List	getReferencedObject()	Returns a list of referenced i-net Clear Reports objects: Field or Group
ChartStyle	getStyle()	Returns the style of this chart, ie. the general category this plot belongs to.
protected StringBuilder	getSubProperties(int depth)	Returns the serialized simple properties of subclasses.
void	readProperties(Element element, Chart2 chart)	Reads the chart properties from the DOMParser Element.
void	refreshAutoTitles(Chart2 chart)	Reads out the data column names from dataset and refreshes the chart labels.
protected void	saveSubProperties(PrintWriter out, int depth)	Writes the intern properties to output.
void	setCategoryAxis(GroupAxis categoryAxis)	Sets the category axis for the plot.
void	setDataAxis(ContinuousDateAxis dataAxis)	Sets the data axis of this plot.
void	setDataset(GanttDataset dataset)	Sets the dataset for gantt chart.
void	setItemLabelAlignment(int itemLabelAlignment)	Sets the item label alignment.
void	setItemLabelPosition(int itemLabelPosition)	Sets the item label position on the chart item.

Methods inherited from class com.inet.report.chart.plot.AbstractPlot

getBackColor, getColorFormula, getColorSequence, getForegroundAlpha, getGradientSetting, getItemLabelColor, getItemLabelFont, getItemLabelFormat, getItemLabelFormatFormula, getItemShape, getOutlineColor, getOutlineStyle, getOutlineWidth, isColorBySeries, isDrawOutline, isSameColorsForSameGroups, isShowLabel, isShowValue, saveProperties, setBackColor, setColorBySeries, setColorFormula, setColorSequence, setDrawOutline, setForegroundAlpha, setGradientSetting, setItemLabelColor, setItemLabelFont, setItemLabelFormat, setItemLabelFormatFormula, setItemShape, setOutlineColor, setOutlineStyle, setOutlineWidth, setSameColorsForSameGroups, setShowLabel, setShowValue

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_STYLE

public static final GanttStyle DEFAULT_STYLE

Default chart style with this plot.

Constructor Details

GanttPlot

public GanttPlot()

Creates a gantt plot with default properties.

Since:

8.0

GanttPlot

public GanttPlot(GanttStyle style)

Creates a gantt plot with defined chart style. Initializes all properties with default values.

Parameters:

style - the chart style (null not permitted)

Since:

8.0

See Also:

• GanttStyle

Method Details

getDataset

public GanttDataset getDataset()

Returns a dataset of type GanttDataset.

Returns:

the dataset

Since:

8.0

See Also:

• setDataset(GanttDataset)
• GanttForEachRecordDataset
• GanttOneGroupDataset
• GanttTwoGroupsDataset

setDataset

public void setDataset(GanttDataset dataset)

Sets the dataset for gantt chart.

Parameters:

dataset - the dataset (null not permitted)

Since:

8.0

See Also:

• getDataset()
• GanttDataset
• GanttForEachRecordDataset
• GanttOneGroupDataset
• GanttTwoGroupsDataset

getCategoryAxis

public GroupAxis getCategoryAxis()

Returns the category axis of this plot. The category axis shows the values of the first group field.

Returns:

the categoryAxis

Since:

8.0

See Also:

• setCategoryAxis(GroupAxis)
• GroupAxis

setCategoryAxis

public void setCategoryAxis(GroupAxis categoryAxis)

Sets the category axis for the plot. The category axis shows the values of the first group field.

Parameters:

categoryAxis - the category axis (null not permitted)

Since:

8.0

See Also:

• getCategoryAxis()
• GroupAxis

getDataAxis

public ContinuousDateAxis getDataAxis()

Returns the data axis of this plot. The data axis shows the summarized values of the data fields.

Returns:

the dataAxis

Since:

8.0

See Also:

• setDataAxis(ContinuousDateAxis)
• ContinuousDateAxis

setDataAxis

public void setDataAxis(ContinuousDateAxis dataAxis)

Sets the data axis of this plot. The data axis shows the summarized values of the data fields.

Parameters:

dataAxis - the data axis (null not permitted)

Since:

8.0

See Also:

• getDataAxis()
• ContinuousDateAxis

getStyle

public ChartStyle getStyle()

Returns the style of this chart, ie. the general category this plot belongs to.

Specified by:

getStyle in class AbstractPlot

Returns:

the style

See Also:

• BarStyle.BAR2D
• LineStyle.LINE_MARKER
• AreaStyle.AREA2D_STACKED

getItemLabelAlignment

public int getItemLabelAlignment()

Returns the labels alignment of the items displayed on this plot.

Returns:

the alignment.

Since:

8.0

See Also:

• setItemLabelAlignment(int)
• BarPlot.ITEM_LABEL_ALIGNMENT_AUTO
• BarPlot.ITEM_LABEL_ALIGNMENT_HORIZONTAL
• BarPlot.ITEM_LABEL_ALIGNMENT_VERTICAL

setItemLabelAlignment

public void setItemLabelAlignment(int itemLabelAlignment)

Sets the item label alignment. An item label is a label with name and value on each chart item. Default alignment is BarPlot.ITEM_LABEL_ALIGNMENT_AUTO.

Parameters:

itemLabelAlignment - the item label alignment

Throws:

IllegalArgumentException - by unknown alignment.

Since:

8.0

See Also:

• getItemLabelAlignment()
• BarPlot.ITEM_LABEL_ALIGNMENT_AUTO
• BarPlot.ITEM_LABEL_ALIGNMENT_HORIZONTAL
• BarPlot.ITEM_LABEL_ALIGNMENT_VERTICAL

getItemLabelPosition

public int getItemLabelPosition()

Returns the item label position on the chart item.

Returns:

the item label position.

Since:

8.0

See Also:

• setItemLabelPosition(int)
• StandardPlot.ITEM_LABEL_POSITION_BASE
• StandardPlot.ITEM_LABEL_POSITION_CENTER
• StandardPlot.ITEM_LABEL_POSITION_INSIDE_OF_MAX
• StandardPlot.ITEM_LABEL_POSITION_OUTSIDE_OF_MAX

setItemLabelPosition

public void setItemLabelPosition(int itemLabelPosition)

Sets the item label position on the chart item. An item label is a label with name and value on each chart item. Default position is StandardPlot.ITEM_LABEL_POSITION_OUTSIDE_OF_MAX.

Parameters:

itemLabelPosition - the itemLabelPosition to set

Throws:

IllegalArgumentException - by unknown position.

Since:

8.0

See Also:

• setItemLabelPosition(int)
• StandardPlot.ITEM_LABEL_POSITION_BASE
• StandardPlot.ITEM_LABEL_POSITION_CENTER
• StandardPlot.ITEM_LABEL_POSITION_INSIDE_OF_MAX
• StandardPlot.ITEM_LABEL_POSITION_OUTSIDE_OF_MAX

refreshAutoTitles

public void refreshAutoTitles(Chart2 chart)

Reads out the data column names from dataset and refreshes the chart labels. Please use this function to refresh the chart labels if the data was be changed.

Specified by:

refreshAutoTitles in interface ChartPlot

Specified by:

refreshAutoTitles in class AbstractPlot

Parameters:

chart - the chart

saveSubProperties

protected void saveSubProperties(PrintWriter out,
 int depth)

Writes the intern properties to output. Overwrites this to save intern properties direct to PrintWriter without building a StringBuilder.

Overrides:

saveSubProperties in class AbstractPlot

Parameters:

out - the output

depth - the depth of XML indent

getSubProperties

protected StringBuilder getSubProperties(int depth)

Returns the serialized simple properties of subclasses.

Overrides:

getSubProperties in class AbstractPlot

Parameters:

depth - the depth of XML indent

Returns:

the properties.

readProperties

public void readProperties(Element element,
 Chart2 chart)

Reads the chart properties from the DOMParser Element.

Specified by:

readProperties in interface ChartPlot

Overrides:

readProperties in class AbstractPlot

Parameters:

element - the DOMParser Element

chart - the chart

getReferencedObject

public List getReferencedObject()

Returns a list of referenced i-net Clear Reports objects: Field or Group

Specified by:

getReferencedObject in interface ChartPlot

Overrides:

getReferencedObject in class AbstractPlot

Returns:

the list of objects.