Package com.inet.report.chart.plot
Class AbstractPlot
java.lang.Object
com.inet.report.chart.plot.AbstractPlot
- All Implemented Interfaces:
ChartPlot
,Serializable
- Direct Known Subclasses:
GanttPlot
,PiePlot
,StandardPlot
,StockPlot
,XYPlot
A general plotting class with common properties used by all chart plots.
- Since:
- 8.0
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
The gradient paint setting for the colorization of the chart items. -
Field Summary
Modifier and TypeFieldDescriptionstatic final Color[]
The default order of colors.static final float
The default foreground alphastatic final int
Default color of the item labels.static final Font
Default font of the item labels.static final int
Default outline color.static final int
Default outline style.static final int
Default outline width.static final String
XML token for a plot element. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionint
Returns the ABGR value representing the background color.Returns the color formula which determines the color at run-time.Color[]
Returns the user defined color sequence of this chart plot.float
Returns the alpha value for the foreground color: 1.0 is fully opaque, while 0.0 is fully transparent.Returns the gradient paint settings.int
Returns the ABGR value representing the color of the item labels.Returns font for the item labels.Returns the format for the item value.Returns the format formula for the item values.Returns the item shape settings for this plot.int
Returns the ABGR value representing the chart items outline color.int
Returns the chart items' outline style.int
Returns the chart outline's width.abstract ChartStyle
getStyle()
Returns the style of this chart, ie. the general category this plot belongs to.protected StringBuilder
getSubProperties
(int depth) Returns the serialized simple properties of subclasses.boolean
Returns whether the chart items are colored by series or by groups.boolean
Returns whether or not to draw the outline.boolean
Returns whether identical groups will have the same color.boolean
Returns whether or not to show labels in the plot.boolean
Returns whether or not to show the values in the plot.void
readProperties
(Element element, Chart2 chart) Reads the chart properties from the DOMParser Element.abstract void
refreshAutoTitles
(Chart2 chart) Reads out the data column names from dataset and refreshes the chart labels.void
saveProperties
(PrintWriter out, int depth) Writes the properties of this chart plot toPrintWriter
.protected void
saveSubProperties
(PrintWriter out, int depth) Writes the intern properties to output.void
setBackColor
(int backgroundColor) Sets the ABGR value representing the background color.void
setColorBySeries
(boolean colorBySeries) Sets whether the chart items are colored by series or by groups.void
setColorFormula
(FormulaField colorFormula) Sets the color formula which determines the color at run-time.void
setColorSequence
(Color[] colorSequence) Sets the user defined color sequence for this chart plot.void
setDrawOutline
(boolean drawOutline) Sets whether or not to draw the outline.void
setForegroundAlpha
(float foregroundAlpha) Sets the alpha (opaqueness) value for the foreground color: 1.0 is fully opaque, while 0.0 is fully transparent.void
setGradientSetting
(AbstractPlot.GradientSetting gradientSetting) Sets the gradient paint settings.void
setItemLabelColor
(int itemLabelColor) Sets the ABGR value representing the color of the item labels.void
setItemLabelFont
(Font itemLabelFont) Sets the font of the item labels.void
setItemLabelFormat
(ChartFormat valueFormat) Sets the format for the item value.void
setItemLabelFormatFormula
(FormulaField itemLabelFormula) Set the format formula for the item values.void
setItemShape
(ItemShape itemShape) Sets the item shape properties for this plot.void
setOutlineColor
(int outlineColor) Sets the ABGR components of the chart items outline color.void
setOutlineStyle
(int outlineStyle) Sets the chart items' outline style.void
setOutlineWidth
(int outlineWidth) Sets the chart items' outline width (in twips).void
setSameColorsForSameGroups
(boolean sameColorsForSameGroups) Sets whether identical groups will have the same color.void
setShowLabel
(boolean showLabel) Sets whether or not to show labels in the plot.void
setShowValue
(boolean showValue) Sets whether or not to show the values in the plot.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.inet.report.chart.plot.ChartPlot
getDataset
-
Field Details
-
TOKEN_PLOT
XML token for a plot element.- See Also:
-
DEFAULT_COLOR_SEQUENCE
The default order of colors. -
DEFAULT_FOREGROUND_ALPHA
public static final float DEFAULT_FOREGROUND_ALPHAThe default foreground alpha- See Also:
-
DEFAULT_ITEM_LABEL_FONT
Default font of the item labels. -
DEFAULT_ITEM_LABEL_COLOR
public static final int DEFAULT_ITEM_LABEL_COLORDefault color of the item labels.- See Also:
-
DEFAULT_OUTLINE_STYLE
public static final int DEFAULT_OUTLINE_STYLEDefault outline style.- See Also:
-
DEFAULT_OUTLINE_WIDTH
public static final int DEFAULT_OUTLINE_WIDTHDefault outline width.- See Also:
-
DEFAULT_OUTLINE_COLOR
public static final int DEFAULT_OUTLINE_COLORDefault outline color.
-
-
Constructor Details
-
AbstractPlot
public AbstractPlot()FOR INTERNAL USE ONLY
-
-
Method Details
-
getBackColor
public int getBackColor()Returns the ABGR value representing the background color.- Returns:
- the color.
- Since:
- 8.0
- See Also:
-
setBackColor(int)
ColorUtils.toJavaColor(int)
-
setBackColor
public void setBackColor(int backgroundColor) Sets the ABGR value representing the background color.- Parameters:
backgroundColor
- the background color- Since:
- 8.0
- See Also:
-
getBackColor()
ColorUtils.toCcColor(Color)
-
getItemShape
Returns the item shape settings for this plot.- Returns:
- the ItemShape holding the item shape settings for this plot
- Since:
- 8.0
- See Also:
-
setItemShape
Sets the item shape properties for this plot.- Parameters:
itemShape
- the properties object (null
not permitted)- Since:
- 8.0
- See Also:
-
getOutlineColor
public int getOutlineColor()Returns the ABGR value representing the chart items outline color.- Returns:
- the chart items' outline color.
- Since:
- 8.0
- See Also:
-
setOutlineColor(int)
ColorUtils.toJavaColor(int)
-
setOutlineColor
public void setOutlineColor(int outlineColor) Sets the ABGR components of the chart items outline color.- Parameters:
outlineColor
- the chart items' outline color- Throws:
IllegalArgumentException
- if the color isRDC.COLOR_NO_COLOR
.- Since:
- 8.0
- See Also:
-
getOutlineColor()
ColorUtils.toCcColor(Color)
-
getOutlineStyle
public int getOutlineStyle()Returns the chart items' outline style.- Returns:
- style of the outline
- Since:
- 8.0
- See Also:
-
BorderPropertiesConstants.LINE_STYLE_DASHED
BorderPropertiesConstants.LINE_STYLE_DOTTED
BorderPropertiesConstants.LINE_STYLE_SINGLE
BorderPropertiesConstants.NO_LINE
-
setOutlineStyle
public void setOutlineStyle(int outlineStyle) Sets the chart items' outline style. Chart items are the items used to visualize the data, e.g. bars.- Parameters:
outlineStyle
- the style- Throws:
IllegalArgumentException
- if the parameter is not one of the supported outline styles- Since:
- 8.0
- See Also:
-
getOutlineStyle()
BorderPropertiesConstants.LINE_STYLE_DASHED
BorderPropertiesConstants.LINE_STYLE_DOTTED
BorderPropertiesConstants.LINE_STYLE_SINGLE
BorderPropertiesConstants.NO_LINE
-
getOutlineWidth
public int getOutlineWidth()Returns the chart outline's width.- Returns:
- the width of the chart's outline.
- Since:
- 8.0
-
setOutlineWidth
public void setOutlineWidth(int outlineWidth) Sets the chart items' outline width (in twips). Chart items are the items used to visualize the data, e.g. bars.- Parameters:
outlineWidth
- the outline width of the chart items- Throws:
IllegalArgumentException
- if width is less than 1.- Since:
- 8.0
-
isDrawOutline
public boolean isDrawOutline()Returns whether or not to draw the outline.- Returns:
true
the outline is to be drawn.- Since:
- 8.0
-
setDrawOutline
public void setDrawOutline(boolean drawOutline) Sets whether or not to draw the outline.- Parameters:
drawOutline
-true
if outline is to be drawn.- Since:
- 8.0
-
isShowLabel
public boolean isShowLabel()Returns whether or not to show labels in the plot.- Returns:
true
if labels are to be shown.- Since:
- 8.0
-
setShowLabel
public void setShowLabel(boolean showLabel) Sets whether or not to show labels in the plot.- Parameters:
showLabel
-true
if labels are to be shown.- Since:
- 8.0
-
isShowValue
public boolean isShowValue()Returns whether or not to show the values in the plot.- Returns:
true
if values are to be shown.- Since:
- 8.0
-
setShowValue
public void setShowValue(boolean showValue) Sets whether or not to show the values in the plot.- Parameters:
showValue
- settrue
if values are to be shown.- Since:
- 8.0
-
getItemLabelFormat
Returns the format for the item value.- Returns:
- the format for the item value
- Since:
- 8.0
- See Also:
-
setItemLabelFormat
Sets the format for the item value. The default value of this property isnull
, which means that the values are to be formatted automatically. Note: for chart with number values, only formats extended fromNumberFormat
are allowed, while for date charts, only formats extended fromDateFormat
are allowed.- Parameters:
valueFormat
- the format (null
permitted)- Since:
- 8.0
- See Also:
-
getItemLabelFormatFormula
Returns the format formula for the item values.- Returns:
- the format formula for the item values.
- Since:
- 22.10
- See Also:
-
setItemLabelFormatFormula
Set the format formula for the item values.- Parameters:
itemLabelFormula
- the formula- Since:
- 22.10
-
isSameColorsForSameGroups
public boolean isSameColorsForSameGroups()Returns whether identical groups will have the same color.- Returns:
true
if the same color is to be used for identical groups.- Since:
- 8.0
-
setSameColorsForSameGroups
public void setSameColorsForSameGroups(boolean sameColorsForSameGroups) Sets whether identical groups will have the same color.- Parameters:
sameColorsForSameGroups
-true
if the same color is to be used for identical groups.- Since:
- 8.0
-
getColorFormula
Returns the color formula which determines the color at run-time.- Returns:
- the colorFormula or
null
if there is none. - Since:
- 8.0
- See Also:
-
setColorFormula
Sets the color formula which determines the color at run-time. Note: this formula should have the typeFormulaField.FORMULA_PROPERTY
.- Parameters:
colorFormula
- the color formula (null
permitted)- Throws:
IllegalArgumentException
- if the formula has the wrong type.- Since:
- 8.0
- See Also:
-
getColorSequence
Returns the user defined color sequence of this chart plot. If this sequence was not set, the chart will use theDEFAULT_COLOR_SEQUENCE
.- Returns:
- the color sequence or
null
which means the default color sequence will be used - Since:
- 8.0
- See Also:
-
setColorSequence
Sets the user defined color sequence for this chart plot. If this sequence was not set chart uses theDEFAULT_COLOR_SEQUENCE
.- Parameters:
colorSequence
- the array of colors (null
permitted)- Throws:
IllegalArgumentException
- if an empty color sequence is passed- Since:
- 8.0
- See Also:
-
getGradientSetting
Returns the gradient paint settings.- Returns:
- the settings or
null
without gradient paint for chart items - Since:
- 11.0
-
setGradientSetting
Sets the gradient paint settings.- Parameters:
gradientSetting
- the gradient paint for the chart items (null
permitted)- Since:
- 11.0
-
isColorBySeries
public boolean isColorBySeries()Returns whether the chart items are colored by series or by groups.- Returns:
- true if the chart items are colored according to their series, and false if the chart items are colored according to their groups
- Since:
- 8.0
- See Also:
-
setColorBySeries
public void setColorBySeries(boolean colorBySeries) Sets whether the chart items are colored by series or by groups. This property works by Bar, Gantt and Chart3D only.- Parameters:
colorBySeries
- true if the chart items are colored according to their series, and false if the chart items are colored according to their groups- Since:
- 8.0
- See Also:
-
getForegroundAlpha
public float getForegroundAlpha()Returns the alpha value for the foreground color: 1.0 is fully opaque, while 0.0 is fully transparent.- Returns:
- the alpha value for the foreground color, between 0.0 and 1.0
- Since:
- 8.0
-
setForegroundAlpha
public void setForegroundAlpha(float foregroundAlpha) Sets the alpha (opaqueness) value for the foreground color: 1.0 is fully opaque, while 0.0 is fully transparent.- Parameters:
foregroundAlpha
- the alpha value for the foreground color- Throws:
IllegalArgumentException
- if foregroundAlpha is less than 0.0 or greater than 1.0.- Since:
- 8.0
-
getItemLabelFont
Returns font for the item labels.- Returns:
- the font for the item labels
- Since:
- 8.0
- See Also:
-
setItemLabelFont
Sets the font of the item labels.- Parameters:
itemLabelFont
- the font (null
not permitted)- Since:
- 8.0
- See Also:
-
getItemLabelColor
public int getItemLabelColor()Returns the ABGR value representing the color of the item labels. UseColorUtils.toJavaColor(int)
to convert this value to a Java Color.- Returns:
- the color of the item labels as an int
- Since:
- 8.0
- See Also:
-
ColorUtils.toJavaColor(int)
setItemLabelColor(int)
-
setItemLabelColor
public void setItemLabelColor(int itemLabelColor) Sets the ABGR value representing the color of the item labels. UseColorUtils.toCcColor(Color)
to convert a Java color to an int value.- Parameters:
itemLabelColor
- ABGR components of the item labels' color- Throws:
IllegalArgumentException
- ifRDC.COLOR_NO_COLOR
is passed.- Since:
- 8.0
- See Also:
-
ColorUtils.toCcColor(Color)
getItemLabelColor()
-
refreshAutoTitles
Reads out the data column names from dataset and refreshes the chart labels. Please use this function to refresh the chart labels if the data was be changed.- Specified by:
refreshAutoTitles
in interfaceChartPlot
- Parameters:
chart
- the chart
-
getStyle
Returns the style of this chart, ie. the general category this plot belongs to.- Returns:
- the style
- Since:
- 8.0
- See Also:
-
getReferencedObject
- Specified by:
getReferencedObject
in interfaceChartPlot
- Returns:
- the list of objects.
-
saveProperties
Writes the properties of this chart plot toPrintWriter
.- Specified by:
saveProperties
in interfaceChartPlot
- Parameters:
out
- the outputdepth
- the depth of XML indent
-
getSubProperties
Returns the serialized simple properties of subclasses.- Parameters:
depth
- the depth of XML indent- Returns:
- the properties.
- Since:
- 8.0
-
saveSubProperties
Writes the intern properties to output. Overwrites this to save intern properties direct toPrintWriter
without building aStringBuilder
.- Parameters:
out
- the outputdepth
- the depth of XML indent- Since:
- 8.0
-
readProperties
Reads the chart properties from the DOMParser Element.- Specified by:
readProperties
in interfaceChartPlot
- Parameters:
element
- the DOMParser Elementchart
- the chart
-