com.klg.jclass.chart3d
Class JCAxis

java.lang.Object
  |
  +--com.klg.jclass.chart3d.ParentTrackChange
        |
        +--com.klg.jclass.chart3d.ParentFormatter
              |
              +--com.klg.jclass.chart3d.JCAxis

All Implemented Interfaces:

Serializable

public class JCAxis

extends ParentFormatter

The JCAxis class represents one of the three axes in 3D space. It it used to store and control axis related properties like its min, max, annotation method, title, gridlines, annotation, and title font. It has an annotation handler to handle the annotation generation.

See Also:

Serialized Form

Field Summary

protected double	annoEaseway
protected Font	annoFont The annotation font for this axis.
protected int	annoFontCubeSize The annotation font cube size for this axis (this size is measured in thousandths of the unit cube size and must be between 0 and 1000).
protected com.klg.jclass.chart3d.Chart3dAnnoHandler	annoHandler Handler for code specific to axis annotations.
protected double	annoMax
protected double	annoMin
protected double	annoStep
static int	ANNOTATION_DATA_LABELS Annotation method in which the xLabels and yLabels are used (grid data only).
static int	ANNOTATION_ROTATION_DEFAULT Annotation rotation is caclulated based on type of annotation an spacing
static int	ANNOTATION_ROTATION_HORIZONTAL Annotation is horizontal or parallel to the axis
static int	ANNOTATION_ROTATION_VERTICAL Annoation is vertical or orthogonal to the axis
static int	ANNOTATION_VALUE_LABELS Annotation method in which the user's value labels are used for annotation.
static int	ANNOTATION_VALUES Annotation method in which chart 3D computes the labels based on axis values.
protected int	annotationMethod The annotation method.
protected int	annotationRotation The annotation rotation.
static int	AXIS_EYE Enum used in the rotate actions for rotation about the user's eye position.
static int	AXIS_NONE Enum used in the rotate actions where no particular axis is selected.
static int	AXIS_X The X axis.
static int	AXIS_Y The Y axis.
static int	AXIS_Z The Z axis.
protected int	axisId The axis id number.
protected boolean	combineLabels If true, consecutive data labels that are identical (in other words, that refer to the same object) are combined into one label, and the resulting label is positioned at the average (or middle) label position.
protected double	dataportMax
protected double	dataportMin
protected com.klg.jclass.chart3d.JCGridLines	gridLines Gridlines on a per plane basis for this axis.
protected com.klg.jclass.chart3d.JCLabelGenerator	labelGenerator Label generator which is used for custom annotations.
protected com.klg.jclass.chart3d.DerivedDouble	max The axis maximum value.
static int	MAX_AXIS_FONT_CUBE_SIZE The maximum axis font cube size.
protected int	maxAnnoLength
protected com.klg.jclass.chart3d.DerivedDouble	min The axis minimum value.
static int	NUM_AXES The number of axes on the plotcube.
protected double	origin The origin is used for Z axis only (for bars and scatter plot drop lines).
protected boolean	showing Asks if the axis showing.
protected String	title The axis title.
protected Font	titleFont The title font for this axis.
protected int	titleFontCubeSize The title font cube size for this axis (this size is measured in thousandths of the unit cube size and must be between 0 and 1000).

Fields inherited from class com.klg.jclass.chart3d.ParentFormatter

decimalPadded, groupingUsed, nFrac, numberLocalization

Fields inherited from class com.klg.jclass.chart3d.ParentTrackChange

parents

Constructor Summary

JCAxis()
No args constructor.

JCAxis(int axisId, Font defaultFont)
Constructor which supplies the axisId.

Method Summary

void	addValueLabel(com.klg.jclass.chart3d.JCValueLabel vl) Adds the provided value label to the list of value labels.
protected void	calcMaxAnnoLength() Calculates the length of the longest annotation.
protected void	checkLimits(double dataMin, double dataMax) Ensures that the max value is greater than the min value.
double	getAnnoEaseway() Gets the annotation easeway.
Font	getAnnoFont() Gets the annotation font for this axis.
int	getAnnoFontCubeSize() Returns the size of the annotation font.
com.klg.jclass.chart3d.Chart3dAnnoHandler	getAnnoHandler() Returns the annotation handler for this axis.
double	getAnnoMax() Gets the annotation maximum.
double	getAnnoMin() Gets the annotation minimum.
double	getAnnoStep() Gets the annotation step.
int	getAnnotationMethod() Returns the annotation method.
int	getAnnotationRotation() Returns the annotation rotation.
int	getAxisId() Returns the axisId.
double	getDataportMax() Gets the dataport maximum.
double	getDataportMin() Gets the dataport minimum.
com.klg.jclass.chart3d.JCValueLabel	getGeneratedValueLabel(double value) Retrieves the value label for the specified value from the list of value labels generated for this axis.
com.klg.jclass.chart3d.JCValueLabel[]	getGeneratedValueLabels() Gets the list of value labels generated for this axis.
com.klg.jclass.chart3d.JCValueLabel	getGeneratedValueLabels(int index) Gets the value label at the specified index in the list of value labels generated for this axis.
com.klg.jclass.chart3d.JCGridLines	getGridLines() Gets the gridlines object.
com.klg.jclass.chart3d.JCLabelGenerator	getLabelGenerator() Gets the value of the LabelGenerator property.
double	getMax() Gets the max property of the axis, which controls the maximum value shown on the axis.
protected int	getMaxAnnoLength() Gets the maximum annotation length for this axis (previously computed).
boolean	getMaxIsDefault() Gets the maxIsDefault property.
double	getMin() Gets the min property of the JCAxis, which controls the minimum value shown on the axis.
boolean	getMinIsDefault() Gets the minIsDefault property.
double	getOrigin() Returns the axis origin.
String	getTitle() Returns the title for this axis.
Font	getTitleFont() Gets the title font for this axis.
int	getTitleFontCubeSize() Returns the size of the title font.
com.klg.jclass.chart3d.JCValueLabel	getValueLabel(double value) Retrieves the value label for the specified value from the list of user-specified value labels.
com.klg.jclass.chart3d.JCValueLabel[]	getValueLabels() Gets the value of the ValueLabels property.
com.klg.jclass.chart3d.JCValueLabel	getValueLabels(int index) Gets the value of the ValueLabels property at a specified index.
boolean	isCombineLabels() Are data labels combined? If true, consecutive data labels that are identical (that refer to the same object), are combined into one label and the resulting label is positioned at the average (or middle) label position.
boolean	isShowing() Returns whether this axis is showing or not.
protected void	setAnnoEaseway(double annoEaseway) Sets the annotation easeway.
void	setAnnoFont(Font annoFont) Sets annotation font for this axis.
void	setAnnoFontCubeSize(int annoFontCubeSize) Sets the size of the annotation font.
protected void	setAnnoMax(double annoMax) Sets the annotation maximum.
protected void	setAnnoMin(double annoMin) Sets the annotation minimum.
protected void	setAnnoStep(double annoStep) Sets the annotation step.
void	setAnnotationMethod(int annotationMethod) Sets the axis annotation method.
void	setAnnotationRotation(int annotationRotation) Sets the axis annotation rotation.
void	setCombineLabels(boolean combineLabels) Sets the value of the combineLabels property.
protected void	setDataportMax(double dataportMax) Sets the dataport maximum.
protected void	setDataportMin(double dataportMin) Sets the dataport minimum.
protected void	setExtents(double minValue, double maxValue) Sets the extents of this axis.
void	setGridLines(com.klg.jclass.chart3d.JCGridLines gridLines) Sets the gridlines object.
void	setLabelGenerator(com.klg.jclass.chart3d.JCLabelGenerator labelGenerator) Sets the value of the LabelGenerator property.
void	setMax(double newMax) Sets the max property of the axis, which controls the maximum value shown on the axis.
void	setMaxIsDefault(boolean useDef) Sets the naxIsDefault property.
void	setMin(double newMin) Sets the min property of the JCAxis, which controls the minimum value shown on the axis.
void	setMinIsDefault(boolean useDef) Sets the minIsDefault property.
void	setOrigin(double origin) Sets the axis origin.
void	setShowing(boolean showing) Sets flag, which determines whether this axis is showing or not.
void	setTitle(String title) Sets the title for this axis.
void	setTitleFont(Font titleFont) Sets title font for this axis.
void	setTitleFontCubeSize(int titleFontCubeSize) Sets the size of the title font.
void	setValueLabels(int index, com.klg.jclass.chart3d.JCValueLabel vl) Sets the value of one one value label in the ValueLabels property.
void	setValueLabels(com.klg.jclass.chart3d.JCValueLabel[] vl) Sets the value of the ValueLabels property.

Methods inherited from class com.klg.jclass.chart3d.ParentFormatter

getGroupingUsed, getNFrac, getNumberFormatter, getNumberLocalization, isDecimalPadded, setDecimalPadded, setGroupingUsed, setNFrac, setNumberFormatterLocale, setNumberLocalization

Methods inherited from class com.klg.jclass.chart3d.ParentTrackChange

addParent, clearParents, removeParent

Methods inherited from class java.lang.Object

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

Field Detail

MAX_AXIS_FONT_CUBE_SIZE

public static final int MAX_AXIS_FONT_CUBE_SIZE

The maximum axis font cube size. As this measure is in 1000th of the of the cube, it stands to reason that 1000 is the maximum value.

See Also:

Constant Field Values

AXIS_NONE

public static final int AXIS_NONE

Enum used in the rotate actions where no particular axis is selected.

See Also:

Constant Field Values

AXIS_X

public static final int AXIS_X

The X axis.

See Also:

Constant Field Values

AXIS_Y

public static final int AXIS_Y

The Y axis.

See Also:

Constant Field Values

AXIS_Z

public static final int AXIS_Z

The Z axis.

See Also:

Constant Field Values

AXIS_EYE

public static final int AXIS_EYE

Enum used in the rotate actions for rotation about the user's eye position.

See Also:

Constant Field Values

NUM_AXES

public static final int NUM_AXES

The number of axes on the plotcube.

See Also:

Constant Field Values

ANNOTATION_VALUES

public static final int ANNOTATION_VALUES

Annotation method in which chart 3D computes the labels based on axis values.

See Also:

Constant Field Values

ANNOTATION_DATA_LABELS

public static final int ANNOTATION_DATA_LABELS

Annotation method in which the xLabels and yLabels are used (grid data only).

See Also:

Constant Field Values

ANNOTATION_VALUE_LABELS

public static final int ANNOTATION_VALUE_LABELS

Annotation method in which the user's value labels are used for annotation.

See Also:

Constant Field Values

ANNOTATION_ROTATION_DEFAULT

public static final int ANNOTATION_ROTATION_DEFAULT

Annotation rotation is caclulated based on type of annotation an spacing

See Also:

Constant Field Values

ANNOTATION_ROTATION_HORIZONTAL

public static final int ANNOTATION_ROTATION_HORIZONTAL

Annotation is horizontal or parallel to the axis

See Also:

Constant Field Values

ANNOTATION_ROTATION_VERTICAL

public static final int ANNOTATION_ROTATION_VERTICAL

Annoation is vertical or orthogonal to the axis

See Also:

Constant Field Values

showing

protected boolean showing

Asks if the axis showing.

annotationMethod

protected int annotationMethod

The annotation method. One of ANNOTATION_VALUES, ANNTOATION_DATA_LABELS, or ANNOTATION_VALUE_LABELS.

annotationRotation

protected int annotationRotation

The annotation rotation. One of ANNOTATION_ROTATION_DEFAULT, ANNTOATION_ROTATION_HORIZONTAL, or ANNOTATION_ROTATION_VERTICAL.

origin

protected double origin

The origin is used for Z axis only (for bars and scatter plot drop lines). It defaults to 0.0 (or Z axis min) but can be set to any value within the Z axis range).

title

protected String title

The axis title.

min

protected com.klg.jclass.chart3d.DerivedDouble min

The axis minimum value.

max

protected com.klg.jclass.chart3d.DerivedDouble max

The axis maximum value.

gridLines

protected com.klg.jclass.chart3d.JCGridLines gridLines

Gridlines on a per plane basis for this axis.

annoFont

protected Font annoFont

The annotation font for this axis.

annoFontCubeSize

protected int annoFontCubeSize

The annotation font cube size for this axis (this size is measured in thousandths of the unit cube size and must be between 0 and 1000).

titleFont

protected Font titleFont

The title font for this axis.

titleFontCubeSize

protected int titleFontCubeSize

The title font cube size for this axis (this size is measured in thousandths of the unit cube size and must be between 0 and 1000).

combineLabels

protected boolean combineLabels

If true, consecutive data labels that are identical (in other words, that refer to the same object) are combined into one label, and the resulting label is positioned at the average (or middle) label position. Ticks are still drawn at each data label position.

annoMin

protected double annoMin

annoMax

protected double annoMax

annoStep

protected double annoStep

annoEaseway

protected double annoEaseway

maxAnnoLength

protected int maxAnnoLength

dataportMin

protected double dataportMin

dataportMax

protected double dataportMax

annoHandler

protected com.klg.jclass.chart3d.Chart3dAnnoHandler annoHandler

Handler for code specific to axis annotations.

labelGenerator

protected com.klg.jclass.chart3d.JCLabelGenerator labelGenerator

Label generator which is used for custom annotations.

axisId

protected int axisId

The axis id number. Usually one of AXIS_X, AXIS_Y, and AXIS_Z. This property can only be set on creation.

Constructor Detail

JCAxis

public JCAxis()

No args constructor. Axis id will be invalid. Font will be null.

JCAxis

public JCAxis(int axisId,
              Font defaultFont)

Constructor which supplies the axisId. The axisId can only be set on creation.

Parameters:

axisId - Which axis is it? Should be one of AXIS_X, AXIS_Y, or AXIS_Z.

defaultFont - What font should be used as the default annotation and title font?

Method Detail

getAxisId

public int getAxisId()

Returns the axisId. Should be one of AXIS_X, AXIS_Y, or AXIS_Z.

Returns:

the current axisId

setShowing

public void setShowing(boolean showing)

Sets flag, which determines whether this axis is showing or not.

Parameters:

showing - The new value of the showing flag

isShowing

public boolean isShowing()

Returns whether this axis is showing or not.

Returns:

The value of the showing flag

setAnnotationMethod

public void setAnnotationMethod(int annotationMethod)

Sets the axis annotation method. Must be one of ANNOTATION_VALUES, ANNTOATION_DATA_LABELS, or ANNOTATION_VALUE_LABELS.

Parameters:

annotationMethod - The new value of the annotation method

getAnnotationMethod

public int getAnnotationMethod()

Returns the annotation method.

Returns:

The current annotation method

setAnnotationRotation

public void setAnnotationRotation(int annotationRotation)

Sets the axis annotation rotation. Must be one of ANNOTATION_ROTATION_DEFAULT, ANNTOATION_ROTATION_HORIZONTAL, or ANNOTATION_ROTATION_VERTICAL.

Parameters:

annotationRotation - The new value of the annotation rotation

getAnnotationRotation

public int getAnnotationRotation()

Returns the annotation rotation.

Returns:

The current annotation rotation

setOrigin

public void setOrigin(double origin)

Sets the axis origin.

Parameters:

origin - the new value of the axis origin

getOrigin

public double getOrigin()

Returns the axis origin.

Returns:

the axis origin (only valid for Z axis)

setAnnoFont

public void setAnnoFont(Font annoFont)

Sets annotation font for this axis.
Note: The annotation font is scaled to be the size of the annoFontCubeSize.

Parameters:

annoFont - the new annotation font

getAnnoFont

public Font getAnnoFont()

Gets the annotation font for this axis.
Note: The annotation font is scaled to be the size of the annoFontCubeSize.

Returns:

the current annotation font

setAnnoFontCubeSize

public void setAnnoFontCubeSize(int annoFontCubeSize)

Sets the size of the annotation font. The size is measured in thousandths of the unit cube size and must be between 0 and 1000.

Parameters:

annoFontCubeSize - the new size of the annotation font

getAnnoFontCubeSize

public int getAnnoFontCubeSize()

Returns the size of the annotation font. The size is measured in thousandths of the unit cube size and must be between 0 and 1000.

Returns:

the current size of the annotation font.

setTitleFont

public void setTitleFont(Font titleFont)

Sets title font for this axis.
Note: The title font is scaled to be the size of the titleFontCubeSize.

Parameters:

titleFont - the new title font

getTitleFont

public Font getTitleFont()

Gets the title font for this axis.
Note: The title font is scaled to be the size of the titleFontCubeSize.

Returns:

the current title font

setTitleFontCubeSize

public void setTitleFontCubeSize(int titleFontCubeSize)

Sets the size of the title font. The size is measured in thousandths of the unit cube size and must be between 0 and 1000.

Parameters:

titleFontCubeSize - the new size of the title font

getTitleFontCubeSize

public int getTitleFontCubeSize()

Returns the size of the title font. The size is measured in thousandths of the unit cube size and must be between 0 and 1000.

Returns:

the current size of the title font

setTitle

public void setTitle(String title)

Sets the title for this axis.

Parameters:

title - the new axis title

getTitle

public String getTitle()

Returns the title for this axis.

Returns:

the current axis title

setMin

public void setMin(double newMin)

Sets the min property of the JCAxis, which controls the minimum value shown on the axis.

Parameters:

newMin - the new minimum value

getMin

public double getMin()

Gets the min property of the JCAxis, which controls the minimum value shown on the axis.

Returns:

the current minimum value

setMinIsDefault

public void setMinIsDefault(boolean useDef)

Sets the minIsDefault property. The minIsDefault property determines whether Chart3d is responsible for calculating the minimum axis value. If true, Chart3d will calculate the axis min. If false, Chart3d will use the provided axis min.

Parameters:

useDef - if true, Chart3d calculates the min property; if false, the min property is assumed to be already specified

getMinIsDefault

public boolean getMinIsDefault()

Gets the minIsDefault property. The minIsDefault property determines whether Chart3d is responsible for calculating the minimum axis value. If true, Chart3d will calculate the axis min. If false, Chart3d will use the provided axis min.

Returns:

true Chart3d calculates the min property; if false, the min property is assumed to be already specified

setMax

public void setMax(double newMax)

Sets the max property of the axis, which controls the maximum value shown on the axis.

Parameters:

newMax - the new maximum value

getMax

public double getMax()

Gets the max property of the axis, which controls the maximum value shown on the axis.

Returns:

the current maximum value

setMaxIsDefault

public void setMaxIsDefault(boolean useDef)

Sets the naxIsDefault property. The naxIsDefault property determines whether Chart3d is responsible for calculating the maximum axis value. If true, Chart3d calculates the axis max. If false, Chart3d uses the provided axis max.

Parameters:

useDef - if true, Chart3d calculates the max property; if false, the max property is assumed to be already specified

getMaxIsDefault

public boolean getMaxIsDefault()

Gets the maxIsDefault property. The maxIsDefault property determines whether Chart3d is responsible for calculating the maximum axis value. If true, Chart3d calculates the axis max. If false, Chart3d uses the provided axis max.

Returns:

true Chart3d calculates the max property. If false, the max property is assumed to be already specified

setGridLines

public void setGridLines(com.klg.jclass.chart3d.JCGridLines gridLines)

Sets the gridlines object.

Parameters:

gridLines - the new JCGridLines object (cannot be null)

getGridLines

public com.klg.jclass.chart3d.JCGridLines getGridLines()

Gets the gridlines object.

Returns:

the current JCGridLines object

setAnnoMin

protected void setAnnoMin(double annoMin)

Sets the annotation minimum. This value is computed by Chart3d and should be viewed as read-only.

Parameters:

annoMin - the new annotation minimum

getAnnoMin

public double getAnnoMin()

Gets the annotation minimum. This value is computed by Chart3d and should be viewed as read-only.

Returns:

the current annotation minimum

setAnnoMax

protected void setAnnoMax(double annoMax)

Sets the annotation maximum. This value is computed by Chart3d and should be viewed as read-only.

Parameters:

annoMax - the new annotation maximum

getAnnoMax

public double getAnnoMax()

Gets the annotation maximum. This value is computed by Chart3d and is read-only.

Returns:

the current annotation maximum

setAnnoStep

protected void setAnnoStep(double annoStep)

Sets the annotation step. This value is computed by Chart3d and is read-only.

Parameters:

annoStep - the new annotation step

getAnnoStep

public double getAnnoStep()

Gets the annotation step. This value is computed by Chart3d and is read-only.

Returns:

the current annotation step

setAnnoEaseway

protected void setAnnoEaseway(double annoEaseway)

Sets the annotation easeway. This value is computed by Chart3d and is read-only.

Parameters:

annoEaseway - The new annotation easeway

getAnnoEaseway

public double getAnnoEaseway()

Gets the annotation easeway. This value is computed by Chart3d and should be viewed as read-only.

Returns:

the current annotation easeway

getMaxAnnoLength

protected int getMaxAnnoLength()

Gets the maximum annotation length for this axis (previously computed).

Returns:

the maximum annotation length for this axis

setDataportMin

protected void setDataportMin(double dataportMin)

Sets the dataport minimum. This value is computed by Chart3d and should be viewed as read-only.

Parameters:

dataportMin - dataport minimum

getDataportMin

public double getDataportMin()

Gets the dataport minimum. This value is computed by Chart3d and should be viewed as read-only.

Returns:

the current dataport minimum

setDataportMax

protected void setDataportMax(double dataportMax)

Sets the dataport maximum. This value is computed by Chart3d and should be viewed as read-only.

Parameters:

dataportMax - dataport maximum

getDataportMax

public double getDataportMax()

Gets the dataport maximum. This value is computed by Chart3d and should be viewed as read-only.

Returns:

the current dataport maximum

getAnnoHandler

public com.klg.jclass.chart3d.Chart3dAnnoHandler getAnnoHandler()

Returns the annotation handler for this axis.

Returns:

the annotation handler

checkLimits

protected void checkLimits(double dataMin,
                           double dataMax)

Ensures that the max value is greater than the min value.

Parameters:

dataMin - the default data min

dataMax - the default data max

setExtents

protected void setExtents(double minValue,
                          double maxValue)

Sets the extents of this axis. Do checking to see whether the user wants to specifiy the value, and then see if the values are acceptable.

Parameters:

minValue - the calculated (or default) minimum

maxValue - the calculated (or default) maximum

calcMaxAnnoLength

protected void calcMaxAnnoLength()

Calculates the length of the longest annotation. Just goes through the list of labels and computes the longest label length.

setLabelGenerator

public void setLabelGenerator(com.klg.jclass.chart3d.JCLabelGenerator labelGenerator)

Sets the value of the LabelGenerator property. The LabelGenerator property holds a reference to an object that implements the JCLabelGenerator interface. This interface is used to externally generate labels.

Parameters:

labelGenerator - reference to object instance used to generate labels

getLabelGenerator

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

Gets the value of the LabelGenerator property. The LabelGenerator property holds a reference to an object that implements the JCLabelGenerator interface. This interface is used to externally generate labels.

Returns:

reference to object instance used to generate labels

setCombineLabels

public void setCombineLabels(boolean combineLabels)

Sets the value of the combineLabels property. If true, consecutive data labels that are identical (that refer to the same object), are combined into one label and the resulting label is positioned at the average (or middle) label position. Ticks are still drawn at each data label position.

Parameters:

combineLabels - the new value of combineLabels

isCombineLabels

public boolean isCombineLabels()

Are data labels combined? If true, consecutive data labels that are identical (that refer to the same object), are combined into one label and the resulting label is positioned at the average (or middle) label position. Ticks are still drawn at each data label position.

Returns:

the current value of combineLabels

getValueLabel

public com.klg.jclass.chart3d.JCValueLabel getValueLabel(double value)

Retrieves the value label for the specified value from the list of user-specified value labels.

Parameters:

value - Data value for which to find the value label

Returns:

JCValueLabel instance

getGeneratedValueLabel

public com.klg.jclass.chart3d.JCValueLabel getGeneratedValueLabel(double value)

Retrieves the value label for the specified value from the list of value labels generated for this axis. If the AnnotationMethod is set to ANNOTATION_VALUE_LABELS, this list will be the same as the user-specified list of value labels.

Parameters:

value - data value for which to find the value label

Returns:

JCValueLabel instance

addValueLabel

public void addValueLabel(com.klg.jclass.chart3d.JCValueLabel vl)

Adds the provided value label to the list of value labels. If the AnnotationMethod is ANNOTATION_VALUE_LABELS, then the value label will appear at the appropriate point along the axis.

Parameters:

vl - JCValueLabel instance to add

getValueLabels

public com.klg.jclass.chart3d.JCValueLabel[] getValueLabels()

Gets the value of the ValueLabels property. The ValueLabels property is an indexed property containing a list of all annotations specified by the user for an axis.

Returns:

an array of user specified value labels

getGeneratedValueLabels

public com.klg.jclass.chart3d.JCValueLabel[] getGeneratedValueLabels()

Gets the list of value labels generated for this axis. If the AnnotationMethod is set to ANNOTATION_VALUE_LABELS, this list will be the same as the user-specified list of value labels.

Returns:

an array of the internally generated value labels

setValueLabels

public void setValueLabels(com.klg.jclass.chart3d.JCValueLabel[] vl)

Sets the value of the ValueLabels property. The ValueLabels property is an indexed property containing a list of all annotations specified by the user for an axis.
Note: The AnnotationMethod must be set to ANNOTATION_VALUE_LABELS for these labels to be used.

Parameters:

vl - a list of value labels to be used on this axis

getValueLabels

public com.klg.jclass.chart3d.JCValueLabel getValueLabels(int index)

Gets the value of the ValueLabels property at a specified index. The ValueLabels property is an indexed property containing a list of all annotations specified by the user for an axis.

Parameters:

index - the index of the user specified value label to be retrieved

Returns:

the value label at the specified index; will be null on error

getGeneratedValueLabels

public com.klg.jclass.chart3d.JCValueLabel getGeneratedValueLabels(int index)

Gets the value label at the specified index in the list of value labels generated for this axis. If the AnnotationMethod is set to ANNOTATION_VALUE_LABELS, this list will be the same as the user-specified list of value labels.

Parameters:

index - the index of the generated value label to be retrieved

Returns:

the value label at the specified index; will be null on error

setValueLabels

public void setValueLabels(int index,
                           com.klg.jclass.chart3d.JCValueLabel vl)

Sets the value of one one value label in the ValueLabels property. The ValueLabels property is an indexed property containing a list of all annotations specified by the user for an axis.
Note: This method is required by the BeanBox, but is somewhat ill-formed. The index specified will not necessarily be honoured because the ValueLabel list is sorted by value. It is not recommended for use.

Parameters:

index - the index of the value label to be set

vl - the new value label at the specified index