Class Chart2
- All Implemented Interfaces:
BorderProperties
,GeneralProperties
,HyperlinkProperties
,NodeParser
,com.inet.report.ReferenceHolder
,Serializable
,Cloneable
To create a new chart use Section.addChart2(ChartStyle, int, int, int, int)
.
To change the chart style use setPlot(ChartPlot)
.
A chart instance contains properties of the chart titles (header, subtitle, footnote), legend and plot properties.
If you want to edit the style specific properties you can get the plot with getPlot()
and cast it to
the plot which belong to this chart style. For more information see the class ChartStyle
.
If you create a new chart all properties except dataset are initialized with default.
To set the dataset properties use ChartPlot.getDataset()
.
For more information see the class BaseDataset
.
For the information how to use the old chart API please see ChartConverter
.
-
Nested Class Summary
Nested classes/interfaces inherited from class com.inet.report.Element
Element.BorderProps, Element.CommonProperties, Element.ElementTypes, Element.HyperlinkProps, Element.StringProps
-
Field Summary
Modifier and TypeFieldDescriptionstatic final ChartStyle
Default chart style.static final String
the default font used by chart.static final ChartTitle
the default font and color properties of footnote title of chart.static final ChartTitle
The default font and color properties of header title of chart.static final ChartTitle
the default font and color properties of subtitle title of chart.static final String
A constant for the horizontal orientation of chart.static final String
A constant for the vertical orientation of chart.Fields inherited from class com.inet.report.Element
BOX, CHART, CROSSTAB, CROSSTABSECTION, DATABASE_PICTURE, FIELD, FIELDPART, FORMFIELD, INTERACTIVE_SORTING, JAVABEAN, LINE, PARAGRAPH, PICTURE, SIGNATURE, SUBREPORT, TEXT, TEXTPART
Fields inherited from interface com.inet.report.BorderProperties
LINE_STYLE_DASHED, LINE_STYLE_DOTTED, LINE_STYLE_DOUBLE, LINE_STYLE_SINGLE, NO_LINE
Fields inherited from interface com.inet.report.GeneralProperties
ALIGN_HORIZONTAL_CENTER, ALIGN_HORIZONTAL_DEFAULT, ALIGN_HORIZONTAL_JUSTIFIED, ALIGN_HORIZONTAL_LEFT, ALIGN_HORIZONTAL_RIGHT
-
Method Summary
Modifier and TypeMethodDescriptionReturns the footnote of this chart.Returns the header title of this chart.Returns the legend of this chart.Returns a localized resources bundle for the chart messages.getPlot()
Returns the plot of chart.Returns the plot orientation of this chart.FOR INTERNAL USE ONLY Returns a list of all referenced property formulas.List<? extends ReportComponent>
Returns allReportComponent
s that are descendants of this one.Returns the sub title of this chart.boolean
FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLvoid
FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLvoid
Reads out the data column names from dataset and refreshes the chart labels.void
FOR INTERNAL USE ONLYvoid
setFootnote
(ChartTitle footnote) Sets the footnote of this chart.void
setHeaderTitle
(ChartTitle headerTitle) Sets the header title of this chart.void
Sets the legend of this chart.void
Sets a new plot for this chart.void
setPlotOrientation
(String plotOrientation) Sets the plot orientation of this chart.void
FOR INTERNAL USE ONLYvoid
setSubtitle
(ChartTitle subtitle) Sets the sub title of this chart.void
FOR INTERNAL USE ONLYMethods inherited from class com.inet.report.Element
addListener, copy, getBottomLineStyle, getBottomLineStyleFormula, getBulletValueStack, getCanGrowCount, getCanGrowFormula, getCloseBorderOnPageBreakFormula, getDropShadowFormula, getEngine, getField, getForeColor, getForeColorFormula, getHorAlign, getHorAlignFormula, getHyperlinkUrl, getHyperlinkUrlFormula, getLeftLineStyle, getLeftLineStyleFormula, getListStack, getParent, getRightLineStyle, getRightLineStyleFormula, getSuppressIfDuplicatedFormula, getTightHorizontalFormula, getToolTipsText, getToolTipsTextFormula, getTopLineStyle, getTopLineStyleFormula, getTypeAsString, indexOf, isCanGrow, isCloseBorderOnPageBreak, isCloseBorderOnPageBreakInternal, isDropShadow, isInCrossTab, isSuppressIfDuplicated, isTightHorizontal, paramString, parseElement, parseText, removeListener, setBottomLineStyle, setBottomLineStyleFormula, setBulletValueStack, setCanGrow, setCanGrowCount, setCanGrowFormula, setCloseBorderOnPageBreak, setCloseBorderOnPageBreakFormula, setDropShadow, setDropShadowFormula, setField, setForeColor, setForeColorFormula, setHorAlign, setHorAlignFormula, setHyperlinkUrl, setHyperlinkUrlFormula, setIndex, setLeftLineStyle, setLeftLineStyleFormula, setListStack, setRightLineStyle, setRightLineStyleFormula, setSuppressIfDuplicated, setSuppressIfDuplicatedFormula, setTightHorizontal, setTightHorizontalFormula, setToolTipsText, setToolTipsTextFormula, setTopLineStyle, setTopLineStyleFormula
Methods inherited from class com.inet.report.ReportComponent
addPropertyChangeListener, addPropertyChangeListener, addReferencedObject, addVetoableChangeListener, addVetoableChangeListener, getBackColor, getBackColorFormula, getCustomData, getHeight, getKeepTogetherFormula, getRealReferencedObjectCount, getReferencedObjectCount, getReferencedObjects, getSuppressFormula, getType, getWidth, getX, getY, isKeepTogether, isSuppress, parseEndElement, removePropertyChangeListener, removePropertyChangeListener, removeReferencedObject, removeVetoableChangeListener, removeVetoableChangeListener, setBackColor, setBackColorFormula, setCustomData, setHeight, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula, setWidth, setX, setY
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.BorderProperties
getBackColor, getBackColorFormula, getBottomLineStyle, getBottomLineStyleFormula, getCloseBorderOnPageBreakFormula, getDropShadowFormula, getForeColor, getForeColorFormula, getLeftLineStyle, getLeftLineStyleFormula, getRightLineStyle, getRightLineStyleFormula, getTightHorizontalFormula, getTopLineStyle, getTopLineStyleFormula, isCloseBorderOnPageBreak, isDropShadow, isTightHorizontal, setBackColor, setBackColorFormula, setBottomLineStyle, setBottomLineStyleFormula, setCloseBorderOnPageBreak, setCloseBorderOnPageBreakFormula, setDropShadow, setDropShadowFormula, setForeColor, setForeColorFormula, setLeftLineStyle, setLeftLineStyleFormula, setRightLineStyle, setRightLineStyleFormula, setTightHorizontal, setTightHorizontalFormula, setTopLineStyle, setTopLineStyleFormula
Methods inherited from interface com.inet.report.GeneralProperties
getKeepTogetherFormula, getSuppressFormula, isKeepTogether, isSuppress, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula
Methods inherited from interface com.inet.report.HyperlinkProperties
getHyperlinkUrl, getHyperlinkUrlFormula, setHyperlinkUrl, setHyperlinkUrlFormula
-
Field Details
-
DEFAULT_CHART_STYLE
Default chart style. This style will be used by creating a chart without custom chart style. -
DEFAULT_FONT_NAME
the default font used by chart.- See Also:
-
DEFAULT_HEADER_TITLE
The default font and color properties of header title of chart. -
DEFAULT_SUBTITLE_TITLE
the default font and color properties of subtitle title of chart. -
DEFAULT_FOOTNOTE_TITLE
the default font and color properties of footnote title of chart. -
PLOT_ORIENTATION_VERTICAL
A constant for the vertical orientation of chart.- See Also:
-
PLOT_ORIENTATION_HORIZONTAL
A constant for the horizontal orientation of chart.- See Also:
-
-
Method Details
-
getPlotOrientation
Returns the plot orientation of this chart.- Returns:
- the orientation name.
- Since:
- 8.0
- See Also:
-
setPlotOrientation
Sets the plot orientation of this chart.- Parameters:
plotOrientation
- the plot orientation name (null
not permitted).- Throws:
IllegalArgumentException
- bynull
or unknown plot orientation.- Since:
- 8.0
- See Also:
-
getHeaderTitle
Returns the header title of this chart.- Returns:
- the chart title.
- Since:
- 8.0
- See Also:
-
setHeaderTitle
Sets the header title of this chart.- Parameters:
headerTitle
- the title (null
not permitted).- Since:
- 8.0
- See Also:
-
getSubtitle
Returns the sub title of this chart. The sub title is the title below the header.- Returns:
- the chart title.
- Since:
- 8.0
- See Also:
-
setSubtitle
Sets the sub title of this chart. The sub title is the title below the header.- Parameters:
subtitle
- the title (null
not permitted).- Since:
- 8.0
- See Also:
-
getFootnote
Returns the footnote of this chart. The footnote is the title of the bottom bound of chart.- Returns:
- the chart title.
- Since:
- 8.0
- See Also:
-
setFootnote
Sets the footnote of this chart. The footnote is the title of the bottom bound of chart.- Parameters:
footnote
- the title (null
not permitted).- Since:
- 8.0
- See Also:
-
getPlot
Returns the plot of chart. This can be a simple plot extended fromAbstractPlot
or aCombinedPlot
with a list of simple plots. A plot of typeAbstractPlot
you can cast to a plot appropriate to chart style. See the implementations of interfaceChartStyle
.- Returns:
- the plot.
- Since:
- 8.0
- See Also:
-
setPlot
Sets a new plot for this chart. This can be a simple plot extended fromAbstractPlot
or aCombinedPlot
with a list of simple plots.
To change the chart style use a.s.LineStyle.LINE_MARKER_STACKED
to get a stacked line style, useLineStyle.getDefaultPlot()
to get a new line plot and set it with this function.- Parameters:
plot
- the plot (null
not permitted).- Since:
- 8.0
- See Also:
-
getLegend
Returns the legend of this chart.- Returns:
- the legend.
- Since:
- 8.0
- See Also:
-
setLegend
Sets the legend of this chart. To disable legend showing useLegend.setLegendPlacement(com.inet.report.chart.LegendPlacement)
with parameterLegendPlacement.NONE
.- Parameters:
legend
- the legend (null
not permitted).- Since:
- 8.0
- See Also:
-
refreshAutoTitles
public void 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.- Since:
- 8.0
-
getLocalizationResources
Returns a localized resources bundle for the chart messages. The chart uses the client locale.- Returns:
- the bundle.
- Since:
- 8.0
- See Also:
-
getPropertyFormulas
FOR INTERNAL USE ONLY Returns a list of all referenced property formulas.- Overrides:
getPropertyFormulas
in classElement
- Returns:
- the list of referenced objects.
-
resetReferences
public void resetReferences()FOR INTERNAL USE ONLY- Specified by:
resetReferences
in interfacecom.inet.report.ReferenceHolder
- Overrides:
resetReferences
in classReportComponent
-
setReferences
public void setReferences()FOR INTERNAL USE ONLY- Specified by:
setReferences
in interfacecom.inet.report.ReferenceHolder
- Overrides:
setReferences
in classElement
-
updateReferences
public void updateReferences()FOR INTERNAL USE ONLY -
isDOMParser
public boolean isDOMParser()FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLReturns whether this node is to be read via a DOM parser.
- Specified by:
isDOMParser
in interfaceNodeParser
- Overrides:
isDOMParser
in classReportComponent
- Returns:
- true if this node is to be read via a DOM parser, false otherwise.
-
parseDOM
FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLParses the node.
- Specified by:
parseDOM
in interfaceNodeParser
- Overrides:
parseDOM
in classReportComponent
- Parameters:
node
- the nodeparserMap
- The map of current Parser.- Throws:
FatalParserException
- if an exception occurs which causes the report to not be able to be read: causes the abortion of the reading of the report.
-
getSubComponents
Returns allReportComponent
s that are descendants of this one. E.G. this will return all Element of aSection
. But it's as well useful forCrossTab
s orText
elements which have additional elements.- Specified by:
getSubComponents
in classReportComponent
- Returns:
- a list with all sub components which can be empty as well; will be
null
if the component has no descendants
-