Package com.storedobject.chart

Interface ComponentGroup

All Superinterfaces:

Clickable

All Known Implementing Classes:

AbstractGanttChart, ActivityChart, GanttChart, XRangeChart

public interface ComponentGroup
extends Clickable

Representation of a group of Components put together. ComponentGroups can be added to SOChart using SOChart.add(ComponentGroup...). This class is typically used to assemble complex custom charts that require more than one Components and Chart instances as their internal parts. (For example: GanttChart).

Author:

Syam

Method Summary

Modifier and Type	Method	Description
void	addParts(SOChart soChart)	Add parts of this group to SOChart.
void	removeParts(SOChart soChart)	Remove parts of this group from SOChart.
default void	validate()	This method is invoked before the addParts(SOChart) to verify that the ComponentGroup is valid.

Methods inherited from interface com.storedobject.chart.Clickable

getClickKeyName, getClickValue, isClickable, matchSource, setClickable

Method Details

addParts

void addParts(SOChart soChart)

Add parts of this group to SOChart. This will be invoked if the group was already added to the SOChart, and it is about to be rendered.

Parameters:

soChart - Chart to which parts to be added.

removeParts

void removeParts(SOChart soChart)

Remove parts of this group from SOChart. This will be invoked when the group is removed from the SOChart. This method should make sure that all the parts are removed properly including their dependencies.

Parameters:

soChart - Chart from which parts to be removed.

validate

default void validate()
               throws ChartException

This method is invoked before the addParts(SOChart) to verify that the ComponentGroup is valid.

Throws:

ChartException - Throws when in an invalid state.