com.klg.jclass.chart3d
Interface JCChart3dLegendTemplate

All Known Implementing Classes:

JCChart3dLegend

public interface JCChart3dLegendTemplate

Implemented by the 3D chart's legend class. Any subclass of JCLegend that correctly implements this interface can be used. The default implementation is the JCChart3dLegend class.

Field Summary

static int	CONTINUOUS Legend Style -- Continuous.
static int	RANGE_ALL Distribution Range -- all ranges.
static int	RANGE_DATA Distribution Range -- constrain to data.
static int	STEPPED Legend Style -- Stepped.

Method Summary

int	getDistributionRange() Gets the type of distribution range being used to display data in the legend.
int	getItemGap() Gets the gap between the legend items depending on the orientation.
com.klg.jclass.chart3d.JCChart3dLegendLabelGenerator	getLabelGenerator() Gets the class specifying custom labels to be used in the legend.
List	getLabels() Gets the list of user specified label lists used to override default label generation.
int	getLayoutStyle() Gets the style being used for displaying data ranges in the legend.
boolean	isContinuousLayout() Returns true if layout is truly continuous.
void	setContinuousLayout(boolean continuous) Called by legend manager to notify legend that CONTINUOUS layout is actually continuous.

Field Detail

CONTINUOUS

public static final int CONTINUOUS

Legend Style -- Continuous.

See Also:

Constant Field Values

STEPPED

public static final int STEPPED

Legend Style -- Stepped.

See Also:

Constant Field Values

RANGE_ALL

public static final int RANGE_ALL

Distribution Range -- all ranges.

See Also:

Constant Field Values

RANGE_DATA

public static final int RANGE_DATA

Distribution Range -- constrain to data.

See Also:

Constant Field Values

Method Detail

getLabels

public List getLabels()

Gets the list of user specified label lists used to override default label generation. The value is null if no lists have been specified. The returned List instance is indexed by data view number. Each item in the returned List is itself an List instance representing the list of legend labels (either String or JCMultiFieldString objects) to be used for the data view.;

Returns:

the list of user specified label lists

getLabelGenerator

public com.klg.jclass.chart3d.JCChart3dLegendLabelGenerator getLabelGenerator()

Gets the class specifying custom labels to be used in the legend. A null value indicates that another method of setting legend labels is being used.

Returns:

a class implementing the JCChart3dLegendLabelGenerator interface that is being used to specify legend labels

getLayoutStyle

public int getLayoutStyle()

Gets the style being used for displaying data ranges in the legend. One of CONTINUOUS or STEPPED.

Returns:

the current range style

getDistributionRange

public int getDistributionRange()

Gets the type of distribution range being used to display data in the legend. One of RANGE_DATA or RANGE_ALL. RANGE_DATA constrains the legend data ranges to the min and max of the data in the chart. RANGE_ALL ensures that all data ranges are included.

getItemGap

public int getItemGap()

Gets the gap between the legend items depending on the orientation.

Returns:

the item gap

setContinuousLayout

public void setContinuousLayout(boolean continuous)

Called by legend manager to notify legend that CONTINUOUS layout is actually continuous. (In some cases, CONTINUOUS layout may be forced to a STEPPED layout.)

Parameters:

continuous -

isContinuousLayout

public boolean isContinuousLayout()

Returns true if layout is truly continuous. False otherwise. (In some cases a CONTINUOUS layout may not actually be continuous, but may behave like a STEPPED layout instead.)