Class Chart2
- java.lang.Object
-
- com.inet.report.ReportComponent
-
- com.inet.report.Element
-
- com.inet.report.Chart2
-
- All Implemented Interfaces:
BorderProperties,GeneralProperties,HyperlinkProperties,NodeParser,com.inet.report.ReferenceHolder,java.io.Serializable,java.lang.Cloneable
public class Chart2 extends Element implements HyperlinkProperties, BorderProperties
This class represents a chart element with new chart API that has been or should be drawn in a report. A chart (or graph) visualize your data with some graphics.To create a new chart use
Section.addChart2(ChartStyle, int, int, int, int).
To change the chart style usesetPlot(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 withgetPlot()and cast it to the plot which belong to this chart style. For more information see the classChartStyle.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 classBaseDataset.For the information how to use the old chart API please see
ChartConverter.- Since:
- 8.0
- See Also:
ChartConverter.replaceChart(OldChart),getHeaderTitle(),getSubtitle(),getFootnote(),getLegend(),getPlot(), Serialized Form
-
-
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
Fields Modifier and Type Field Description static ChartStyleDEFAULT_CHART_STYLEDefault chart style.static java.lang.StringDEFAULT_FONT_NAMEthe default font used by chart.static ChartTitleDEFAULT_FOOTNOTE_TITLEthe default font and color properties of footnote title of chart.static ChartTitleDEFAULT_HEADER_TITLEThe default font and color properties of header title of chart.static ChartTitleDEFAULT_SUBTITLE_TITLEthe default font and color properties of subtitle title of chart.static java.lang.StringPLOT_ORIENTATION_HORIZONTALA constant for the horizontal orientation of chart.static java.lang.StringPLOT_ORIENTATION_VERTICALA 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ChartTitlegetFootnote()Returns the footnote of this chart.ChartTitlegetHeaderTitle()Returns the header title of this chart.LegendgetLegend()Returns the legend of this chart.java.util.ResourceBundlegetLocalizationResources()Returns a localized resources bundle for the chart messages.ChartPlotgetPlot()Returns the plot of chart.java.lang.StringgetPlotOrientation()Returns the plot orientation of this chart.java.util.List<FormulaField>getPropertyFormulas()FOR INTERNAL USE ONLY Returns a list of all referenced property formulas.java.util.List<? extends ReportComponent>getSubComponents()Returns allReportComponents that are descendants of this one.ChartTitlegetSubtitle()Returns the sub title of this chart.booleanisDOMParser()FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLvoidparseDOM(org.w3c.dom.Node node, java.util.Map<java.lang.String,java.lang.Object> parserMap)FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLvoidrefreshAutoTitles()Reads out the data column names from dataset and refreshes the chart labels.voidresetReferences()FOR INTERNAL USE ONLYvoidsetFootnote(ChartTitle footnote)Sets the footnote of this chart.voidsetHeaderTitle(ChartTitle headerTitle)Sets the header title of this chart.voidsetLegend(Legend legend)Sets the legend of this chart.voidsetPlot(ChartPlot plot)Sets a new plot for this chart.voidsetPlotOrientation(java.lang.String plotOrientation)Sets the plot orientation of this chart.voidsetReferences()FOR INTERNAL USE ONLYvoidsetSubtitle(ChartTitle subtitle)Sets the sub title of this chart.voidupdateReferences()FOR INTERNAL USE ONLY-
Methods 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 Detail
-
DEFAULT_CHART_STYLE
public static final ChartStyle DEFAULT_CHART_STYLE
Default chart style. This style will be used by creating a chart without custom chart style.
-
DEFAULT_FONT_NAME
public static final java.lang.String DEFAULT_FONT_NAME
the default font used by chart.- See Also:
- Constant Field Values
-
DEFAULT_HEADER_TITLE
public static final ChartTitle DEFAULT_HEADER_TITLE
The default font and color properties of header title of chart.
-
DEFAULT_SUBTITLE_TITLE
public static final ChartTitle DEFAULT_SUBTITLE_TITLE
the default font and color properties of subtitle title of chart.
-
DEFAULT_FOOTNOTE_TITLE
public static final ChartTitle DEFAULT_FOOTNOTE_TITLE
the default font and color properties of footnote title of chart.
-
PLOT_ORIENTATION_VERTICAL
public static final java.lang.String PLOT_ORIENTATION_VERTICAL
A constant for the vertical orientation of chart.- See Also:
- Constant Field Values
-
PLOT_ORIENTATION_HORIZONTAL
public static final java.lang.String PLOT_ORIENTATION_HORIZONTAL
A constant for the horizontal orientation of chart.- See Also:
- Constant Field Values
-
-
Method Detail
-
getPlotOrientation
public java.lang.String getPlotOrientation()
Returns the plot orientation of this chart.- Returns:
- the orientation name.
- Since:
- 8.0
- See Also:
setPlotOrientation(String),PLOT_ORIENTATION_HORIZONTAL,PLOT_ORIENTATION_VERTICAL
-
setPlotOrientation
public void setPlotOrientation(java.lang.String plotOrientation)
Sets the plot orientation of this chart.- Parameters:
plotOrientation- the plot orientation name (nullnot permitted).- Throws:
java.lang.IllegalArgumentException- bynullor unknown plot orientation.- Since:
- 8.0
- See Also:
getPlotOrientation(),PLOT_ORIENTATION_HORIZONTAL,PLOT_ORIENTATION_VERTICAL
-
getHeaderTitle
public ChartTitle getHeaderTitle()
Returns the header title of this chart.- Returns:
- the chart title.
- Since:
- 8.0
- See Also:
setHeaderTitle(ChartTitle),ChartTitle
-
setHeaderTitle
public void setHeaderTitle(ChartTitle headerTitle)
Sets the header title of this chart.- Parameters:
headerTitle- the title (nullnot permitted).- Since:
- 8.0
- See Also:
getHeaderTitle(),ChartTitle
-
getSubtitle
public ChartTitle 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(com.inet.report.chart.ChartTitle),ChartTitle
-
setSubtitle
public void setSubtitle(ChartTitle subtitle)
Sets the sub title of this chart. The sub title is the title below the header.- Parameters:
subtitle- the title (nullnot permitted).- Since:
- 8.0
- See Also:
getSubtitle(),ChartTitle
-
getFootnote
public ChartTitle 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(com.inet.report.chart.ChartTitle),ChartTitle
-
setFootnote
public void setFootnote(ChartTitle footnote)
Sets the footnote of this chart. The footnote is the title of the bottom bound of chart.- Parameters:
footnote- the title (nullnot permitted).- Since:
- 8.0
- See Also:
getFootnote(),ChartTitle
-
getPlot
public ChartPlot getPlot()
Returns the plot of chart. This can be a simple plot extended fromAbstractPlotor aCombinedPlotwith a list of simple plots. A plot of typeAbstractPlotyou can cast to a plot appropriate to chart style. See the implementations of interfaceChartStyle.- Returns:
- the plot.
- Since:
- 8.0
- See Also:
setPlot(com.inet.report.chart.plot.ChartPlot),AbstractPlot,BarPlot,LinePlot,AreaPlot,Chart3DPlot,PolarPlot,GanttPlot,PiePlot,StockPlot,XYPlot,ContinuousBarPlot,ContinuousLinePlot,ContinuousAreaPlot
-
setPlot
public void setPlot(ChartPlot plot)
Sets a new plot for this chart. This can be a simple plot extended fromAbstractPlotor aCombinedPlotwith a list of simple plots.
To change the chart style use a.s.LineStyle.LINE_MARKER_STACKEDto get a stacked line style, useLineStyle.getDefaultPlot()to get a new line plot and set it with this function.- Parameters:
plot- the plot (nullnot permitted).- Since:
- 8.0
- See Also:
getPlot(),ChartStyle.getDefaultPlot(),ChartPlot,AbstractPlot,CombinedPlot
-
getLegend
public Legend getLegend()
Returns the legend of this chart.- Returns:
- the legend.
- Since:
- 8.0
- See Also:
setLegend(Legend)
-
setLegend
public void setLegend(Legend legend)
Sets the legend of this chart. To disable legend showing useLegend.setLegendPlacement(com.inet.report.chart.LegendPlacement)with parameterLegendPlacement.NONE.- Parameters:
legend- the legend (nullnot permitted).- Since:
- 8.0
- See Also:
getLegend()
-
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
public java.util.ResourceBundle getLocalizationResources()
Returns a localized resources bundle for the chart messages. The chart uses the client locale.- Returns:
- the bundle.
- Since:
- 8.0
- See Also:
Engine.setLocale(java.util.Locale),Engine.setClientLocale(java.util.Locale)
-
getPropertyFormulas
public java.util.List<FormulaField> getPropertyFormulas()
FOR INTERNAL USE ONLY Returns a list of all referenced property formulas.- Overrides:
getPropertyFormulasin classElement- Returns:
- the list of referenced objects.
-
resetReferences
public void resetReferences()
FOR INTERNAL USE ONLY- Specified by:
resetReferencesin interfacecom.inet.report.ReferenceHolder- Overrides:
resetReferencesin classReportComponent
-
setReferences
public void setReferences()
FOR INTERNAL USE ONLY- Specified by:
setReferencesin interfacecom.inet.report.ReferenceHolder- Overrides:
setReferencesin 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:
isDOMParserin interfaceNodeParser- Overrides:
isDOMParserin classReportComponent- Returns:
- true if this node is to be read via a DOM parser, false otherwise.
-
parseDOM
public void parseDOM(org.w3c.dom.Node node, java.util.Map<java.lang.String,java.lang.Object> parserMap) throws FatalParserExceptionFOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLParses the node.
- Specified by:
parseDOMin interfaceNodeParser- Overrides:
parseDOMin 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
public java.util.List<? extends ReportComponent> getSubComponents()
Returns allReportComponents that are descendants of this one. E.G. this will return all Element of aSection. But it's as well useful forCrossTabs orTextelements which have additional elements.- Specified by:
getSubComponentsin classReportComponent- Returns:
- a list with all sub components which can be empty as well; will be
nullif the component has no descendants
-
-