LegendProperties() Creates a LegendProperties object with the documented default values.
public
LegendProperties(LegendProperties legendProps) Creates a LegendProperties object with property values copied from another object.
Method Summary
final void
addChart2D(Chart2D chart2D) Adds a Chart2D to the set of objects using these properties.
final boolean
getChart2DNeedsUpdate(Chart2D chart2D) Gets whether this object needs to be updated with new properties.
Parameters: chart2D - The object that may need to be updated.
setLegendBetweenLabelsOrBulletsGapThicknessModel(int thickness) Sets the thickness of the gap between the legend's bullets or labels
exists in their vertical placement, for the chart's model size.
validate(boolean debug) Validates the properties of this object.
If debug is true then prints a messages indicating whether each property is valid.
Returns true if all the properties were valid and false otherwise.
Parameters: debug - If true then will print status messages.
Field Detail
LEGEND_BACKGROUND_COLOR_DEFAULT
final public static Color LEGEND_BACKGROUND_COLOR_DEFAULT(Code)
The default is Color.white.
LEGEND_BACKGROUND_EXISTENCE_DEFAULT
final public static boolean LEGEND_BACKGROUND_EXISTENCE_DEFAULT(Code)
Creates a LegendProperties object with property values copied from another object.
The copying is a deep copy.
Parameters: legendProps - The properties to copy.
Adds a Chart2D to the set of objects using these properties.
Parameters: chart2D - The Object2D to add.
getChart2DNeedsUpdate
final boolean getChart2DNeedsUpdate(Chart2D chart2D)(Code)
Gets whether this object needs to be updated with new properties.
Parameters: chart2D - The object that may need to be updated. If true then needs update.
getLegendBackgroundColor
final publicColor getLegendBackgroundColor()(Code)
Gets the color of the legend's background.
Color The color of the legend's background.
getLegendBackgroundExistence
final public boolean getLegendBackgroundExistence()(Code)
Gets whether the legend will have a painted background or not. If not
whatever is behind the legend will show through the spaces of the legend.
boolean If true, the background of the legend will be painted.
getLegendBetweenLabelsAndBulletsGapExistence
final public boolean getLegendBetweenLabelsAndBulletsGapExistence()(Code)
Gets whether the gap between the legend's bullets and labels exists
in their horizontal placement.
boolean If true, a gap exists.
getLegendBetweenLabelsAndBulletsGapThicknessModel
final public int getLegendBetweenLabelsAndBulletsGapThicknessModel()(Code)
Gets the thickness of the gap between the legend's bullets and labels
in their horizontal placement, for the chart's model size.
int The model thickness of teh gap.
getLegendBetweenLabelsOrBulletsGapExistence
final public boolean getLegendBetweenLabelsOrBulletsGapExistence()(Code)
Gets whether a gap between the legend's bullets or labels exists in
their vertical placement.
boolean If true, a gap exists.
getLegendBetweenLabelsOrBulletsGapThicknessModel
final public int getLegendBetweenLabelsOrBulletsGapThicknessModel()(Code)
Gets the thickness of the gap between the legend's bullets or labels
exists in their vertical placement, for the chart's model size.
int The model thickness of the gap.
Gets the texts of the legend labels. The number of texts must be
equal to the total number of data sets of this chart.
String[] The texts for the legend labels.
Removes a Chart2D from the set of objects using these properties.
Parameters: chart2D - The Object2D to add.
setLegendBackgroundColor
final public void setLegendBackgroundColor(Color color)(Code)
Sets the color of the legend's background.
Parameters: color - The color of the legend's background.
setLegendBackgroundExistence
final public void setLegendBackgroundExistence(boolean existence)(Code)
Sets whether the legend will have a painted background or not. If not
whatever is behind the legend will show through the spaces of the legend.
Parameters: existence - If true, the background of the legend will be painted.
setLegendBetweenLabelsAndBulletsGapExistence
final public void setLegendBetweenLabelsAndBulletsGapExistence(boolean existence)(Code)
Sets whether the gap between the legend's bullets and labels exists
in their horizontal placement.
Parameters: existence - If true, a gap exists.
setLegendBetweenLabelsAndBulletsGapThicknessModel
final public void setLegendBetweenLabelsAndBulletsGapThicknessModel(int thickness)(Code)
Sets the thickness of the gap between the legend's bullets and labels
in their horizontal placement, for the chart's model size.
Parameters: thickness - The model thickness of teh gap.
setLegendBetweenLabelsOrBulletsGapExistence
final public void setLegendBetweenLabelsOrBulletsGapExistence(boolean existence)(Code)
Sets whether a gap between the legend's bullets or labels exists in
their vertical placement.
Parameters: existence - If true, a gap exists.
setLegendBetweenLabelsOrBulletsGapThicknessModel
final public void setLegendBetweenLabelsOrBulletsGapThicknessModel(int thickness)(Code)
Sets the thickness of the gap between the legend's bullets or labels
exists in their vertical placement, for the chart's model size.
Parameters: thickness - The model thickness of the gap.
setLegendBorderColor
final public void setLegendBorderColor(Color color)(Code)
Sets the color of the border around the legend.
Parameters: color - The color of the legend's border.
setLegendBorderExistence
final public void setLegendBorderExistence(boolean existence)(Code)
Sets whether there will exist a border around the legend.
Parameters: existence - If true, there will be a border around the legend.
setLegendBorderThicknessModel
final public void setLegendBorderThicknessModel(int thickness)(Code)
Sets the thickness of the border around the legend for the chart's
model size.
Parameters: thickness - The model thicknes for the chart.
setLegendBulletsOutlineColor
final public void setLegendBulletsOutlineColor(Color color)(Code)
Sets the color of the legend's bullets outline.
Parameters: color - The color of the legend's bullets outline.
setLegendBulletsOutlineExistence
final public void setLegendBulletsOutlineExistence(boolean existence)(Code)
Sets whether a thin line is painted around the legend's bullets.
Parameters: existence - If true, the legend's bullets will be outlined.
setLegendBulletsSizeModel
final public void setLegendBulletsSizeModel(Dimension size)(Code)
Sets the size of the legend's bullets for the chart's model size.
Parameters: size - The size of the legend's bullets.
setLegendExistence
final public void setLegendExistence(boolean existence)(Code)
Sets whether there will exist a legend on the chart.
Parameters: existence - If true, there will be a legend for the chart.
setLegendGapExistence
final public void setLegendGapExistence(boolean existence)(Code)
Sets whether a gap between the legend's border or edge and the
legend's inner components exists.
Parameters: existence - If true, then a gap exists.
setLegendGapThicknessModel
final public void setLegendGapThicknessModel(int thickness)(Code)
Sets the thickness of the legend's gap for the chart's model size.
Parameters: thickness - The model thickness of the legend's gap.
setLegendLabelsFontColor
final public void setLegendLabelsFontColor(Color color)(Code)
Sets the color of the font of the legend's labels.
Parameters: color - The color of the font of the legend's labels.
setLegendLabelsFontName
final public void setLegendLabelsFontName(String name)(Code)
Sets name of the font of the legend's labels.
Accepts all values accepted by java.awt.Font.
Parameters: name - The name of the font for the legend's labels.
setLegendLabelsFontPointModel
final public void setLegendLabelsFontPointModel(int point)(Code)
Sets the point of the font of the legend's labels for the chart's
model size.
Parameters: point - The model font point of the legend's labels.
setLegendLabelsFontStyle
final public void setLegendLabelsFontStyle(int style)(Code)
Sets the style of the font of the legend's labels.
Accepts all values that java.awt.Font accepts.
Parameters: style - The style of the font of the legend's labels.
setLegendLabelsTexts
final public void setLegendLabelsTexts(String[] texts)(Code)
Sets 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.
Validates the properties of this object.
If debug is true then prints a messages indicating whether each property is valid.
Returns true if all the properties were valid and false otherwise.
Parameters: debug - If true then will print status messages. If true then valid.
Methods inherited from net.sourceforge.chart2d.Properties