net.sourceforge.chart2d
Class GraphProperties

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

public class GraphProperties

extends java.lang.Object

A data structure for holding the properties common all Chart2D graph chart graphs. A graph is the rectangular area inside of a graph chart. A graph can have any combination of lines, dots, or bars. However, every set of data in the data set, must all be similar in that if one set of data is graphed using bars, then all sets of data must graphed using bars. To graph one set of data graphed by one graph component (ex. bars) and another set of data graphed by another graph component (ex. lines), then create multiple graph properties classes, splitting the data set. Add this class to any number of GraphChart2DProperties.

Field Summary

static float[]	CONTINUOUS Indicates the lines will be continuous.
static float[]	DASHED Indicates the lines will be dashed.
static float[]	DOTTED Indicates the lines will be dotted.
static boolean	GRAPH_ALLOW_COMPONENT_ALIGNMENT_DEFAULT The default is false.
static java.awt.Color	GRAPH_BACKGROUND_COLOR_DEFAULT The default is Color.lightGray.
static boolean	GRAPH_BACKGROUND_EXISTENCE_DEFAULT The default is true.
static float	GRAPH_BARS_EXCESS_SPACE_FEEDBACK_RATIO_DEFAULT The default is .75f.
static boolean	GRAPH_BARS_EXISTENCE_DEFAULT The default is true.
static int	GRAPH_BARS_THICKNESS_MODEL_DEFAULT The default is 10.
static float	GRAPH_BARS_WITHIN_CATEGORY_OVERLAP_RATIO_DEFAULT The default is .535f.
static boolean	GRAPH_BETWEEN_COMPONENTS_GAP_EXISTENCE_DEFAULT The default is true.
static int	GRAPH_BETWEEN_COMPONENTS_GAP_THICKNESS_MODEL_DEFAULT The default is 2.
static java.awt.Color	GRAPH_BORDER_LEFT_BOTTOM_COLOR_DEFAULT The default is Color.black.
static boolean	GRAPH_BORDER_LEFT_BOTTOM_EXISTENCE_DEFAULT The default is true.
static int	GRAPH_BORDER_LEFT_BOTTOM_THICKNESS_MODEL_DEFAULT The default is 2.
static java.awt.Color	GRAPH_BORDER_RIGHT_TOP_COLOR_DEFAULT The default is Color.gray.
static boolean	GRAPH_BORDER_RIGHT_TOP_EXISTENCE_DEFAULT The default is true.
static int	GRAPH_BORDER_RIGHT_TOP_THICKNESS_MODEL_DEFAULT The default is 2.
static float	GRAPH_DOTS_EXCESS_SPACE_FEEDBACK_RATIO_DEFAULT The default is 0f.
static boolean	GRAPH_DOTS_EXISTENCE_DEFAULT The default is false.
static int	GRAPH_DOTS_THICKNESS_MODEL_DEFAULT The default is 8.
static float	GRAPH_DOTS_WITHIN_CATEGORY_OVERLAP_RATIO_DEFAULT The default is .40f.
static java.awt.Color	GRAPH_LABELS_LINES_COLOR_DEFAULT The default is Color.gray.
static boolean	GRAPH_LABELS_LINES_EXISTENCE_DEFAULT The default is false.
static float[]	GRAPH_LABELS_LINES_STYLE_DEFAULT The default is CONTINUOUS.
static int	GRAPH_LABELS_LINES_THICKNESS_MODEL_DEFAULT The default is 2.
static float	GRAPH_LINES_EXCESS_SPACE_FEEDBACK_RATIO_DEFAULT The default is 0f.
static boolean	GRAPH_LINES_EXISTENCE_DEFAULT The default is false.
static boolean	GRAPH_LINES_FILL_INTERIOR_DEFAULT The default is false.
static boolean	GRAPH_LINES_THICKNESS_ASSOCIATION_DEFAULT The default is true.
static int	GRAPH_LINES_THICKNESS_MODEL_DEFAULT The default is 5.
static float	GRAPH_LINES_WITHIN_CATEGORY_OVERLAP_RATIO_DEFAULT The default is 0f.
static java.awt.Color	GRAPH_NUMBERS_LINES_COLOR_DEFAULT The default is Color.gray.
static boolean	GRAPH_NUMBERS_LINES_EXISTENCE_DEFAULT The default is true.
static float[]	GRAPH_NUMBERS_LINES_STYLE_DEFAULT The default is CONTINUOUS.
static int	GRAPH_NUMBERS_LINES_THICKNESS_MODEL_DEFAULT The default is 2.
static java.awt.Color	GRAPH_OUTLINE_COMPONENTS_COLOR_DEFAULT The default is Color.black.
static boolean	GRAPH_OUTLINE_COMPONENTS_EXISTENCE_DEFAULT The default is true.
static boolean	VALIDATE_ON_UPDATE_DEFAULT The default is true.

Constructor Summary

GraphProperties()
Creates a GraphProperties object with the documented default values and with a default dataset.

GraphProperties(Dataset dataset)
Creates a GraphProperties object with the documented default values and with the given dataset.

GraphProperties(GraphProperties graphProps)
Creates a GraphProperties object with (deep) copied values form another GraphProperties class and with a default dataset.

GraphProperties(GraphProperties graphProps, Dataset dataset)
Creates a GraphProperties object with (deep) copied values form another GraphProperties class and with the given dataset.

Method Summary

(package private) void	addGraphChart2D(GraphChart2D graphChart2D) Adds a GraphChart2D object to the set of objects using this properties object.
Dataset	getDataset() Returns the raw data sets for this graph of the chart.
boolean	getGraphAllowComponentAlignment() Returns whether the graph's components (ie bars, dots, or lines) are allowed to overlap/align or are offset for each set and within each category.
java.awt.Color	getGraphBackgroundColor() Returns the color of the background of this graph.
boolean	getGraphBackgroundExistence() Returns whether the background of this graph exists.
float	getGraphBarsExcessSpaceFeedbackRatio() Returns the amount of the excess space to feed back to bars thickness.
boolean	getGraphBarsExistence() Returns whether the graph contains bar components.
int	getGraphBarsThicknessModel() Returns the thickness of the bar components for the chart's model size.
float	getGraphBarsWithinCategoryOverlapRatio() Returns how much the bars can overlap eachother when there are multiple data values per data set and per data category.
boolean	getGraphBetweenComponentsGapExistence() Returns whether a gap between each category of components exists (ie not the gap between each each component with each category).
int	getGraphBetweenComponentsGapThicknessModel() Returns the thickness of the gap between each category of components for the chart's model size.
java.awt.Color	getGraphBorderLeftBottomColor() Returns the color of the graph's left and bottom border.
boolean	getGraphBorderLeftBottomExistence() Returns whether the graph's left and bottom border exists.
int	getGraphBorderLeftBottomThicknessModel() Returns the thickness of the graph's left and bottom border for the chart's model size.
java.awt.Color	getGraphBorderRightTopColor() Returns the color of the graph's right and top border.
boolean	getGraphBorderRightTopExistence() Returns whether the graph's right and top border exists.
int	getGraphBorderRightTopThicknessModel() Returns the thickness of the graph's right and top border for the chart's model size.
(package private) boolean	getGraphChart2DNeedsUpdate(GraphChart2D graphChart2D) Gets whether any properties have changed since this GraphChart2D object's last update.
java.util.Vector	getGraphChart2DVector() Returns the vector of GraphChart2D objects that are using this object.
float	getGraphDotsExcessSpaceFeedbackRatio() Returns the amount of the excess space to feed back to dots thickness.
boolean	getGraphDotsExistence() Returns whether the graph contains dot components.
int	getGraphDotsThicknessModel() Returns the thickness of the dot components for the chart's model size.
float	getGraphDotsWithinCategoryOverlapRatio() Returns how much the dots can overlap eachother when there are multiple data values per data set and per data category.
java.awt.Color	getGraphLabelsLinesColor() Returns the color of the vertical lines of this graph.
boolean	getGraphLabelsLinesExistence() Returns whether the vertical lines of this graph exist.
float[]	getGraphLabelsLinesStyle() Returns the style of the vertical lines of this graph.
int	getGraphLabelsLinesThicknessModel() Returns the thickness of the vertical lines of this graph for the chart's model size.
float	getGraphLinesExcessSpaceFeedbackRatio() Returns the amount of the excess space to feed back to lines thickness.
boolean	getGraphLinesExistence() Returns whether the graph contains line components.
boolean	getGraphLinesFillInterior() Returns whether the graph lines will made to form a shap (ie like a mountain range).
boolean	getGraphLinesThicknessAssociation() Returns whether the horizontal and vertical lines (if they both exist) should both be the same thickness at all times.
int	getGraphLinesThicknessModel() Returns the thickness of the line components for the chart's model size.
float	getGraphLinesWithinCategoryOverlapRatio() Returns how much the lines can overlap eachother when there are multiple data values per data set and per data category.
java.awt.Color	getGraphNumbersLinesColor() Returns the color of the horizontal lines of this graph.
boolean	getGraphNumbersLinesExistence() Returns whether the horizontal lines of this graph exist.
float[]	getGraphNumbersLinesStyle() Returns the style of the horizontal lines of this graph.
int	getGraphNumbersLinesThicknessModel() Returns the thickness of the horizontal lines of this graph for the chart's model size.
java.awt.Color	getGraphOutlineComponentsColor() Returns the color of the thin outline around components (ie bars, lines, or dots).
boolean	getGraphOutlineComponentsExistence() Returns whether there exists a thin outline around each component (ie bars, lines, or dots).
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 using this properties object.
void	setDataset(Dataset dataset) Specifies the dataset to use for this graph.
void	setGraphAllowComponentAlignment(boolean alignment) Specifies whether the graph's components (ie bars, dots, or lines) are allowed to overlap/align or are offset for each set and within each category.
void	setGraphBackgroundColor(java.awt.Color color) Specifies the color of the background of this graph.
void	setGraphBackgroundExistence(boolean existence) Specifies whether the background of this graph exists.
void	setGraphBarsExcessSpaceFeedbackRatio(float ratio) Specifies the amount of the excess space to feed back to bars thickness.
void	setGraphBarsExistence(boolean existence) Specifies whether the graph contains bar components.
void	setGraphBarsThicknessModel(int thickness) Specifies the thickness of the bar components for the chart's model size.
void	setGraphBarsWithinCategoryOverlapRatio(float ratio) Specifies how much the bars can overlap eachother when there are multiple data values per data set and per data category.
void	setGraphBetweenComponentsGapExistence(boolean existence) Specifies whether a gap between each category of components exists (ie not the gap between each each component with each category).
void	setGraphBetweenComponentsGapThicknessModel(int thickness) Specifies the thickness of the gap between each category of components for the chart's model size.
void	setGraphBorderLeftBottomColor(java.awt.Color color) Specifies the color of the graph's left and bottom border.
void	setGraphBorderLeftBottomExistence(boolean existence) Specifies whether the graph's left and bottom border exists.
void	setGraphBorderLeftBottomThicknessModel(int thickness) Specifies the thickness of the graph's left and bottom border for the chart's model size.
void	setGraphBorderRightTopColor(java.awt.Color color) Specifies the color of the graph's right and top border.
void	setGraphBorderRightTopExistence(boolean existence) Specifies whether the graph's right and top border exists.
void	setGraphBorderRightTopThicknessModel(int thickness) Specifies the thickness of the graph's right and top border for the chart's model size.
void	setGraphDotsExcessSpaceFeedbackRatio(float ratio) Specifies the amount of the excess space to feed back to dots thickness.
void	setGraphDotsExistence(boolean existence) Specifies whether the graph contains dot components.
void	setGraphDotsThicknessModel(int thickness) Specifies the thickness of the dot components for the chart's model size.
void	setGraphDotsWithinCategoryOverlapRatio(float ratio) Specifies how much the dots can overlap eachother when there are multiple data values per data set and per data category.
void	setGraphLabelsLinesColor(java.awt.Color color) Specifies the color of the vertical lines of this graph.
void	setGraphLabelsLinesExistence(boolean existence) Specifies whether the vertical lines of this graph exist.
void	setGraphLabelsLinesStyle(float[] style) Specifies the style of the vertical lines of this graph.
void	setGraphLabelsLinesThicknessModel(int thickness) Specifies the thickness of the vertical lines of this graph for the chart's model size.
void	setGraphLinesExcessSpaceFeedbackRatio(float ratio) Specifies the amount of the excess space to feed back to lines thickness.
void	setGraphLinesExistence(boolean existence) Specifies whether the graph contains line components.
void	setGraphLinesFillInterior(boolean fill) Specifies whether the graph lines will made to form a shap (ie like a mountain range).
void	setGraphLinesThicknessAssociation(boolean association) Specifies whether the horizontal and vertical lines (if they both exist) should both be the same thickness at all times.
void	setGraphLinesThicknessModel(int thickness) Specifies the thickness of the line components for the chart's model size.
void	setGraphLinesWithinCategoryOverlapRatio(float ratio) Specifies how much the lines can overlap eachother when there are multiple data values per data set and per data category.
void	setGraphNumbersLinesColor(java.awt.Color color) Specifies the color of the horizontal lines of this graph.
void	setGraphNumbersLinesExistence(boolean existence) Specifies whether the horizontal lines of this graph exist.
void	setGraphNumbersLinesStyle(float[] style) Specifies the style of the horizontal lines of this graph.
void	setGraphNumbersLinesThicknessModel(int thickness) Specifies the thickness of the horizontal lines of this graph for the chart's model size.
void	setGraphOutlineComponentsColor(java.awt.Color color) Specifies the color of the thin outline around components (ie bars, lines, or dots).
void	setGraphOutlineComponentsExistence(boolean existence) Specifies whether there exists a thin outline around each component (ie bars, lines, or dots).
void	setGraphProperties(GraphProperties graphProps) Sets all the graph properties to be copied values from another GraphProperties class.
void	setGraphPropertiesToDefaults() Sets all graph properties to their default values.
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, int graphIndex) Updates a graph area of a GraphChart2D object if the graph area needs to be updated.
boolean	validate(boolean debug) Validates all the properties of this graph.

Methods inherited from class java.lang.Object

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

Field Detail

CONTINUOUS

public static float[] CONTINUOUS

Indicates the lines will be continuous. Used by setGraphNumbersLinesStyle(int) and setGraphLabelsLinesStyle(int).

DASHED

public static float[] DASHED

Indicates the lines will be dashed. Used by setGraphNumbersLinesStyle(int) and setGraphLabelsLinesStyle(int).

DOTTED

public static float[] DOTTED

Indicates the lines will be dotted. Used by setGraphNumbersLinesStyle(int) and setGraphLabelsLinesStyle(int).

GRAPH_BACKGROUND_EXISTENCE_DEFAULT

public static final boolean GRAPH_BACKGROUND_EXISTENCE_DEFAULT

The default is true.

GRAPH_BACKGROUND_COLOR_DEFAULT

public static final java.awt.Color GRAPH_BACKGROUND_COLOR_DEFAULT

The default is Color.lightGray.

GRAPH_BORDER_LEFT_BOTTOM_EXISTENCE_DEFAULT

public static final boolean GRAPH_BORDER_LEFT_BOTTOM_EXISTENCE_DEFAULT

The default is true.

GRAPH_BORDER_LEFT_BOTTOM_THICKNESS_MODEL_DEFAULT

public static final int GRAPH_BORDER_LEFT_BOTTOM_THICKNESS_MODEL_DEFAULT

The default is 2.

GRAPH_BORDER_LEFT_BOTTOM_COLOR_DEFAULT

public static final java.awt.Color GRAPH_BORDER_LEFT_BOTTOM_COLOR_DEFAULT

The default is Color.black.

GRAPH_BORDER_RIGHT_TOP_EXISTENCE_DEFAULT

public static final boolean GRAPH_BORDER_RIGHT_TOP_EXISTENCE_DEFAULT

The default is true.

GRAPH_BORDER_RIGHT_TOP_THICKNESS_MODEL_DEFAULT

public static final int GRAPH_BORDER_RIGHT_TOP_THICKNESS_MODEL_DEFAULT

The default is 2.

GRAPH_BORDER_RIGHT_TOP_COLOR_DEFAULT

public static final java.awt.Color GRAPH_BORDER_RIGHT_TOP_COLOR_DEFAULT

The default is Color.gray.

GRAPH_ALLOW_COMPONENT_ALIGNMENT_DEFAULT

public static final boolean GRAPH_ALLOW_COMPONENT_ALIGNMENT_DEFAULT

The default is false.

GRAPH_OUTLINE_COMPONENTS_EXISTENCE_DEFAULT

public static final boolean GRAPH_OUTLINE_COMPONENTS_EXISTENCE_DEFAULT

The default is true.

GRAPH_OUTLINE_COMPONENTS_COLOR_DEFAULT

public static final java.awt.Color GRAPH_OUTLINE_COMPONENTS_COLOR_DEFAULT

The default is Color.black.

GRAPH_BETWEEN_COMPONENTS_GAP_EXISTENCE_DEFAULT

public static final boolean GRAPH_BETWEEN_COMPONENTS_GAP_EXISTENCE_DEFAULT

The default is true.

GRAPH_BETWEEN_COMPONENTS_GAP_THICKNESS_MODEL_DEFAULT

public static final int GRAPH_BETWEEN_COMPONENTS_GAP_THICKNESS_MODEL_DEFAULT

The default is 2.

GRAPH_BARS_EXISTENCE_DEFAULT

public static final boolean GRAPH_BARS_EXISTENCE_DEFAULT

The default is true.

GRAPH_BARS_THICKNESS_MODEL_DEFAULT

public static final int GRAPH_BARS_THICKNESS_MODEL_DEFAULT

The default is 10.

GRAPH_BARS_EXCESS_SPACE_FEEDBACK_RATIO_DEFAULT

public static final float GRAPH_BARS_EXCESS_SPACE_FEEDBACK_RATIO_DEFAULT

The default is .75f.

GRAPH_BARS_WITHIN_CATEGORY_OVERLAP_RATIO_DEFAULT

public static final float GRAPH_BARS_WITHIN_CATEGORY_OVERLAP_RATIO_DEFAULT

The default is .535f.

GRAPH_LINES_EXISTENCE_DEFAULT

public static final boolean GRAPH_LINES_EXISTENCE_DEFAULT

The default is false.

GRAPH_LINES_THICKNESS_MODEL_DEFAULT

public static final int GRAPH_LINES_THICKNESS_MODEL_DEFAULT

The default is 5.

GRAPH_LINES_FILL_INTERIOR_DEFAULT

public static final boolean GRAPH_LINES_FILL_INTERIOR_DEFAULT

The default is false.

GRAPH_LINES_EXCESS_SPACE_FEEDBACK_RATIO_DEFAULT

public static final float GRAPH_LINES_EXCESS_SPACE_FEEDBACK_RATIO_DEFAULT

The default is 0f.

GRAPH_LINES_WITHIN_CATEGORY_OVERLAP_RATIO_DEFAULT

public static final float GRAPH_LINES_WITHIN_CATEGORY_OVERLAP_RATIO_DEFAULT

The default is 0f.

GRAPH_DOTS_EXISTENCE_DEFAULT

public static final boolean GRAPH_DOTS_EXISTENCE_DEFAULT

The default is false.

GRAPH_DOTS_THICKNESS_MODEL_DEFAULT

public static final int GRAPH_DOTS_THICKNESS_MODEL_DEFAULT

The default is 8.

GRAPH_DOTS_EXCESS_SPACE_FEEDBACK_RATIO_DEFAULT

public static final float GRAPH_DOTS_EXCESS_SPACE_FEEDBACK_RATIO_DEFAULT

The default is 0f.

GRAPH_DOTS_WITHIN_CATEGORY_OVERLAP_RATIO_DEFAULT

public static final float GRAPH_DOTS_WITHIN_CATEGORY_OVERLAP_RATIO_DEFAULT

The default is .40f.

GRAPH_NUMBERS_LINES_EXISTENCE_DEFAULT

public static final boolean GRAPH_NUMBERS_LINES_EXISTENCE_DEFAULT

The default is true.

GRAPH_NUMBERS_LINES_THICKNESS_MODEL_DEFAULT

public static final int GRAPH_NUMBERS_LINES_THICKNESS_MODEL_DEFAULT

The default is 2.

GRAPH_NUMBERS_LINES_STYLE_DEFAULT

public static final float[] GRAPH_NUMBERS_LINES_STYLE_DEFAULT

The default is CONTINUOUS.

GRAPH_NUMBERS_LINES_COLOR_DEFAULT

public static final java.awt.Color GRAPH_NUMBERS_LINES_COLOR_DEFAULT

The default is Color.gray.

GRAPH_LABELS_LINES_EXISTENCE_DEFAULT

public static final boolean GRAPH_LABELS_LINES_EXISTENCE_DEFAULT

The default is false.

GRAPH_LABELS_LINES_THICKNESS_MODEL_DEFAULT

public static final int GRAPH_LABELS_LINES_THICKNESS_MODEL_DEFAULT

The default is 2.

GRAPH_LABELS_LINES_STYLE_DEFAULT

public static final float[] GRAPH_LABELS_LINES_STYLE_DEFAULT

The default is CONTINUOUS.

GRAPH_LABELS_LINES_COLOR_DEFAULT

public static final java.awt.Color GRAPH_LABELS_LINES_COLOR_DEFAULT

The default is Color.gray.

GRAPH_LINES_THICKNESS_ASSOCIATION_DEFAULT

public static final boolean GRAPH_LINES_THICKNESS_ASSOCIATION_DEFAULT

The default is true.

VALIDATE_ON_UPDATE_DEFAULT

public static final boolean VALIDATE_ON_UPDATE_DEFAULT

The default is true.

Constructor Detail

GraphProperties

public GraphProperties()

Creates a GraphProperties object with the documented default values and with a default dataset.

GraphProperties

public GraphProperties(Dataset dataset)

Creates a GraphProperties object with the documented default values and with the given dataset.

Parameters:

dataset - The dataset to use.

GraphProperties

public GraphProperties(GraphProperties graphProps)

Creates a GraphProperties object with (deep) copied values form another GraphProperties class and with a default dataset.

Parameters:

graphProps - The graph properties to copy.

GraphProperties

public GraphProperties(GraphProperties graphProps,
                       Dataset dataset)

Creates a GraphProperties object with (deep) copied values form another GraphProperties class and with the given dataset.

Parameters:

graphProps - The graph properties to copy.

dataset - The dataset to use.

Method Detail

setGraphPropertiesToDefaults

public void setGraphPropertiesToDefaults()

Sets all graph properties to their default values. Leaves the dataset unchanged.

setGraphProperties

public void setGraphProperties(GraphProperties graphProps)

Sets all the graph properties to be copied values from another GraphProperties class. The dataset is left unchanged.

Parameters:

graphProps - The graph properties to copy.

setDataset

public void setDataset(Dataset dataset)

Specifies the dataset to use for this graph. Does not copy it.

Parameters:

dataset - The dataset to use.

setGraphBackgroundExistence

public void setGraphBackgroundExistence(boolean existence)

Specifies whether the background of this graph exists. For each chart this graph is added to, this property will only be respected if its the first graph added that the chart; otherwise, graphs added after any chart would totally paint over the previous graph.

Parameters:

existence - If true, the background of this graph will exist.

setGraphBackgroundColor

public void setGraphBackgroundColor(java.awt.Color color)

Specifies the color of the background of this graph. For each chart this graph is added to, this property will only be respected if its the first graph added that the chart; otherwise, graphs added after any chart would totally paint over the previous graph.

Parameters:

color - The color of the background of this graph.

setGraphBorderLeftBottomExistence

public void setGraphBorderLeftBottomExistence(boolean existence)

Specifies whether the graph's left and bottom border exists.

Parameters:

existence - If true, then the graph's left and bottom border exists.

setGraphBorderLeftBottomThicknessModel

public void setGraphBorderLeftBottomThicknessModel(int thickness)

Specifies the thickness of the graph's left and bottom border for the chart's model size.

Parameters:

thickness - The model thickness of the graph's left and bottom border.

setGraphBorderLeftBottomColor

public void setGraphBorderLeftBottomColor(java.awt.Color color)

Specifies the color of the graph's left and bottom border.

Parameters:

color - The color of the graph's left and bottom border.

setGraphBorderRightTopExistence

public void setGraphBorderRightTopExistence(boolean existence)

Specifies whether the graph's right and top border exists.

Parameters:

existence - If true, then the graph's right and top border exists.

setGraphBorderRightTopThicknessModel

public void setGraphBorderRightTopThicknessModel(int thickness)

Specifies the thickness of the graph's right and top border for the chart's model size.

Parameters:

thickness - The model thickness of the graph's right and top border.

setGraphBorderRightTopColor

public void setGraphBorderRightTopColor(java.awt.Color color)

Specifies the color of the graph's right and top border.

Parameters:

color - The color of the graph's right and top border.

setGraphAllowComponentAlignment

public void setGraphAllowComponentAlignment(boolean alignment)

Specifies whether the graph's components (ie bars, dots, or lines) are allowed to overlap/align or are offset for each set and within each category. For non-stacked bars charts, don't align; for all other chart types alignment is generally preferrable.

Parameters:

alignment - If true, the components will not be offset within the category.

setGraphOutlineComponentsExistence

public void setGraphOutlineComponentsExistence(boolean existence)

Specifies whether there exists a thin outline around each component (ie bars, lines, or dots).

Parameters:

existence - If true, the components will have an outline.

setGraphOutlineComponentsColor

public void setGraphOutlineComponentsColor(java.awt.Color color)

Specifies the color of the thin outline around components (ie bars, lines, or dots).

Parameters:

color - The color of each component's outline.

setGraphBetweenComponentsGapExistence

public void setGraphBetweenComponentsGapExistence(boolean existence)

Specifies whether a gap between each category of components exists (ie not the gap between each each component with each category).

Parameters:

existence - If true, then the gap between components exists.

setGraphBetweenComponentsGapThicknessModel

public void setGraphBetweenComponentsGapThicknessModel(int thickness)

Specifies the thickness of the gap between each category of components for the chart's model size.

Parameters:

thickness - The model thickness of teh gap between components.

setGraphBarsExistence

public void setGraphBarsExistence(boolean existence)

Specifies whether the graph contains bar components.

Parameters:

existence - If true, then the graph contains bars.

setGraphBarsThicknessModel

public void setGraphBarsThicknessModel(int thickness)

Specifies the thickness of the bar components for the chart's model size.

Parameters:

thickness - The model thickness of the bars.

setGraphBarsExcessSpaceFeedbackRatio

public void setGraphBarsExcessSpaceFeedbackRatio(float ratio)

Specifies the amount of the excess space to feed back to bars thickness. Frequently the graphs are larger than necessary, the excess space can be fedback to the bars, making them larger. The ratio is the amount of space to feed back to the bars, to the total amount of space.

Parameters:

ratio - The ratio on the total amount of space to feedback.

setGraphBarsWithinCategoryOverlapRatio

public void setGraphBarsWithinCategoryOverlapRatio(float ratio)

Specifies how much the bars can overlap eachother when there are multiple data values per data set and per data category.

Parameters:

ratio - The ratio on the thickness of the bar for overlap.

setGraphLinesExistence

public void setGraphLinesExistence(boolean existence)

Specifies whether the graph contains line components.

Parameters:

existence - If true, then the graph contains lines.

setGraphLinesThicknessModel

public void setGraphLinesThicknessModel(int thickness)

Specifies the thickness of the line components for the chart's model size.

Parameters:

thickness - The model thickness of the lines.

setGraphLinesFillInterior

public void setGraphLinesFillInterior(boolean fill)

Specifies whether the graph lines will made to form a shap (ie like a mountain range).

Parameters:

fill - If true, then the lines will be filled.

setGraphLinesExcessSpaceFeedbackRatio

public void setGraphLinesExcessSpaceFeedbackRatio(float ratio)

Specifies the amount of the excess space to feed back to lines thickness. Frequently the graphs are larger than necessary, the excess space can be fedback to the lines, making them larger. The ratio is the amount of space to feed back to the lines, to the total amount of space.

Parameters:

ratio - The ratio on the total amount of space to feedback.

setGraphLinesWithinCategoryOverlapRatio

public void setGraphLinesWithinCategoryOverlapRatio(float ratio)

Specifies how much the lines can overlap eachother when there are multiple data values per data set and per data category.

Parameters:

ratio - The ratio on the thickness of the line for overlap.

setGraphDotsExistence

public void setGraphDotsExistence(boolean existence)

Specifies whether the graph contains dot components.

Parameters:

existence - If true, then the graph contains dots.

setGraphDotsThicknessModel

public void setGraphDotsThicknessModel(int thickness)

Specifies the thickness of the dot components for the chart's model size.

Parameters:

thickness - The model thickness of the dots.

setGraphDotsExcessSpaceFeedbackRatio

public void setGraphDotsExcessSpaceFeedbackRatio(float ratio)

Specifies the amount of the excess space to feed back to dots thickness. Frequently the graphs are larger than necessary, the excess space can be fedback to the dots, making them larger. The ratio is the amount of space to feed back to the dots, to the total amount of space.

Parameters:

ratio - The ratio on the total amount of space to feedback.

setGraphDotsWithinCategoryOverlapRatio

public void setGraphDotsWithinCategoryOverlapRatio(float ratio)

Specifies how much the dots can overlap eachother when there are multiple data values per data set and per data category.

Parameters:

ratio - The ratio on the thickness of the dot for overlap.

setGraphNumbersLinesExistence

public void setGraphNumbersLinesExistence(boolean existence)

Specifies whether the horizontal lines of this graph exist. These lines are aligned with the axis' ticks. For each chart this graph is added to, this property will only be respected if its the first graph added that the chart; otherwise, graphs added after any chart would paint over the previous graph's components.

Parameters:

existence - If true, the horizontal lines exist.

setGraphNumbersLinesThicknessModel

public void setGraphNumbersLinesThicknessModel(int thickness)

Specifies the thickness of the horizontal lines of this graph for the chart's model size. These lines are aligned with the axis's ticks. For each chart this graph is added to, this property will only be respected if its the first graph added that the chart; otherwise, graphs added after any chart would paint over the previous graph's components.

Parameters:

thickness - The model thickness of the horizontal lines.

setGraphNumbersLinesStyle

public void setGraphNumbersLinesStyle(float[] style)

Specifies the style of the horizontal lines of this graph. These lines are aligned with the axis's ticks. For each chart this graph is added to, this property will only be respected if its the first graph added that the chart; otherwise, graphs added after any chart would paint over the previous graph's components. Possible values for style are: CONTINUOUS, DASHED, and DOTTED.

Parameters:

style - The style of the horizontal lines.

setGraphNumbersLinesColor

public void setGraphNumbersLinesColor(java.awt.Color color)

Specifies the color of the horizontal lines of this graph. These lines are aligned with the axis's ticks. For each chart this graph is added to, this property will only be respected if its the first graph added that the chart; otherwise, graphs added after any chart would paint over the previous graph's components.

Parameters:

color - The color of the horizontal lines.

setGraphLabelsLinesExistence

public void setGraphLabelsLinesExistence(boolean existence)

Specifies whether the vertical lines of this graph exist. These lines are aligned with the axis' ticks. For each chart this graph is added to, this property will only be respected if its the first graph added that the chart; otherwise, graphs added after any chart would paint over the previous graph's components.

Parameters:

existence - If true, the vertical lines exist.

setGraphLabelsLinesThicknessModel

public void setGraphLabelsLinesThicknessModel(int thickness)

Specifies the thickness of the vertical lines of this graph for the chart's model size. These lines are aligned with the axis's ticks. For each chart this graph is added to, this property will only be respected if its the first graph added that the chart; otherwise, graphs added after any chart would paint over the previous graph's components.

Parameters:

thickness - The model thickness of the vertical lines.

setGraphLabelsLinesStyle

public void setGraphLabelsLinesStyle(float[] style)

Specifies the style of the vertical lines of this graph. These lines are aligned with the axis's ticks. For each chart this graph is added to, this property will only be respected if its the first graph added that the chart; otherwise, graphs added after any chart would paint over the previous graph's components. Possible values for style are: CONTINUOUS, DASHED, and DOTTED.

Parameters:

style - The style of the vertical lines.

setGraphLabelsLinesColor

public void setGraphLabelsLinesColor(java.awt.Color color)

Specifies the color of the vertical lines of this graph. These lines are aligned with the axis's ticks. For each chart this graph is added to, this property will only be respected if its the first graph added that the chart; otherwise, graphs added after any chart would paint over the previous graph's components.

Parameters:

color - The color of the vertical lines.

setGraphLinesThicknessAssociation

public void setGraphLinesThicknessAssociation(boolean association)

Specifies whether the horizontal and vertical lines (if they both exist) should both be the same thickness at all times. Uses the smaller thickness if they are not already equal.

Parameters:

association - If true, then these lines will have equal thickness.

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.

getDataset

public Dataset getDataset()

Returns the raw data sets for this graph of the chart. Chart data sets are related to graphs so that different data sets can be graphed by different graph componenents (ie lines, dots or bars).

Returns:

float[][] The data sets for this graph.

getGraphChart2DVector

public java.util.Vector getGraphChart2DVector()

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

Returns:

Vector The associated GraphChart2D objects.

getGraphBackgroundExistence

public boolean getGraphBackgroundExistence()

Returns whether the background of this graph exists. For each chart this graph is added to, this property will only be respected if its the first graph added that the chart; otherwise, graphs added after any chart would totally paint over the previous graph.

Returns:

boolean If true, the background of this graph will exist.

getGraphBackgroundColor

public java.awt.Color getGraphBackgroundColor()

Returns the color of the background of this graph. For each chart this graph is added to, this property will only be respected if its the first graph added that the chart; otherwise, graphs added after any chart would totally paint over the previous graph.

Returns:

Color The color of the background of this graph.

getGraphBorderLeftBottomExistence

public boolean getGraphBorderLeftBottomExistence()

Returns whether the graph's left and bottom border exists.

Returns:

boolean If true, then the graph's left and bottom border exists.

getGraphBorderLeftBottomThicknessModel

public int getGraphBorderLeftBottomThicknessModel()

Returns the thickness of the graph's left and bottom border for the chart's model size.

Returns:

int The model thickness of the graph's left and bottom border.

getGraphBorderLeftBottomColor

public java.awt.Color getGraphBorderLeftBottomColor()

Returns the color of the graph's left and bottom border.

Returns:

Color The color of the graph's left and bottom border.

getGraphBorderRightTopExistence

public boolean getGraphBorderRightTopExistence()

Returns whether the graph's right and top border exists.

Returns:

boolean If true, then the graph's right and top border exists.

getGraphBorderRightTopThicknessModel

public int getGraphBorderRightTopThicknessModel()

Returns the thickness of the graph's right and top border for the chart's model size.

Returns:

int The model thickness of the graph's right and top border.

getGraphBorderRightTopColor

public java.awt.Color getGraphBorderRightTopColor()

Returns the color of the graph's right and top border.

Returns:

Color The color of the graph's right and top border.

getGraphAllowComponentAlignment

public boolean getGraphAllowComponentAlignment()

Returns whether the graph's components (ie bars, dots, or lines) are allowed to overlap/align or are offset for each set and within each category. For non-stacked bars charts, don't align; for all other chart types alignment is generally preferrable.

Returns:

boolean If true, the components will not be offset within the category.

getGraphOutlineComponentsExistence

public boolean getGraphOutlineComponentsExistence()

Returns whether there exists a thin outline around each component (ie bars, lines, or dots).

Returns:

boolean If true, the components will have an outline.

getGraphOutlineComponentsColor

public java.awt.Color getGraphOutlineComponentsColor()

Returns the color of the thin outline around components (ie bars, lines, or dots).

Returns:

Color The color of each component's outline.

getGraphBetweenComponentsGapExistence

public boolean getGraphBetweenComponentsGapExistence()

Returns whether a gap between each category of components exists (ie not the gap between each each component with each category).

Returns:

boolean If true, then the gap between components exists.

getGraphBetweenComponentsGapThicknessModel

public int getGraphBetweenComponentsGapThicknessModel()

Returns the thickness of the gap between each category of components for the chart's model size.

Returns:

int The model thickness of teh gap between components.

getGraphBarsExistence

public boolean getGraphBarsExistence()

Returns whether the graph contains bar components.

Returns:

boolean If true, then the graph contains bars.

getGraphBarsThicknessModel

public int getGraphBarsThicknessModel()

Returns the thickness of the bar components for the chart's model size.

Returns:

int The model thickness of the bars.

getGraphBarsExcessSpaceFeedbackRatio

public float getGraphBarsExcessSpaceFeedbackRatio()

Returns the amount of the excess space to feed back to bars thickness. Frequently the graphs are larger than necessary, the excess space can be fedback to the bars, making them larger. The ratio is the amount of space to feed back to the bars, to the total amount of space.

Returns:

float The ratio on the total amount of space to feedback.

getGraphBarsWithinCategoryOverlapRatio

public float getGraphBarsWithinCategoryOverlapRatio()

Returns how much the bars can overlap eachother when there are multiple data values per data set and per data category.

Returns:

ratio The ratio on the thickness of the bar for overlap.

getGraphLinesExistence

public boolean getGraphLinesExistence()

Returns whether the graph contains line components.

Returns:

boolean If true, then the graph contains lines.

getGraphLinesThicknessModel

public int getGraphLinesThicknessModel()

Returns the thickness of the line components for the chart's model size.

Returns:

int The model thickness of the lines.

getGraphLinesFillInterior

public boolean getGraphLinesFillInterior()

Returns whether the graph lines will made to form a shap (ie like a mountain range).

Returns:

boolean If true, then the lines will be filled.

getGraphLinesExcessSpaceFeedbackRatio

public float getGraphLinesExcessSpaceFeedbackRatio()

Returns the amount of the excess space to feed back to lines thickness. Frequently the graphs are larger than necessary, the excess space can be fedback to the lines, making them larger. The ratio is the amount of space to feed back to the lines, to the total amount of space.

Returns:

float The ratio on the total amount of space to feedback.

getGraphLinesWithinCategoryOverlapRatio

public float getGraphLinesWithinCategoryOverlapRatio()

Returns how much the lines can overlap eachother when there are multiple data values per data set and per data category.

Returns:

ratio The ratio on the thickness of the line for overlap.

getGraphDotsExistence

public boolean getGraphDotsExistence()

Returns whether the graph contains dot components.

Returns:

boolean If true, then the graph contains dots.

getGraphDotsThicknessModel

public int getGraphDotsThicknessModel()

Returns the thickness of the dot components for the chart's model size.

Returns:

int The model thickness of the dots.

getGraphDotsExcessSpaceFeedbackRatio

public float getGraphDotsExcessSpaceFeedbackRatio()

Returns the amount of the excess space to feed back to dots thickness. Frequently the graphs are larger than necessary, the excess space can be fedback to the dots, making them larger. The ratio is the amount of space to feed back to the dots, to the total amount of space.

Returns:

float The ratio on the total amount of space to feedback.

getGraphDotsWithinCategoryOverlapRatio

public float getGraphDotsWithinCategoryOverlapRatio()

Returns how much the dots can overlap eachother when there are multiple data values per data set and per data category.

Returns:

ratio The ratio on the thickness of the dot for overlap.

getGraphNumbersLinesExistence

public boolean getGraphNumbersLinesExistence()

Returns whether the horizontal lines of this graph exist. These lines are aligned with the axis' ticks. For each chart this graph is added to, this property will only be respected if its the first graph added that the chart; otherwise, graphs added after any chart would paint over the previous graph's components.

Returns:

boolean If true, the horizontal lines exist.

getGraphNumbersLinesThicknessModel

public int getGraphNumbersLinesThicknessModel()

Returns the thickness of the horizontal lines of this graph for the chart's model size. These lines are aligned with the axis's ticks. For each chart this graph is added to, this property will only be respected if its the first graph added that the chart; otherwise, graphs added after any chart would paint over the previous graph's components.

Returns:

int The model thickness of the horizontal lines.

getGraphNumbersLinesStyle

public float[] getGraphNumbersLinesStyle()

Returns the style of the horizontal lines of this graph. These lines are aligned with the axis's ticks. For each chart this graph is added to, this property will only be respected if its the first graph added that the chart; otherwise, graphs added after any chart would paint over the previous graph's components. Possible values for style are: CONTINUOUS, DASHED, and DOTTED.

Returns:

float[] The style of the horizontal lines.

getGraphNumbersLinesColor

public java.awt.Color getGraphNumbersLinesColor()

Returns the color of the horizontal lines of this graph. These lines are aligned with the axis's ticks. For each chart this graph is added to, this property will only be respected if its the first graph added that the chart; otherwise, graphs added after any chart would paint over the previous graph's components.

Returns:

Color The color of the horizontal lines.

getGraphLabelsLinesExistence

public boolean getGraphLabelsLinesExistence()

Returns whether the vertical lines of this graph exist. These lines are aligned with the axis' ticks. For each chart this graph is added to, this property will only be respected if its the first graph added that the chart; otherwise, graphs added after any chart would paint over the previous graph's components.

Returns:

boolean If true, the vertical lines exist.

getGraphLabelsLinesThicknessModel

public int getGraphLabelsLinesThicknessModel()

Returns the thickness of the vertical lines of this graph for the chart's model size. These lines are aligned with the axis's ticks. For each chart this graph is added to, this property will only be respected if its the first graph added that the chart; otherwise, graphs added after any chart would paint over the previous graph's components.

Returns:

int The model thickness of the vertical lines.

getGraphLabelsLinesStyle

public float[] getGraphLabelsLinesStyle()

Returns the style of the vertical lines of this graph. These lines are aligned with the axis's ticks. For each chart this graph is added to, this property will only be respected if its the first graph added that the chart; otherwise, graphs added after any chart would paint over the previous graph's components. Possible values for style are: CONTINUOUS, DASHED, and DOTTED.

Returns:

float[] The style of the vertical lines.

getGraphLabelsLinesColor

public java.awt.Color getGraphLabelsLinesColor()

Returns the color of the vertical lines of this graph. These lines are aligned with the axis's ticks. For each chart this graph is added to, this property will only be respected if its the first graph added that the chart; otherwise, graphs added after any chart would paint over the previous graph's components.

Returns:

Color The color of the vertical lines.

getGraphLinesThicknessAssociation

public boolean getGraphLinesThicknessAssociation()

Returns whether the horizontal and vertical lines (if they both exist) should both be the same thickness at all times. Uses the smaller thickness if they are not already equal.

Returns:

boolean If true, then these lines will have equal thickness.

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.

validate

public boolean validate(boolean debug)

Validates all the properties of this graph. Does not validate the dataset.

Parameters:

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

getGraphChart2DNeedsUpdate

boolean getGraphChart2DNeedsUpdate(GraphChart2D graphChart2D)

Gets whether any properties have changed since this GraphChart2D object's last update.

Returns:

boolean If true, then some properties have changed.

addGraphChart2D

void addGraphChart2D(GraphChart2D graphChart2D)

Adds a GraphChart2D object to the set of objects using 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 using this properties object.

Parameters:

graphChart2D - The object to disassociate from these properties.

updateGraphChart2D

void updateGraphChart2D(GraphChart2D graphChart2D,
                        int graphIndex)

Updates a graph area of a GraphChart2D object if the graph area needs to be updated.

Parameters:

graphChart2D - The GraphChart2D object that contains the graph.

graphIndex - The graph to update.