net.sourceforge.chart2d
Class GraphChart2DProperties

java.lang.Object
  |
  +--net.sourceforge.chart2d.GraphChart2DProperties

public class GraphChart2DProperties

extends java.lang.Object

A data structure for holding the properties common to all graph charts (ie LBChart2D and LLChart2D). Pass this to any number of graph charts to have them configured with these properties. Note: Datasets are added to charts by adding them to a GraphProperties class and adding GraphProperties classes to this class. Multiple GraphProperties classes can be added to this class. The reason to add multiple GraphProperties classes is not to have one set of data graphed by multiple graph components (ie combinations of lines, bars, or dots), but to have different data sets graphed by different combinations of graph components.

Field Summary

static int	BETWEEN Indicates the ticks of an axis should be centered between the labels of the axis.
static int	CENTERED Indicates the ticks of an axis should be centered on each label of the axis.
static java.awt.Color[]	CHART_DATASET_COLORS_DEFAULT The default is Color[0].
static float	CHART_DATASET_CUSTOM_GREATEST_VALUE_DEFAULT The default is 0.
static float	CHART_DATASET_CUSTOM_LEAST_VALUE_DEFAULT The default is 0.
static boolean	CHART_DATASET_CUSTOMIZE_GREATEST_VALUE_DEFAULT The default is false.
static boolean	CHART_DATASET_CUSTOMIZE_LEAST_VALUE_DEFAULT The default is false.
static float	CHART_GRAPHABLE_TO_AVAILABLE_RATIO_DEFAULT The default is 90f.
static int	CUSTOM_ORDER Indicates the order of the graphs is using a custom ordering as defined by the ordering passed to the setGraphOverlayOrderCustom (int[]) method.
static int[]	GRAPH_OVERLAY_ORDER_CUSTOM_DEFAULT The default is int[0].
static int	GRAPH_OVERLAY_ORDER_DEFAULT The default is ORDER_ADDED.
static boolean	LABELS_AXIS_BETWEEN_LABELS_AND_TICKS_GAP_EXISTENCE_DEFAULT The default is true.
static int	LABELS_AXIS_BETWEEN_LABELS_AND_TICKS_GAP_THICKNESS_MODEL_DEFAULT The default is 2.
static boolean	LABELS_AXIS_BETWEEN_LABELS_OR_TICKS_GAP_EXISTENCE_DEFAULT The default is true.
static int	LABELS_AXIS_BETWEEN_LABELS_OR_TICKS_GAP_THICKNESS_MODEL_DEFAULT The default is 5.
static java.awt.Color	LABELS_AXIS_LABELS_FONT_COLOR_DEFAULT The default is Color.black.
static java.lang.String	LABELS_AXIS_LABELS_FONT_NAME_DEFAULT The default is "SansSerif".
static int	LABELS_AXIS_LABELS_FONT_POINT_MODEL_DEFAULT The default is 12.
static int	LABELS_AXIS_LABELS_FONT_STYLE_DEFAULT The default is Font.PLAIN.
static java.lang.String[]	LABELS_AXIS_LABELS_TEXTS_DEFAULT The default is String[0].
static int	LABELS_AXIS_TICKS_ALIGNMENT_DEFAULT The default is BETWEEN.
static java.awt.Color	LABELS_AXIS_TICKS_COLOR_DEFAULT The default is Color.black.
static java.awt.Color	LABELS_AXIS_TICKS_OUTLINE_COLOR_DEFAULT The default is Color.black.
static boolean	LABELS_AXIS_TICKS_OUTLINE_EXISTENCE_DEFAULT The default is false.
static java.awt.Dimension	LABELS_AXIS_TICKS_SIZE_MODEL_DEFAULT The default is Dimension (3, 3).
static boolean	LABELS_AXIS_TITLE_BETWEEN_REST_GAP_EXISTENCE_DEFAULT The default is true.
static int	LABELS_AXIS_TITLE_BETWEEN_REST_GAP_THICKNESS_MODEL_DEFAULT The default is 5.
static boolean	LABELS_AXIS_TITLE_EXISTENCE_DEFAULT The default is true.
static java.awt.Color	LABELS_AXIS_TITLE_FONT_COLOR_DEFAULT The default is Color.black.
static java.lang.String	LABELS_AXIS_TITLE_FONT_NAME_DEFAULT The default is "SansSerif".
static int	LABELS_AXIS_TITLE_FONT_POINT_MODEL_DEFAULT The default is 14.
static int	LABELS_AXIS_TITLE_FONT_STYLE_DEFAULT The default is Font.PLAIN.
static java.lang.String	LABELS_AXIS_TITLE_TEXT_DEFAULT The default is "".
static java.lang.String[]	LEGEND_LABELS_TEXTS_DEFAULT The default is String[0].
static boolean	NUMBERS_AXIS_BETWEEN_LABELS_AND_TICKS_GAP_EXISTENCE_DEFAULT The default is true.
static int	NUMBERS_AXIS_BETWEEN_LABELS_AND_TICKS_GAP_THICKNESS_MODEL_DEFAULT The default is 2.
static boolean	NUMBERS_AXIS_BETWEEN_LABELS_OR_TICKS_GAP_EXISTENCE_DEFAULT The default is true.
static int	NUMBERS_AXIS_BETWEEN_LABELS_OR_TICKS_GAP_THICKNESS_MODEL_DEFAULT The default is 5.
static java.awt.Color	NUMBERS_AXIS_LABELS_FONT_COLOR_DEFAULT The default is Color.black.
static java.lang.String	NUMBERS_AXIS_LABELS_FONT_NAME_DEFAULT The default is "SansSerif".
static int	NUMBERS_AXIS_LABELS_FONT_POINT_MODEL_DEFAULT The default is 12.
static int	NUMBERS_AXIS_LABELS_FONT_STYLE_DEFAULT The default is Font.PLAIN.
static int	NUMBERS_AXIS_NUM_LABELS_DEFAULT The default is 5.
static java.awt.Color	NUMBERS_AXIS_TICKS_COLOR_DEFAULT The default is Color.black.
static java.awt.Color	NUMBERS_AXIS_TICKS_OUTLINE_COLOR_DEFAULT The default is Color.black.
static boolean	NUMBERS_AXIS_TICKS_OUTLINE_EXISTENCE_DEFAULT The default is false.
static java.awt.Dimension	NUMBERS_AXIS_TICKS_SIZE_MODEL_DEFAULT The default is Dimension (3, 3).
static boolean	NUMBERS_AXIS_TITLE_BETWEEN_REST_GAP_EXISTENCE_DEFAULT The default is true.
static int	NUMBERS_AXIS_TITLE_BETWEEN_REST_GAP_THICKNESS_MODEL_DEFAULT The default is 5.
static boolean	NUMBERS_AXIS_TITLE_EXISTENCE_DEFAULT The default is true.
static java.awt.Color	NUMBERS_AXIS_TITLE_FONT_COLOR_DEFAULT The default is Color.black.
static java.lang.String	NUMBERS_AXIS_TITLE_FONT_NAME_DEFAULT The default is "SansSerif".
static int	NUMBERS_AXIS_TITLE_FONT_POINT_MODEL_DEFAULT The default is 14.
static int	NUMBERS_AXIS_TITLE_FONT_STYLE_DEFAULT The default is Font.PLAIN.
static java.lang.String	NUMBERS_AXIS_TITLE_TEXT_DEFAULT The default is "".
static int	ORDER_ADDED Indicates the order of the graphs from top to bottom should be the same as the order in which they were added.
static int	REVERSE_ORDER_ADDED Indicates the order of the graphs from bottom to top should be the same as the order in which they were added.
static boolean	VALIDATE_ON_UPDATE_DEFAULT The default is true.

Constructor Summary

GraphChart2DProperties()
Creates this object with the documented default values, with a default Chart2DProperties object, and with one default GraphProperties object.

GraphChart2DProperties(Chart2DProperties chart2DProps)
Creates this object with the documented default values, with the given Chart2DProperties object, and with one default GraphProeprties object.

GraphChart2DProperties(Chart2DProperties chart2DProps, GraphProperties graphProps)
Creates this object with the documented default values, with the given Chart2DProperties object, and with the given GraphProperties object.

GraphChart2DProperties(GraphChart2DProperties graphChart2DProps, Chart2DProperties chart2DProperties)
Creates this object with properties (deep) copied from the GraphChart2DProperties, with the given Chart2DProperties object, and with one default GraphProperties object.

GraphChart2DProperties(GraphChart2DProperties graphChart2DProps, Chart2DProperties chart2DProps, GraphProperties graphProps)
Creates this object with properties (deep) copied from the GraphChart2DProperties, with the given Chart2DProperties object, and with the given GraphProperties object.

GraphChart2DProperties(GraphChart2DProperties graphChart2DProps, GraphProperties graphProps)
Creates this object with properties (deep) copied from the GraphChart2DProperties, with a default Chart2DProperties object, and with the given GraphProperties object.

GraphChart2DProperties(GraphProperties graphProps)
Creates this object with the documented default values, with a default Chart2DProperties object, and with the given GraphProperties object.

Method Summary

(package private) void	addGraphChart2D(GraphChart2D graphChart2D) Adds a GraphChart2D object to the set of objects associated with this properties object.
void	addGraphProperties(GraphProperties graphProps) Adds a graph with the specified properties to this chart.
Chart2DProperties	getChart2DProperties() Returns the chart2DProps of this GraphChart2DProperties.
java.awt.Color[]	getChartDatasetColors() Returns the colors for the chart's data sets [the colors of the legend's bullets and/or the colors of the data representation components [bars, lines, dots, and/or pie sectors]].
float	getChartDatasetCustomGreatestValue() Returns the custom greatest value of the data sets.
boolean	getChartDatasetCustomizeGreatestValue() Returns whether the true greatest value in the data sets will be substituted by the custom value.
boolean	getChartDatasetCustomizeLeastValue() Returns whether the true least value in the data sets will be substituted by the custom value.
float	getChartDatasetCustomLeastValue() Returns the custom least value of the data sets.
float	getChartGraphableToAvailableRatio() Returns how much of the chart's graph is used by the graph's components.
(package private) boolean	getGraphChart2DNeedsUpdate(GraphChart2D graphChart2D) Gets whether any properties have changed since this GraphChart2D object was last updated.
java.util.Vector	getGraphChart2DVector() Returns the vector of GraphChart2D objects that are using this object.
int	getGraphOverlayOrder() Gets the order graphs are displayed for overlay charts.
int[]	getGraphOverlayOrderCustom() Gets the custom ordering definition for the order in which graphs are displayed for overlay charts.
java.util.Vector	getGraphPropertiesVector() Returns a vector of the GraphProperties that have been added to this object.
boolean	getLabelsAxisBetweenLabelsAndTicksGapExistence() Returns whether a gap between the labels and ticks exists, vertically.
int	getLabelsAxisBetweenLabelsAndTicksGapThicknessModel() Returns the thickness of the gap between the labels and ticks, vertically, for the chart's model size.
boolean	getLabelsAxisBetweenLabelsOrTicksGapExistence() Returns whether a gap between the labels or ticks exists, horizontally.
int	getLabelsAxisBetweenLabelsOrTicksGapThicknessModel() Returns the thickness of the gap between the labels or ticks, horizontally, for the chart's model size.
java.awt.Color	getLabelsAxisLabelsFontColor() Returns the color of the font of the labels of the labels axis.
java.lang.String	getLabelsAxisLabelsFontName() Returns the name of the font of the labels of the labels axis.
int	getLabelsAxisLabelsFontPointModel() Returns the point of the font of the labels axis labels for the chart's model size.
int	getLabelsAxisLabelsFontStyle() Returns the style of the font of the labels axis labels.
java.lang.String[]	getLabelsAxisLabelsTexts() Returns the text of each labels axis label.
int	getLabelsAxisTicksAlignment() Returns the placement of the ticks on the labels axis.
java.awt.Color	getLabelsAxisTicksColor() Returns the color of the labels axis ticks.
java.awt.Color	getLabelsAxisTicksOutlineColor() Returns the color of the thin line that outlines the labels axis ticks.
boolean	getLabelsAxisTicksOutlineExistence() Returns whether a thin line outlines the labels axis ticks.
java.awt.Dimension	getLabelsAxisTicksSizeModel() Returns the size of the labels axis ticks for the chart's model size.
boolean	getLabelsAxisTitleBetweenRestGapExistence() Returns whether the gap above the labels axis title exists.
int	getLabelsAxisTitleBetweenRestGapThicknessModel() Returns the thickness of the gap above the labels axis title for the chart's model size.
boolean	getLabelsAxisTitleExistence() Returns whether the title of the labels axis exists.
java.awt.Color	getLabelsAxisTitleFontColor() Returns the color of the font of the labels axis title.
java.lang.String	getLabelsAxisTitleFontName() Returns the name of the font of the labels axis title.
int	getLabelsAxisTitleFontPointModel() Returns the font point of the labels axis title for the chart's model size.
int	getLabelsAxisTitleFontStyle() Returns the style of teh font of the labels axis title.
java.lang.String	getLabelsAxisTitleText() Returns the text of the title of the labels axis.
java.lang.String[]	getLegendLabelsTexts() Returns the texts of the legend labels.
boolean	getNumbersAxisBetweenLabelsAndTicksGapExistence() Returns whether a gap between the labels and ticks exists, horizontally.
int	getNumbersAxisBetweenLabelsAndTicksGapThicknessModel() Returns the thickness of the gap between the labels and ticks, horizontally, for the chart's model size.
boolean	getNumbersAxisBetweenLabelsOrTicksGapExistence() Returns whether a gap between the labels or ticks exists, vertically.
int	getNumbersAxisBetweenLabelsOrTicksGapThicknessModel() Returns the thickness of the gap between the labels or ticks, vertically, for the chart's model size.
java.awt.Color	getNumbersAxisLabelsFontColor() Returns the color of the font of the labels of the numbers axis.
java.lang.String	getNumbersAxisLabelsFontName() Returns the name of the font of the labels of the numbers axis.
int	getNumbersAxisLabelsFontPointModel() Returns the point of the font of the numbers axis labels for the chart's model size.
int	getNumbersAxisLabelsFontStyle() Returns the style of the font of the numbers axis labels.
int	getNumbersAxisNumLabels() Returns the number of labels in the numbers axis.
java.awt.Color	getNumbersAxisTicksColor() Returns the color of the numbers axis ticks.
java.awt.Color	getNumbersAxisTicksOutlineColor() Returns the color of the thin line that outlines the numbers axis ticks.
boolean	getNumbersAxisTicksOutlineExistence() Returns whether a thin line outlines the numbers axis ticks.
java.awt.Dimension	getNumbersAxisTicksSizeModel() Returns the size of the numbers axis ticks for the chart's model size.
boolean	getNumbersAxisTitleBetweenRestGapExistence() Returns whether the gap right of the numbers axis title exists.
int	getNumbersAxisTitleBetweenRestGapThicknessModel() Returns the thickness of the gap right of the numbers axis title for the chart's model size.
boolean	getNumbersAxisTitleExistence() Returns whether the title of the numbers axis exists.
java.awt.Color	getNumbersAxisTitleFontColor() Returns the color of the font of the numbers axis title.
java.lang.String	getNumbersAxisTitleFontName() Returns the name of the font of the numbers axis title.
int	getNumbersAxisTitleFontPointModel() Returns the font point of the numbers axis title for the chart's model size.
int	getNumbersAxisTitleFontStyle() Returns the style of teh font of the numbers axis title.
java.lang.String	getNumbersAxisTitleText() Returns the text of the title of the numbers axis.
boolean	getValidateOnUpdate() Returns whether the properties should be validated whenever a chart is to be updated with a changed property.
(package private) void	removeGraphChart2D(GraphChart2D graphChart2D) Removes a GraphChart2D object from the set of objects associated with this properties object.
int	removeGraphProperties() Removes the most GraphProperties that was most recently passed into this GraphChart2DProperties.
void	setChart2DProperties(Chart2DProperties chart2DProps) Specifies the Chart2DProperties object.
void	setChartDatasetColors(java.awt.Color[] colors) Specifies the colors for the chart's data sets [the colors of the legend's bullets and/or the colors of the data representation components [bars, lines, dots, and/or pie sectors]].
void	setChartDatasetCustomGreatestValue(float value) Specifies the custom greatest value of the data sets.
void	setChartDatasetCustomizeGreatestValue(boolean customize) Specifies whether the true greatest value in the data sets will be substituted by the custom value.
void	setChartDatasetCustomizeLeastValue(boolean customize) Specifies whether the true least value in the data sets will be substituted by the custom value.
void	setChartDatasetCustomLeastValue(float value) Specifies the custom least value of the data sets.
void	setChartGraphableToAvailableRatio(float ratio) Specifies how much of the chart's graph is used by the graph's components.
void	setGraphChart2DProperties(GraphChart2DProperties graphChart2DProps) Sets all the graph chart properties to be (deep) copied values from another GraphChart2DProperties.
void	setGraphChart2DPropertiesToDefaults() Sets all the graph chart properties to their documented default values.
void	setGraphOverlayOrder(int order) Sets the order graphs are displayed for overlay charts.
void	setGraphOverlayOrderCustom(int[] order) Sets the custom ordering definition for the order in which graphs are displayed for overlay charts.
void	setLabelsAxisBetweenLabelsAndTicksGapExistence(boolean existence) Specifies whether a gap between the labels and ticks exists, between.
void	setLabelsAxisBetweenLabelsAndTicksGapThicknessModel(int thickness) Specifies the thickness of the gap between the labels and ticks, between, for the chart's model size.
void	setLabelsAxisBetweenLabelsOrTicksGapExistence(boolean existence) Specifies whether a gap between the labels or ticks exists, across.
void	setLabelsAxisBetweenLabelsOrTicksGapThicknessModel(int thickness) Specifies the thickness of the gap between the labels or ticks, across, for the chart's model size.
void	setLabelsAxisLabelsFontColor(java.awt.Color color) Specifies the color of the font of the labels of the labels axis.
void	setLabelsAxisLabelsFontName(java.lang.String name) Specifies the name of the font of the labels of the labels axis.
void	setLabelsAxisLabelsFontPointModel(int point) Specifies the point of the font of the labels axis labels for the chart's model size.
void	setLabelsAxisLabelsFontStyle(int style) Specifies the style of the font of the labels axis labels.
void	setLabelsAxisLabelsTexts(java.lang.String[] texts) Specifies the text of each labels axis label.
void	setLabelsAxisTicksAlignment(int alignment) Specifies the placement of the ticks on the labels axis.
void	setLabelsAxisTicksColor(java.awt.Color color) Specifies the color of the labels axis ticks.
void	setLabelsAxisTicksOutlineColor(java.awt.Color color) Specifies the color of the thin line that outlines the labels axis ticks.
void	setLabelsAxisTicksOutlineExistence(boolean existence) Specifies whether a thin line outlines the labels axis ticks.
void	setLabelsAxisTicksSizeModel(java.awt.Dimension size) Specifies the size of the labels axis ticks for the chart's model size.
void	setLabelsAxisTitleBetweenRestGapExistence(boolean existence) Specifies whether the gap above the labels axis title exists.
void	setLabelsAxisTitleBetweenRestGapThicknessModel(int thickness) Specifies the thickness of the gap above the labels axis title for the chart's model size.
void	setLabelsAxisTitleExistence(boolean existence) Specifies whether the title of the labels axis exists.
void	setLabelsAxisTitleFontColor(java.awt.Color color) Specifies the color of the font of the labels axis title.
void	setLabelsAxisTitleFontName(java.lang.String name) Specifies the name of the font of the labels axis title.
void	setLabelsAxisTitleFontPointModel(int point) Specifies the font point of the labels axis title for the chart's model size.
void	setLabelsAxisTitleFontStyle(int style) Specifies the style of teh font of the labels axis title.
void	setLabelsAxisTitleText(java.lang.String text) Specifies the text of the title of the labels axis.
void	setLegendLabelsTexts(java.lang.String[] texts) Specifies the texts of the legend labels.
void	setNumbersAxisBetweenLabelsAndTicksGapExistence(boolean existence) Specifies whether a gap between the labels and ticks exists, horizontally.
void	setNumbersAxisBetweenLabelsAndTicksGapThicknessModel(int thickness) Specifies the thickness of the gap between the labels and ticks, horizontally, for the chart's model size.
void	setNumbersAxisBetweenLabelsOrTicksGapExistence(boolean existence) Specifies whether a gap between the labels or ticks exists, vertically.
void	setNumbersAxisBetweenLabelsOrTicksGapThicknessModel(int thickness) Specifies the thickness of the gap between the labels or ticks, vertically, for the chart's model size.
void	setNumbersAxisLabelsFontColor(java.awt.Color color) Specifies the color of the font of the labels of the numbers axis.
void	setNumbersAxisLabelsFontName(java.lang.String name) Specifies the name of the font of the labels of the numbers axis.
void	setNumbersAxisLabelsFontPointModel(int point) Specifies the point of the font of the numbers axis labels for the chart's model size.
void	setNumbersAxisLabelsFontStyle(int style) Specifies the style of the font of the numbers axis labels.
void	setNumbersAxisNumLabels(int num) Specifies the number of labels in the numbers axis.
void	setNumbersAxisTicksColor(java.awt.Color color) Specifies the color of the numbers axis ticks.
void	setNumbersAxisTicksOutlineColor(java.awt.Color color) Specifies the color of the thin line that outlines the numbers axis ticks.
void	setNumbersAxisTicksOutlineExistence(boolean existence) Specifies whether a thin line outlines the numbers axis ticks.
void	setNumbersAxisTicksSizeModel(java.awt.Dimension size) Specifies the size of the numbers axis ticks for the chart's model size.
void	setNumbersAxisTitleBetweenRestGapExistence(boolean existence) Specifies whether the gap right of the numbers axis title exists.
void	setNumbersAxisTitleBetweenRestGapThicknessModel(int thickness) Specifies the thickness of the gap right of the numbers axis title for the chart's model size.
void	setNumbersAxisTitleExistence(boolean existence) Specifies whether the title of the numbers axis exists.
void	setNumbersAxisTitleFontColor(java.awt.Color color) Specifies the color of the font of the numbers axis title.
void	setNumbersAxisTitleFontName(java.lang.String name) Specifies the name of the font of the numbers axis title.
void	setNumbersAxisTitleFontPointModel(int point) Specifies the font point of the numbers axis title for the chart's model size.
void	setNumbersAxisTitleFontStyle(int style) Specifies the style of teh font of the numbers axis title.
void	setNumbersAxisTitleText(java.lang.String text) Specifies the text of the title of the numbers axis.
void	setValidateOnUpdate(boolean validate) Returns whether the properties should be validated whenever a chart is to be updated with a changed property.
(package private) void	updateGraphChart2D(GraphChart2D graphChart2D) Updates the GraphChart2D object to the current properties, if it needs it.
boolean	validate(boolean debug) Returns true if the properties are valid.

Methods inherited from class java.lang.Object

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

Field Detail

CENTERED

public static final int CENTERED

Indicates the ticks of an axis should be centered on each label of the axis. Used by setLabelsAxisTicksAlignment (int).

BETWEEN

public static final int BETWEEN

Indicates the ticks of an axis should be centered between the labels of the axis. Used by setLabelsAxisTicksAlignment (int).

ORDER_ADDED

public static final int ORDER_ADDED

Indicates the order of the graphs from top to bottom should be the same as the order in which they were added. Used by setGraphOverlayOrder (int).

REVERSE_ORDER_ADDED

public static final int REVERSE_ORDER_ADDED

Indicates the order of the graphs from bottom to top should be the same as the order in which they were added. Used by setGraphOverlayOrder (int).

CUSTOM_ORDER

public static final int CUSTOM_ORDER

Indicates the order of the graphs is using a custom ordering as defined by the ordering passed to the setGraphOverlayOrderCustom (int[]) method. Used by setGraphOverlayOrder (int).

LEGEND_LABELS_TEXTS_DEFAULT

public static final java.lang.String[] LEGEND_LABELS_TEXTS_DEFAULT

The default is String[0].

CHART_DATASET_COLORS_DEFAULT

public static final java.awt.Color[] CHART_DATASET_COLORS_DEFAULT

The default is Color[0].

CHART_DATASET_CUSTOMIZE_GREATEST_VALUE_DEFAULT

public static final boolean CHART_DATASET_CUSTOMIZE_GREATEST_VALUE_DEFAULT

The default is false.

CHART_DATASET_CUSTOM_GREATEST_VALUE_DEFAULT

public static final float CHART_DATASET_CUSTOM_GREATEST_VALUE_DEFAULT

The default is 0.

CHART_DATASET_CUSTOMIZE_LEAST_VALUE_DEFAULT

public static final boolean CHART_DATASET_CUSTOMIZE_LEAST_VALUE_DEFAULT

The default is false.

CHART_DATASET_CUSTOM_LEAST_VALUE_DEFAULT

public static final float CHART_DATASET_CUSTOM_LEAST_VALUE_DEFAULT

The default is 0.

CHART_GRAPHABLE_TO_AVAILABLE_RATIO_DEFAULT

public static final float CHART_GRAPHABLE_TO_AVAILABLE_RATIO_DEFAULT

The default is 90f.

NUMBERS_AXIS_NUM_LABELS_DEFAULT

public static final int NUMBERS_AXIS_NUM_LABELS_DEFAULT

The default is 5.

LABELS_AXIS_TICKS_ALIGNMENT_DEFAULT

public static final int LABELS_AXIS_TICKS_ALIGNMENT_DEFAULT

The default is BETWEEN.

LABELS_AXIS_LABELS_TEXTS_DEFAULT

public static final java.lang.String[] LABELS_AXIS_LABELS_TEXTS_DEFAULT

The default is String[0].

LABELS_AXIS_TITLE_EXISTENCE_DEFAULT

public static final boolean LABELS_AXIS_TITLE_EXISTENCE_DEFAULT

The default is true.

LABELS_AXIS_TITLE_TEXT_DEFAULT

public static final java.lang.String LABELS_AXIS_TITLE_TEXT_DEFAULT

The default is "".

LABELS_AXIS_TITLE_FONT_POINT_MODEL_DEFAULT

public static final int LABELS_AXIS_TITLE_FONT_POINT_MODEL_DEFAULT

The default is 14.

LABELS_AXIS_TITLE_FONT_NAME_DEFAULT

public static final java.lang.String LABELS_AXIS_TITLE_FONT_NAME_DEFAULT

The default is "SansSerif".

LABELS_AXIS_TITLE_FONT_COLOR_DEFAULT

public static final java.awt.Color LABELS_AXIS_TITLE_FONT_COLOR_DEFAULT

The default is Color.black.

LABELS_AXIS_TITLE_FONT_STYLE_DEFAULT

public static final int LABELS_AXIS_TITLE_FONT_STYLE_DEFAULT

The default is Font.PLAIN.

LABELS_AXIS_TITLE_BETWEEN_REST_GAP_EXISTENCE_DEFAULT

public static final boolean LABELS_AXIS_TITLE_BETWEEN_REST_GAP_EXISTENCE_DEFAULT

The default is true.

LABELS_AXIS_TITLE_BETWEEN_REST_GAP_THICKNESS_MODEL_DEFAULT

public static final int LABELS_AXIS_TITLE_BETWEEN_REST_GAP_THICKNESS_MODEL_DEFAULT

The default is 5.

LABELS_AXIS_TICKS_SIZE_MODEL_DEFAULT

public static final java.awt.Dimension LABELS_AXIS_TICKS_SIZE_MODEL_DEFAULT

The default is Dimension (3, 3).

LABELS_AXIS_TICKS_COLOR_DEFAULT

public static final java.awt.Color LABELS_AXIS_TICKS_COLOR_DEFAULT

The default is Color.black.

LABELS_AXIS_TICKS_OUTLINE_EXISTENCE_DEFAULT

public static final boolean LABELS_AXIS_TICKS_OUTLINE_EXISTENCE_DEFAULT

The default is false.

LABELS_AXIS_TICKS_OUTLINE_COLOR_DEFAULT

public static final java.awt.Color LABELS_AXIS_TICKS_OUTLINE_COLOR_DEFAULT

The default is Color.black.

LABELS_AXIS_LABELS_FONT_POINT_MODEL_DEFAULT

public static final int LABELS_AXIS_LABELS_FONT_POINT_MODEL_DEFAULT

The default is 12.

LABELS_AXIS_LABELS_FONT_NAME_DEFAULT

public static final java.lang.String LABELS_AXIS_LABELS_FONT_NAME_DEFAULT

The default is "SansSerif".

LABELS_AXIS_LABELS_FONT_COLOR_DEFAULT

public static final java.awt.Color LABELS_AXIS_LABELS_FONT_COLOR_DEFAULT

The default is Color.black.

LABELS_AXIS_LABELS_FONT_STYLE_DEFAULT

public static final int LABELS_AXIS_LABELS_FONT_STYLE_DEFAULT

The default is Font.PLAIN.

LABELS_AXIS_BETWEEN_LABELS_OR_TICKS_GAP_EXISTENCE_DEFAULT

public static final boolean LABELS_AXIS_BETWEEN_LABELS_OR_TICKS_GAP_EXISTENCE_DEFAULT

The default is true.

LABELS_AXIS_BETWEEN_LABELS_OR_TICKS_GAP_THICKNESS_MODEL_DEFAULT

public static final int LABELS_AXIS_BETWEEN_LABELS_OR_TICKS_GAP_THICKNESS_MODEL_DEFAULT

The default is 5.

LABELS_AXIS_BETWEEN_LABELS_AND_TICKS_GAP_EXISTENCE_DEFAULT

public static final boolean LABELS_AXIS_BETWEEN_LABELS_AND_TICKS_GAP_EXISTENCE_DEFAULT

The default is true.

LABELS_AXIS_BETWEEN_LABELS_AND_TICKS_GAP_THICKNESS_MODEL_DEFAULT

public static final int LABELS_AXIS_BETWEEN_LABELS_AND_TICKS_GAP_THICKNESS_MODEL_DEFAULT

The default is 2.

NUMBERS_AXIS_TITLE_EXISTENCE_DEFAULT

public static final boolean NUMBERS_AXIS_TITLE_EXISTENCE_DEFAULT

The default is true.

NUMBERS_AXIS_TITLE_TEXT_DEFAULT

public static final java.lang.String NUMBERS_AXIS_TITLE_TEXT_DEFAULT

The default is "".

NUMBERS_AXIS_TITLE_FONT_POINT_MODEL_DEFAULT

public static final int NUMBERS_AXIS_TITLE_FONT_POINT_MODEL_DEFAULT

The default is 14.

NUMBERS_AXIS_TITLE_FONT_NAME_DEFAULT

public static final java.lang.String NUMBERS_AXIS_TITLE_FONT_NAME_DEFAULT

The default is "SansSerif".

NUMBERS_AXIS_TITLE_FONT_COLOR_DEFAULT

public static final java.awt.Color NUMBERS_AXIS_TITLE_FONT_COLOR_DEFAULT

The default is Color.black.

NUMBERS_AXIS_TITLE_FONT_STYLE_DEFAULT

public static final int NUMBERS_AXIS_TITLE_FONT_STYLE_DEFAULT

The default is Font.PLAIN.

NUMBERS_AXIS_TITLE_BETWEEN_REST_GAP_EXISTENCE_DEFAULT

public static final boolean NUMBERS_AXIS_TITLE_BETWEEN_REST_GAP_EXISTENCE_DEFAULT

The default is true.

NUMBERS_AXIS_TITLE_BETWEEN_REST_GAP_THICKNESS_MODEL_DEFAULT

public static final int NUMBERS_AXIS_TITLE_BETWEEN_REST_GAP_THICKNESS_MODEL_DEFAULT

The default is 5.

NUMBERS_AXIS_TICKS_SIZE_MODEL_DEFAULT

public static final java.awt.Dimension NUMBERS_AXIS_TICKS_SIZE_MODEL_DEFAULT

The default is Dimension (3, 3).

NUMBERS_AXIS_TICKS_COLOR_DEFAULT

public static final java.awt.Color NUMBERS_AXIS_TICKS_COLOR_DEFAULT

The default is Color.black.

NUMBERS_AXIS_TICKS_OUTLINE_EXISTENCE_DEFAULT

public static final boolean NUMBERS_AXIS_TICKS_OUTLINE_EXISTENCE_DEFAULT

The default is false.

NUMBERS_AXIS_TICKS_OUTLINE_COLOR_DEFAULT

public static final java.awt.Color NUMBERS_AXIS_TICKS_OUTLINE_COLOR_DEFAULT

The default is Color.black.

NUMBERS_AXIS_LABELS_FONT_POINT_MODEL_DEFAULT

public static final int NUMBERS_AXIS_LABELS_FONT_POINT_MODEL_DEFAULT

The default is 12.

NUMBERS_AXIS_LABELS_FONT_NAME_DEFAULT

public static final java.lang.String NUMBERS_AXIS_LABELS_FONT_NAME_DEFAULT

The default is "SansSerif".

NUMBERS_AXIS_LABELS_FONT_COLOR_DEFAULT

public static final java.awt.Color NUMBERS_AXIS_LABELS_FONT_COLOR_DEFAULT

The default is Color.black.

NUMBERS_AXIS_LABELS_FONT_STYLE_DEFAULT

public static final int NUMBERS_AXIS_LABELS_FONT_STYLE_DEFAULT

The default is Font.PLAIN.

NUMBERS_AXIS_BETWEEN_LABELS_OR_TICKS_GAP_EXISTENCE_DEFAULT

public static final boolean NUMBERS_AXIS_BETWEEN_LABELS_OR_TICKS_GAP_EXISTENCE_DEFAULT

The default is true.

NUMBERS_AXIS_BETWEEN_LABELS_OR_TICKS_GAP_THICKNESS_MODEL_DEFAULT

public static final int NUMBERS_AXIS_BETWEEN_LABELS_OR_TICKS_GAP_THICKNESS_MODEL_DEFAULT

The default is 5.

NUMBERS_AXIS_BETWEEN_LABELS_AND_TICKS_GAP_EXISTENCE_DEFAULT

public static final boolean NUMBERS_AXIS_BETWEEN_LABELS_AND_TICKS_GAP_EXISTENCE_DEFAULT

The default is true.

NUMBERS_AXIS_BETWEEN_LABELS_AND_TICKS_GAP_THICKNESS_MODEL_DEFAULT

public static final int NUMBERS_AXIS_BETWEEN_LABELS_AND_TICKS_GAP_THICKNESS_MODEL_DEFAULT

The default is 2.

GRAPH_OVERLAY_ORDER_DEFAULT

public static final int GRAPH_OVERLAY_ORDER_DEFAULT

The default is ORDER_ADDED.

GRAPH_OVERLAY_ORDER_CUSTOM_DEFAULT

public static final int[] GRAPH_OVERLAY_ORDER_CUSTOM_DEFAULT

The default is int[0].

VALIDATE_ON_UPDATE_DEFAULT

public static final boolean VALIDATE_ON_UPDATE_DEFAULT

The default is true.

Constructor Detail

GraphChart2DProperties

public GraphChart2DProperties()

Creates this object with the documented default values, with a default Chart2DProperties object, and with one default GraphProperties object.

GraphChart2DProperties

public GraphChart2DProperties(Chart2DProperties chart2DProps)

Creates this object with the documented default values, with the given Chart2DProperties object, and with one default GraphProeprties object.

Parameters:

chart2DProps - The Chart2DProperties to use.

GraphChart2DProperties

public GraphChart2DProperties(GraphProperties graphProps)

Creates this object with the documented default values, with a default Chart2DProperties object, and with the given GraphProperties object.

Parameters:

graphProps - A GraphProperties to use.

GraphChart2DProperties

public GraphChart2DProperties(Chart2DProperties chart2DProps,
                              GraphProperties graphProps)

Creates this object with the documented default values, with the given Chart2DProperties object, and with the given GraphProperties object.

Parameters:

chart2DProps - The Chart2DProperties to use.

graphProps - A GraphProperties to use.

GraphChart2DProperties

public GraphChart2DProperties(GraphChart2DProperties graphChart2DProps,
                              Chart2DProperties chart2DProperties)

Creates this object with properties (deep) copied from the GraphChart2DProperties, with the given Chart2DProperties object, and with one default GraphProperties object.

Parameters:

graphChart2DProps - The graph chart properties to copy.

chart2DProps - The Chart2DProperties to use.

GraphChart2DProperties

public GraphChart2DProperties(GraphChart2DProperties graphChart2DProps,
                              GraphProperties graphProps)

Creates this object with properties (deep) copied from the GraphChart2DProperties, with a default Chart2DProperties object, and with the given GraphProperties object.

Parameters:

graphChart2DProps - The graph chart properties to copy.

graphProps - A GraphProperties to use.

GraphChart2DProperties

public GraphChart2DProperties(GraphChart2DProperties graphChart2DProps,
                              Chart2DProperties chart2DProps,
                              GraphProperties graphProps)

Creates this object with properties (deep) copied from the GraphChart2DProperties, with the given Chart2DProperties object, and with the given GraphProperties object.

Parameters:

graphChart2DProps - The graph chart properties to copy.

chart2DProps - The Chart2DProperties to use.

graphProps - A GraphProperties to use.

Method Detail

setGraphChart2DPropertiesToDefaults

public void setGraphChart2DPropertiesToDefaults()

Sets all the graph chart properties to their documented default values. The Chart2DProperties and GraphProperties objects are unchanged.

setGraphChart2DProperties

public void setGraphChart2DProperties(GraphChart2DProperties graphChart2DProps)

Sets all the graph chart properties to be (deep) copied values from another GraphChart2DProperties. The Chart2DProperties and GraphProperties objects are unchanged.

Parameters:

graphChart2DProps - The GraphChart2DProperties to copy.

setChart2DProperties

public void setChart2DProperties(Chart2DProperties chart2DProps)

Specifies the Chart2DProperties object. Does not copy.

Parameters:

chart2DProps - The Chart2DProperties object to use.

setLegendLabelsTexts

public void setLegendLabelsTexts(java.lang.String[] texts)

Specifies the texts of the legend labels. The number of texts must be equal to the total number of data sets of this chart.

Parameters:

texts - The texts for the legend labels.

setChartDatasetColors

public void setChartDatasetColors(java.awt.Color[] colors)

Specifies the colors for the chart's data sets [the colors of the legend's bullets and/or the colors of the data representation components [bars, lines, dots, and/or pie sectors]]. The array of colors must be of the length equal to the total number of data sets of this chart.

Parameters:

colors - The colors to use for the data sets.

setChartDatasetCustomizeGreatestValue

public void setChartDatasetCustomizeGreatestValue(boolean customize)

Specifies whether the true greatest value in the data sets will be substituted by the custom value. This effects the range of the labels of the numbers axis.

Parameters:

customize - If true, the greatest value of the data will be customized.

setChartDatasetCustomGreatestValue

public void setChartDatasetCustomGreatestValue(float value)

Specifies the custom greatest value of the data sets. This value must be greater than or equal to the true greatest value of the data sets for it to be used. This effects the scale of the labels of the numbers axis.

Parameters:

value - The custom greatest value of the data sets.

setChartDatasetCustomizeLeastValue

public void setChartDatasetCustomizeLeastValue(boolean customize)

Specifies whether the true least value in the data sets will be substituted by the custom value. This effects the range of the labels of the numbers axis.

Parameters:

customize - If true, the least value of the data will be customized.

setChartDatasetCustomLeastValue

public void setChartDatasetCustomLeastValue(float value)

Specifies the custom least value of the data sets. This value must be less than or equal to the true least value of the data sets for it to be used. This effects the scale of the labels of the numbers axis.

Parameters:

value - The custom least value of the data sets.

setChartGraphableToAvailableRatio

public void setChartGraphableToAvailableRatio(float ratio)

Specifies how much of the chart's graph is used by the graph's components. This value must be: 0f <= value <= 1f. This effects the scale of the labels of the numbers axis.

Parameters:

ratio - The ratio of usable to available of the graph.

setLabelsAxisTicksAlignment

public void setLabelsAxisTicksAlignment(int alignment)

Specifies the placement of the ticks on the labels axis. The ticks may be either between the labels axis labels (ie for bar charts) or centered on each labels axis label (ie for other charts). The possible values are BETWEEN and CENTERED.

Parameters:

alignment - The alignment of the labels axis ticks.

setLabelsAxisLabelsTexts

public void setLabelsAxisLabelsTexts(java.lang.String[] texts)

Specifies the text of each labels axis label. This determines how many categories the data in the data sets are split into.

Parameters:

texts - The texts of the labels axis labels.

setLabelsAxisTitleExistence

public void setLabelsAxisTitleExistence(boolean existence)

Specifies whether the title of the labels axis exists.

Parameters:

existence - If true, the title exists.

setLabelsAxisTitleText

public void setLabelsAxisTitleText(java.lang.String text)

Specifies the text of the title of the labels axis.

Parameters:

text - The title of the labels axis.

setLabelsAxisTitleFontPointModel

public void setLabelsAxisTitleFontPointModel(int point)

Specifies the font point of the labels axis title for the chart's model size.

Parameters:

point - The model font point of the labels axis title.

setLabelsAxisTitleFontName

public void setLabelsAxisTitleFontName(java.lang.String name)

Specifies the name of the font of the labels axis title. Accepts standard font names.

Parameters:

name - The name of the font of the labels axis title.

setLabelsAxisTitleFontColor

public void setLabelsAxisTitleFontColor(java.awt.Color color)

Specifies the color of the font of the labels axis title.

Parameters:

color - The color of the font of the labels axis title.

setLabelsAxisTitleFontStyle

public void setLabelsAxisTitleFontStyle(int style)

Specifies the style of teh font of the labels axis title. Accepts standard values for font styles.

Parameters:

style - The style of the font of the labels axis title.

setLabelsAxisTitleBetweenRestGapExistence

public void setLabelsAxisTitleBetweenRestGapExistence(boolean existence)

Specifies whether the gap above the labels axis title exists.

Parameters:

existence - If true, the gap exists.

setLabelsAxisTitleBetweenRestGapThicknessModel

public void setLabelsAxisTitleBetweenRestGapThicknessModel(int thickness)

Specifies the thickness of the gap above the labels axis title for the chart's model size.

Parameters:

thickness - The model thickness of the gap.

setLabelsAxisTicksSizeModel

public void setLabelsAxisTicksSizeModel(java.awt.Dimension size)

Specifies the size of the labels axis ticks for the chart's model size.

Parameters:

size - The model size of the labels axis ticks.

setLabelsAxisTicksColor

public void setLabelsAxisTicksColor(java.awt.Color color)

Specifies the color of the labels axis ticks.

Parameters:

color - The color of the labels axis ticks.

setLabelsAxisTicksOutlineExistence

public void setLabelsAxisTicksOutlineExistence(boolean existence)

Specifies whether a thin line outlines the labels axis ticks.

Parameters:

existence - If true, then a thin outline exists.

setLabelsAxisTicksOutlineColor

public void setLabelsAxisTicksOutlineColor(java.awt.Color color)

Specifies the color of the thin line that outlines the labels axis ticks.

Parameters:

color - The color of the line that outlines the labels axis ticks.

setLabelsAxisLabelsFontPointModel

public void setLabelsAxisLabelsFontPointModel(int point)

Specifies the point of the font of the labels axis labels for the chart's model size.

Parameters:

point - The model font point of the labels axis labels.

setLabelsAxisLabelsFontName

public void setLabelsAxisLabelsFontName(java.lang.String name)

Specifies the name of the font of the labels of the labels axis. Accepts standard font names.

Parameters:

name - The name of the font.

setLabelsAxisLabelsFontColor

public void setLabelsAxisLabelsFontColor(java.awt.Color color)

Specifies the color of the font of the labels of the labels axis.

Parameters:

color - The color of the font.

setLabelsAxisLabelsFontStyle

public void setLabelsAxisLabelsFontStyle(int style)

Specifies the style of the font of the labels axis labels. Accepts standard font styles.

Parameters:

style - The style of the font.

setLabelsAxisBetweenLabelsOrTicksGapExistence

public void setLabelsAxisBetweenLabelsOrTicksGapExistence(boolean existence)

Specifies whether a gap between the labels or ticks exists, across. The gap will be applied to whichever are naturally closer.

Parameters:

existence - If true, the gap exists.

setLabelsAxisBetweenLabelsOrTicksGapThicknessModel

public void setLabelsAxisBetweenLabelsOrTicksGapThicknessModel(int thickness)

Specifies the thickness of the gap between the labels or ticks, across, for the chart's model size. The gap will be applied to whichever are naturally closer.

Parameters:

thicknss - The model thickness of the gap.

setLabelsAxisBetweenLabelsAndTicksGapExistence

public void setLabelsAxisBetweenLabelsAndTicksGapExistence(boolean existence)

Specifies whether a gap between the labels and ticks exists, between.

Parameters:

existence - If true, the gap exists.

setLabelsAxisBetweenLabelsAndTicksGapThicknessModel

public void setLabelsAxisBetweenLabelsAndTicksGapThicknessModel(int thickness)

Specifies the thickness of the gap between the labels and ticks, between, for the chart's model size.

Parameters:

thickness - The model thickness of the gap.

setNumbersAxisTitleExistence

public void setNumbersAxisTitleExistence(boolean existence)

Specifies whether the title of the numbers axis exists.

Parameters:

existence - If true, the title exists.

setNumbersAxisTitleText

public void setNumbersAxisTitleText(java.lang.String text)

Specifies the text of the title of the numbers axis.

Parameters:

text - The title of the numbers axis.

setNumbersAxisTitleFontPointModel

public void setNumbersAxisTitleFontPointModel(int point)

Specifies the font point of the numbers axis title for the chart's model size.

Parameters:

point - The model font point of the numbers axis title.

setNumbersAxisTitleFontName

public void setNumbersAxisTitleFontName(java.lang.String name)

Specifies the name of the font of the numbers axis title. Accepts standard font names.

Parameters:

name - The name of the font of the numbers axis title.

setNumbersAxisTitleFontColor

public void setNumbersAxisTitleFontColor(java.awt.Color color)

Specifies the color of the font of the numbers axis title.

Parameters:

color - The color of the font of the numbers axis title.

setNumbersAxisTitleFontStyle

public void setNumbersAxisTitleFontStyle(int style)

Specifies the style of teh font of the numbers axis title. Accepts standard values for font styles.

Parameters:

style - The style of the font of the numbers axis title.

setNumbersAxisTitleBetweenRestGapExistence

public void setNumbersAxisTitleBetweenRestGapExistence(boolean existence)

Specifies whether the gap right of the numbers axis title exists.

Parameters:

existence - If true, the gap exists.

setNumbersAxisTitleBetweenRestGapThicknessModel

public void setNumbersAxisTitleBetweenRestGapThicknessModel(int thickness)

Specifies the thickness of the gap right of the numbers axis title for the chart's model size.

Parameters:

thickness - The model thickness of the gap.

setNumbersAxisTicksSizeModel

public void setNumbersAxisTicksSizeModel(java.awt.Dimension size)

Specifies the size of the numbers axis ticks for the chart's model size.

Parameters:

size - The model size of the numbers axis ticks.

setNumbersAxisTicksColor

public void setNumbersAxisTicksColor(java.awt.Color color)

Specifies the color of the numbers axis ticks.

Parameters:

color - The color of the numbers axis ticks.

setNumbersAxisTicksOutlineExistence

public void setNumbersAxisTicksOutlineExistence(boolean existence)

Specifies whether a thin line outlines the numbers axis ticks.

Parameters:

existence - If true, then a thin outline exists.

setNumbersAxisTicksOutlineColor

public void setNumbersAxisTicksOutlineColor(java.awt.Color color)

Specifies the color of the thin line that outlines the numbers axis ticks.

Parameters:

color - The color of the line that outliens the numbers axis ticks.

setNumbersAxisNumLabels

public void setNumbersAxisNumLabels(int num)

Specifies the number of labels in the numbers axis.

Parameters:

num - The number of labels in the numbers axis.

setNumbersAxisLabelsFontPointModel

public void setNumbersAxisLabelsFontPointModel(int point)

Specifies the point of the font of the numbers axis labels for the chart's model size.

Parameters:

point - The model font point of the numbers axis labels.

setNumbersAxisLabelsFontName

public void setNumbersAxisLabelsFontName(java.lang.String name)

Specifies the name of the font of the labels of the numbers axis. Accepts standard font names.

Parameters:

name - The name of the font.

setNumbersAxisLabelsFontColor

public void setNumbersAxisLabelsFontColor(java.awt.Color color)

Specifies the color of the font of the labels of the numbers axis.

Parameters:

color - The color of the font.

setNumbersAxisLabelsFontStyle

public void setNumbersAxisLabelsFontStyle(int style)

Specifies the style of the font of the numbers axis labels. Accepts standard font styles.

Parameters:

style - The style of the font.

setNumbersAxisBetweenLabelsOrTicksGapExistence

public void setNumbersAxisBetweenLabelsOrTicksGapExistence(boolean existence)

Specifies whether a gap between the labels or ticks exists, vertically. The gap will be applied to whichever are naturally closer.

Parameters:

existence - If true, the gap exists.

setNumbersAxisBetweenLabelsOrTicksGapThicknessModel

public void setNumbersAxisBetweenLabelsOrTicksGapThicknessModel(int thickness)

Specifies the thickness of the gap between the labels or ticks, vertically, for the chart's model size. The gap will be applied to whichever are naturally closer.

Parameters:

thicknss - The model thickness of the gap.

setNumbersAxisBetweenLabelsAndTicksGapExistence

public void setNumbersAxisBetweenLabelsAndTicksGapExistence(boolean existence)

Specifies whether a gap between the labels and ticks exists, horizontally.

Parameters:

existence - If true, the gap exists.

setNumbersAxisBetweenLabelsAndTicksGapThicknessModel

public void setNumbersAxisBetweenLabelsAndTicksGapThicknessModel(int thickness)

Specifies the thickness of the gap between the labels and ticks, horizontally, for the chart's model size.

Parameters:

thickness - The model thickness of the gap.

setGraphOverlayOrder

public void setGraphOverlayOrder(int order)

Sets the order graphs are displayed for overlay charts. Uses the fields, ORDER_ADDED, REVERSE_ORDER_ADDED, and CUSTOM_ORDER. For a custom order, use the setGraphOverlayOrderCustom(int[]) method to define the custom ordering.

Parameters:

order - The order in which graphs should be displayed.

setGraphOverlayOrderCustom

public void setGraphOverlayOrderCustom(int[] order)

Sets the custom ordering definition for the order in which graphs are displayed for overlay charts. The parameter is an integer array. It should be populated with the indices of the graphs properties added. The first graph added (or passed in through the constructor) has an index of zero. Each additional graph added has an index of one greater than the previous graph added. The graph of the i'th index, if in the j'th location of the array, will be displayed j positions from the top graph. For this custom order to be used, call setGraphOverlayOrder(CUSTOM_ORDER).

Parameters:

order - The definition of the custom ordering of the graphs.

setValidateOnUpdate

public void setValidateOnUpdate(boolean validate)

Returns whether the properties should be validated whenever a chart is to be updated with a changed property.

Parameters:

validate - If true, then the properties will be validated every time they are used to update a chart.

getChart2DProperties

public Chart2DProperties getChart2DProperties()

Returns the chart2DProps of this GraphChart2DProperties.

Returns:

Chart2DProperties The Chart2DProperties.

getGraphChart2DVector

public java.util.Vector getGraphChart2DVector()

Returns the vector of GraphChart2D objects that are using this object.

Returns:

Vector The associated GraphChart2D objects.

getGraphPropertiesVector

public java.util.Vector getGraphPropertiesVector()

Returns a vector of the GraphProperties that have been added to this object.

Returns:

Vector The added GraphPropertie objects.

getLegendLabelsTexts

public java.lang.String[] getLegendLabelsTexts()

Returns the texts of the legend labels. The number of texts must be equal to the total number of data sets of this chart.

Returns:

String[] The texts for the legend labels.

getChartDatasetColors

public java.awt.Color[] getChartDatasetColors()

Returns the colors for the chart's data sets [the colors of the legend's bullets and/or the colors of the data representation components [bars, lines, dots, and/or pie sectors]]. The array of colors must be of the length equal to the total number of data sets of this chart.

Returns:

Color[] The colors to use for the data sets.

getChartDatasetCustomizeGreatestValue

public boolean getChartDatasetCustomizeGreatestValue()

Returns whether the true greatest value in the data sets will be substituted by the custom value. This effects the range of the labels of the numbers axis.

Returns:

boolean If true, the greatest value of the data will be customized.

getChartDatasetCustomGreatestValue

public float getChartDatasetCustomGreatestValue()

Returns the custom greatest value of the data sets. This value must be greater than or equal to the true greatest value of the data sets for it to be used. This effects the scale of the labels of the numbers axis.

Returns:

float The custom greatest value of the data sets.

getChartDatasetCustomizeLeastValue

public boolean getChartDatasetCustomizeLeastValue()

Returns whether the true least value in the data sets will be substituted by the custom value. This effects the range of the labels of the numbers axis.

Returns:

boolean If true, the least value of the data will be customized.

getChartDatasetCustomLeastValue

public float getChartDatasetCustomLeastValue()

Returns the custom least value of the data sets. This value must be less than or equal to the true least value of the data sets for it to be used. This effects the scale of the labels of the numbers axis.

Returns:

float The custom least value of the data sets.

getChartGraphableToAvailableRatio

public float getChartGraphableToAvailableRatio()

Returns how much of the chart's graph is used by the graph's components. This value must be: 0f <= value <= 1f. This effects the scale of the labels of the numbers axis.

Returns:

float The ratio of usable to available of the graph.

getLabelsAxisTicksAlignment

public int getLabelsAxisTicksAlignment()

Returns the placement of the ticks on the labels axis. The ticks may be either between the labels axis labels (ie for bar charts) or centered on each labels axis label (ie for other charts). The possible values are BETWEEN and CENTERED.

Returns:

int The alignment of the labels axis ticks.

getLabelsAxisLabelsTexts

public java.lang.String[] getLabelsAxisLabelsTexts()

Returns the text of each labels axis label. This determines how many categories the data in the data sets are split into.

Returns:

String[] The texts of the labels axis labels.

getLabelsAxisTitleExistence

public boolean getLabelsAxisTitleExistence()

Returns whether the title of the labels axis exists.

Returns:

boolean If true, the title exists.

getLabelsAxisTitleText

public java.lang.String getLabelsAxisTitleText()

Returns the text of the title of the labels axis.

Returns:

String The title of the labels axis.

getLabelsAxisTitleFontPointModel

public int getLabelsAxisTitleFontPointModel()

Returns the font point of the labels axis title for the chart's model size.

Returns:

int The model font point of the labels axis title.

getLabelsAxisTitleFontName

public java.lang.String getLabelsAxisTitleFontName()

Returns the name of the font of the labels axis title. Accepts standard font names.

Returns:

String The name of the font of the labels axis title.

getLabelsAxisTitleFontColor

public java.awt.Color getLabelsAxisTitleFontColor()

Returns the color of the font of the labels axis title.

Returns:

Color The color of the font of the labels axis title.

getLabelsAxisTitleFontStyle

public int getLabelsAxisTitleFontStyle()

Returns the style of teh font of the labels axis title. Accepts standard values for font styles.

Returns:

int The style of the font of the labels axis title.

getLabelsAxisTitleBetweenRestGapExistence

public boolean getLabelsAxisTitleBetweenRestGapExistence()

Returns whether the gap above the labels axis title exists.

Returns:

boolean If true, the gap exists.

getLabelsAxisTitleBetweenRestGapThicknessModel

public int getLabelsAxisTitleBetweenRestGapThicknessModel()

Returns the thickness of the gap above the labels axis title for the chart's model size.

Returns:

int The model thickness of the gap.

getLabelsAxisTicksSizeModel

public java.awt.Dimension getLabelsAxisTicksSizeModel()

Returns the size of the labels axis ticks for the chart's model size.

Returns:

Dimension The model size of the labels axis ticks.

getLabelsAxisTicksColor

public java.awt.Color getLabelsAxisTicksColor()

Returns the color of the labels axis ticks.

Returns:

Color The color of the labels axis ticks.

getLabelsAxisTicksOutlineExistence

public boolean getLabelsAxisTicksOutlineExistence()

Returns whether a thin line outlines the labels axis ticks.

Returns:

boolean If true, then a thin outline exists.

getLabelsAxisTicksOutlineColor

public java.awt.Color getLabelsAxisTicksOutlineColor()

Returns the color of the thin line that outlines the labels axis ticks.

Returns:

Color The color of the line that outliens the labels axis ticks.

getLabelsAxisLabelsFontPointModel

public int getLabelsAxisLabelsFontPointModel()

Returns the point of the font of the labels axis labels for the chart's model size.

Returns:

int The model font point of the labels axis labels.

getLabelsAxisLabelsFontName

public java.lang.String getLabelsAxisLabelsFontName()

Returns the name of the font of the labels of the labels axis. Accepts standard font names.

Returns:

String The name of the font.

getLabelsAxisLabelsFontColor

public java.awt.Color getLabelsAxisLabelsFontColor()

Returns the color of the font of the labels of the labels axis.

Returns:

Color The color of the font.

getLabelsAxisLabelsFontStyle

public int getLabelsAxisLabelsFontStyle()

Returns the style of the font of the labels axis labels. Accepts standard font styles.

Returns:

int The style of the font.

getLabelsAxisBetweenLabelsOrTicksGapExistence

public boolean getLabelsAxisBetweenLabelsOrTicksGapExistence()

Returns whether a gap between the labels or ticks exists, horizontally. The gap will be applied to whichever are naturally closer.

Returns:

boolean If true, the gap exists.

getLabelsAxisBetweenLabelsOrTicksGapThicknessModel

public int getLabelsAxisBetweenLabelsOrTicksGapThicknessModel()

Returns the thickness of the gap between the labels or ticks, horizontally, for the chart's model size. The gap will be applied to whichever are naturally closer.

Returns:

int The model thickness of the gap.

getLabelsAxisBetweenLabelsAndTicksGapExistence

public boolean getLabelsAxisBetweenLabelsAndTicksGapExistence()

Returns whether a gap between the labels and ticks exists, vertically.

Returns:

boolean If true, the gap exists.

getLabelsAxisBetweenLabelsAndTicksGapThicknessModel

public int getLabelsAxisBetweenLabelsAndTicksGapThicknessModel()

Returns the thickness of the gap between the labels and ticks, vertically, for the chart's model size.

Returns:

int The model thickness of the gap.

getNumbersAxisTitleExistence

public boolean getNumbersAxisTitleExistence()

Returns whether the title of the numbers axis exists.

Returns:

boolean If true, the title exists.

getNumbersAxisTitleText

public java.lang.String getNumbersAxisTitleText()

Returns the text of the title of the numbers axis.

Returns:

String The title of the numbers axis.

getNumbersAxisTitleFontPointModel

public int getNumbersAxisTitleFontPointModel()

Returns the font point of the numbers axis title for the chart's model size.

Returns:

int The model font point of the numbers axis title.

getNumbersAxisTitleFontName

public java.lang.String getNumbersAxisTitleFontName()

Returns the name of the font of the numbers axis title. Accepts standard font names.

Returns:

String The name of the font of the numbers axis title.

getNumbersAxisTitleFontColor

public java.awt.Color getNumbersAxisTitleFontColor()

Returns the color of the font of the numbers axis title.

Returns:

Color The color of the font of the numbers axis title.

getNumbersAxisTitleFontStyle

public int getNumbersAxisTitleFontStyle()

Returns the style of teh font of the numbers axis title. Accepts standard values for font styles.

Returns:

int The style of the font of the numbers axis title.

getNumbersAxisTitleBetweenRestGapExistence

public boolean getNumbersAxisTitleBetweenRestGapExistence()

Returns whether the gap right of the numbers axis title exists.

Returns:

boolean If true, the gap exists.

getNumbersAxisTitleBetweenRestGapThicknessModel

public int getNumbersAxisTitleBetweenRestGapThicknessModel()

Returns the thickness of the gap right of the numbers axis title for the chart's model size.

Returns:

int The model thickness of the gap.

getNumbersAxisTicksSizeModel

public java.awt.Dimension getNumbersAxisTicksSizeModel()

Returns the size of the numbers axis ticks for the chart's model size.

Returns:

Dimension The model size of the numbers axis ticks.

getNumbersAxisTicksColor

public java.awt.Color getNumbersAxisTicksColor()

Returns the color of the numbers axis ticks.

Returns:

Color The color of the numbers axis ticks.

getNumbersAxisTicksOutlineExistence

public boolean getNumbersAxisTicksOutlineExistence()

Returns whether a thin line outlines the numbers axis ticks.

Returns:

boolean If true, then a thin outline exists.

getNumbersAxisTicksOutlineColor

public java.awt.Color getNumbersAxisTicksOutlineColor()

Returns the color of the thin line that outlines the numbers axis ticks.

Returns:

Color The color of the thin line that outliens the numbers axis ticks.

getNumbersAxisNumLabels

public int getNumbersAxisNumLabels()

Returns the number of labels in the numbers axis.

Returns:

int The number of labels in the numbers axis.

getNumbersAxisLabelsFontPointModel

public int getNumbersAxisLabelsFontPointModel()

Returns the point of the font of the numbers axis labels for the chart's model size.

Returns:

int The model font point of the numbers axis labels.

getNumbersAxisLabelsFontName

public java.lang.String getNumbersAxisLabelsFontName()

Returns the name of the font of the labels of the numbers axis. Accepts standard font names.

Returns:

String The name of the font.

getNumbersAxisLabelsFontColor

public java.awt.Color getNumbersAxisLabelsFontColor()

Returns the color of the font of the labels of the numbers axis.

Returns:

Color The color of the font.

getNumbersAxisLabelsFontStyle

public int getNumbersAxisLabelsFontStyle()

Returns the style of the font of the numbers axis labels. Accepts standard font styles.

Returns:

int The style of the font.

getNumbersAxisBetweenLabelsOrTicksGapExistence

public boolean getNumbersAxisBetweenLabelsOrTicksGapExistence()

Returns whether a gap between the labels or ticks exists, vertically. The gap will be applied to whichever are naturally closer.

Returns:

boolean If true, the gap exists.

getNumbersAxisBetweenLabelsOrTicksGapThicknessModel

public int getNumbersAxisBetweenLabelsOrTicksGapThicknessModel()

Returns the thickness of the gap between the labels or ticks, vertically, for the chart's model size. The gap will be applied to whichever are naturally closer.

Returns:

int The model thickness of the gap.

getNumbersAxisBetweenLabelsAndTicksGapExistence

public boolean getNumbersAxisBetweenLabelsAndTicksGapExistence()

Returns whether a gap between the labels and ticks exists, horizontally.

Returns:

boolean If true, the gap exists.

getNumbersAxisBetweenLabelsAndTicksGapThicknessModel

public int getNumbersAxisBetweenLabelsAndTicksGapThicknessModel()

Returns the thickness of the gap between the labels and ticks, horizontally, for the chart's model size.

Returns:

int The model thickness of the gap.

getGraphOverlayOrder

public int getGraphOverlayOrder()

Gets the order graphs are displayed for overlay charts. Uses the fields, ORDER_ADDED, REVERSE_ORDER_ADDED, and CUSTOM_ORDER. For a custom order, use the setGraphOverlayOrderCustom(int[]) method to define the custom ordering.

Returns:

int The order in which graphs should be displayed.

getGraphOverlayOrderCustom

public int[] getGraphOverlayOrderCustom()

Gets the custom ordering definition for the order in which graphs are displayed for overlay charts. The parameter is an integer array. It should be populated with the indices of the graphs properties added. The first graph added (or passed in through the constructor) has an index of zero. Each additional graph added has an index of one greater than the previous graph added. The graph of the i'th index, if in the j'th location of the array, will be displayed j positions from the top graph. For this custom order to be used, call setGraphOverlayOrder(CUSTOM_ORDER).

Returns:

int[] The definition of the custom ordering of the graphs.

getValidateOnUpdate

public boolean getValidateOnUpdate()

Returns whether the properties should be validated whenever a chart is to be updated with a changed property.

Returns:

boolean If true, then the properties will be validated every time they are used to update a chart.

addGraphProperties

public void addGraphProperties(GraphProperties graphProps)

Adds a graph with the specified properties to this chart.

Parameters:

graphProps - The graph to add to this chart.

removeGraphProperties

public int removeGraphProperties()

Removes the most GraphProperties that was most recently passed into this GraphChart2DProperties.

Returns:

int The number of GraphProperties left.

validate

public boolean validate(boolean debug)

Returns true if the properties are valid. For example if a negative number is passed as a model thickness, this method will return false. If the parameter, debug, is true then a message will be printed trying to indicate which properties if any are invalid and why. If a property is invalid, then the property is set to its default. This will not trigger validation of the Chart2DProperties and the GraphProperties objects.

Parameters:

debug - If true, then debug messages will be printed.

Returns:

boolean If true, then the properties are valid.

getGraphChart2DNeedsUpdate

boolean getGraphChart2DNeedsUpdate(GraphChart2D graphChart2D)

Gets whether any properties have changed since this GraphChart2D object was last updated.

Parameters:

graphChart2D - The object that is not updated.

Returns:

boolean If true, the object is not updated.

updateGraphChart2D

void updateGraphChart2D(GraphChart2D graphChart2D)

Updates the GraphChart2D object to the current properties, if it needs it.

Parameters:

graphChart2D - The object to update.

addGraphChart2D

void addGraphChart2D(GraphChart2D graphChart2D)

Adds a GraphChart2D object to the set of objects associated with this properties object.

Parameters:

graphChart2D - The object to use these properties.

removeGraphChart2D

void removeGraphChart2D(GraphChart2D graphChart2D)

Removes a GraphChart2D object from the set of objects associated with this properties object.

Parameters:

graphChart2D - The object to not use these properties.