net.sf.jasperreports.engine.fill
Class JRFillChart

java.lang.Object
  net.sf.jasperreports.engine.fill.JRFillElement
      net.sf.jasperreports.engine.fill.JRFillChart

All Implemented Interfaces:

JRAnchor, JRChart, JRChild, JRElement, JRHyperlink

public class JRFillChart
extends JRFillElement
implements JRChart

Version:

$Id: JRFillChart.java,v 1.38 2005/08/23 14:24:27 ionutned Exp $

Author:

Teodor Danciu (teodord@users.sourceforge.net)

Field Summary

protected JRChartCustomizer	chartCustomizer
protected byte	chartType
protected java.lang.String	customizerClass
protected JRChartDataset	dataset
protected JRGroup	evaluationGroup
protected JRChartPlot	plot
protected JRRenderable	renderer
protected JRFont	subtitleFont
protected JRFont	titleFont

Fields inherited from class net.sf.jasperreports.engine.fill.JRFillElement

band, elementGroup, filler, parent, printWhenGroupChanges, template

Fields inherited from interface net.sf.jasperreports.engine.JRChart

CHART_TYPE_AREA, CHART_TYPE_BAR, CHART_TYPE_BAR3D, CHART_TYPE_BUBBLE, CHART_TYPE_CANDLESTICK, CHART_TYPE_HIGHLOW, CHART_TYPE_LINE, CHART_TYPE_PIE, CHART_TYPE_PIE3D, CHART_TYPE_SCATTER, CHART_TYPE_STACKEDBAR, CHART_TYPE_STACKEDBAR3D, CHART_TYPE_TIMESERIES, CHART_TYPE_XYAREA, CHART_TYPE_XYBAR, CHART_TYPE_XYLINE, TITLE_POSITION_BOTTOM, TITLE_POSITION_LEFT, TITLE_POSITION_RIGHT, TITLE_POSITION_TOP

Fields inherited from interface net.sf.jasperreports.engine.JRElement

MODE_OPAQUE, MODE_TRANSPARENT, POSITION_TYPE_FIX_RELATIVE_TO_BOTTOM, POSITION_TYPE_FIX_RELATIVE_TO_TOP, POSITION_TYPE_FLOAT, STRETCH_TYPE_NO_STRETCH, STRETCH_TYPE_RELATIVE_TO_BAND_HEIGHT, STRETCH_TYPE_RELATIVE_TO_TALLEST_OBJECT

Fields inherited from interface net.sf.jasperreports.engine.JRAnchor

NO_BOOKMARK

Fields inherited from interface net.sf.jasperreports.engine.JRHyperlink

HYPERLINK_TARGET_BLANK, HYPERLINK_TARGET_SELF, HYPERLINK_TYPE_LOCAL_ANCHOR, HYPERLINK_TYPE_LOCAL_PAGE, HYPERLINK_TYPE_NONE, HYPERLINK_TYPE_REFERENCE, HYPERLINK_TYPE_REMOTE_ANCHOR, HYPERLINK_TYPE_REMOTE_PAGE

Constructor Summary

protected

JRFillChart(JRBaseFiller filler, JRChart chart, JRFillObjectFactory factory)

Method Summary

void	collectExpressions(JRExpressionCollector collector)
protected void	copy(JRPrintImage printImage)
protected void	evaluate(byte evaluation)
protected org.jfree.chart.JFreeChart	evaluateAreaImage(byte evaluation)
protected org.jfree.chart.JFreeChart	evaluateBar3DImage(byte evaluation)
protected org.jfree.chart.JFreeChart	evaluateBarImage(byte evaluation)
protected org.jfree.chart.JFreeChart	evaluateBubbleImage(byte evaluation)
protected org.jfree.chart.JFreeChart	evaluateCandlestickImage(byte evaluation)
protected java.lang.Object	evaluateExpression(JRExpression expression, byte evaluation)
protected org.jfree.chart.JFreeChart	evaluateHighLowImage(byte evaluation)
protected void	evaluateImage(byte evaluation)
protected org.jfree.chart.JFreeChart	evaluateLineImage(byte evaluation)
protected org.jfree.chart.JFreeChart	evaluatePie3DImage(byte evaluation)
protected org.jfree.chart.JFreeChart	evaluatePieImage(byte evaluation)
protected org.jfree.chart.JFreeChart	evaluateScatterImage(byte evaluation)
protected org.jfree.chart.JFreeChart	evaluateStackedBar3DImage(byte evaluation)
protected org.jfree.chart.JFreeChart	evaluateStackedBarImage(byte evaluation)
protected org.jfree.chart.JFreeChart	evaluateTimeSeriesImage(byte evaluation)
protected org.jfree.chart.JFreeChart	evaluateXyAreaImage(byte evaluation)
protected org.jfree.chart.JFreeChart	evaluateXYBarImage(byte evaluation)
protected org.jfree.chart.JFreeChart	evaluateXyLineImage(byte evaluation)
protected JRPrintElement	fill()
protected java.lang.String	getAnchorName()
JRExpression	getAnchorNameExpression() Returns an expression whose value represents the anchor name.
int	getBookmarkLevel() Returns the level of the bookmark corresponding to the anchor.
JRBox	getBox() Gets the box around the element.
byte	getChartType() Gets the chart type.
JRChild	getCopy(JRAbstractObjectFactory factory)
java.lang.String	getCustomizerClass() Gets a user specified chart customizer class name.
JRChartDataset	getDataset() Gets the chart dataset.
JRGroup	getEvaluationGroup() Gets the evaluation group for this chart (only applies when evaluation time is group).
byte	getEvaluationTime() Returns the evaluation time for this chart.
protected java.lang.String	getHyperlinkAnchor()
JRExpression	getHyperlinkAnchorExpression() Returns the expression whose value represents the anchor.
protected java.lang.Integer	getHyperlinkPage()
JRExpression	getHyperlinkPageExpression() Returns an integer representing the page index of the link.
protected java.lang.String	getHyperlinkReference()
JRExpression	getHyperlinkReferenceExpression() Returns the expression whose value represents the hyperlink reference.
byte	getHyperlinkTarget() Retrieves the hyperlink target for the element.
byte	getHyperlinkType() Retrieves the hyperlink type for the element.
protected JRTemplateImage	getJRTemplateImage()
JRChartPlot	getPlot() Gets the chart plot.
protected JRRenderable	getRenderer()
java.awt.Color	getSubtitleColor()
JRExpression	getSubtitleExpression() Gets the expression whose evaluation will form the subtitle.
JRFont	getSubtitleFont()
java.awt.Color	getTitleColor()
JRExpression	getTitleExpression() Gets the expression whose evaluation will form the title.
JRFont	getTitleFont()
byte	getTitlePosition() Gets the title position relative to the chart.
boolean	isShowLegend()
protected boolean	prepare(int availableStretchHeight, boolean isOverflow)
protected void	resolveElement(JRPrintElement element, byte evaluation) Resolves an element.
protected void	rewind()
void	setShowLegend(boolean isShowLegend)
void	setSubtitleColor(java.awt.Color subtitleColor)
void	setTitleColor(java.awt.Color titleColor)
void	setTitlePosition(byte titlePosition) Sets the title position relative to the chart.
void	writeXml(JRXmlWriter writer) The method is never called for fill charts

Methods inherited from class net.sf.jasperreports.engine.fill.JRFillElement

addDependantElement, evaluatePrintWhenExpression, getBackcolor, getBand, getBandBottomY, getDependantElements, getElementGroup, getForecolor, getGroupElements, getHeight, getKey, getMode, getPositionType, getPrintWhenExpression, getPrintWhenGroupChanges, getRelativeY, getStretchHeight, getStretchType, getWidth, getX, getY, isAlreadyPrinted, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isPrintWhenExpressionNull, isPrintWhenTrue, isRemoveLineWhenBlank, isReprinted, isToPrint, moveDependantElements, reset, setAlreadyPrinted, setBackcolor, setBand, setBandBottomY, setForecolor, setMode, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setPrintWhenExpressionNull, setPrintWhenTrue, setRelativeY, setRemoveLineWhenBlank, setReprinted, setStretchHeight, setStretchType, setToPrint, setWidth, setX, stretchElement

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.jasperreports.engine.JRElement

getBackcolor, getElementGroup, getForecolor, getHeight, getKey, getMode, getPositionType, getPrintWhenExpression, getPrintWhenGroupChanges, getStretchType, getWidth, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, setMode, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setX

Field Detail

chartType

protected byte chartType

titleFont

protected JRFont titleFont

subtitleFont

protected JRFont subtitleFont

evaluationGroup

protected JRGroup evaluationGroup

dataset

protected JRChartDataset dataset

plot

protected JRChartPlot plot

renderer

protected JRRenderable renderer

customizerClass

protected java.lang.String customizerClass

chartCustomizer

protected JRChartCustomizer chartCustomizer

Constructor Detail

JRFillChart

protected JRFillChart(JRBaseFiller filler,
                      JRChart chart,
                      JRFillObjectFactory factory)

Method Detail

isShowLegend

public boolean isShowLegend()

Specified by:

isShowLegend in interface JRChart

setShowLegend

public void setShowLegend(boolean isShowLegend)

Specified by:

setShowLegend in interface JRChart

getEvaluationTime

public byte getEvaluationTime()

Description copied from interface: JRChart

Returns the evaluation time for this chart.

Specified by:

getEvaluationTime in interface JRChart

getEvaluationGroup

public JRGroup getEvaluationGroup()

Description copied from interface: JRChart

Gets the evaluation group for this chart (only applies when evaluation time is group).

Specified by:

getEvaluationGroup in interface JRChart

getBox

public JRBox getBox()

Description copied from interface: JRChart

Gets the box around the element.

Specified by:

getBox in interface JRChart

getTitleFont

public JRFont getTitleFont()

Specified by:

getTitleFont in interface JRChart

getTitlePosition

public byte getTitlePosition()

Description copied from interface: JRChart

Gets the title position relative to the chart.

Specified by:

getTitlePosition in interface JRChart

setTitlePosition

public void setTitlePosition(byte titlePosition)

Description copied from interface: JRChart

Sets the title position relative to the chart.

Specified by:

setTitlePosition in interface JRChart

getTitleColor

public java.awt.Color getTitleColor()

Specified by:

getTitleColor in interface JRChart

setTitleColor

public void setTitleColor(java.awt.Color titleColor)

Specified by:

setTitleColor in interface JRChart

getSubtitleFont

public JRFont getSubtitleFont()

Specified by:

getSubtitleFont in interface JRChart

getSubtitleColor

public java.awt.Color getSubtitleColor()

Specified by:

getSubtitleColor in interface JRChart

setSubtitleColor

public void setSubtitleColor(java.awt.Color subtitleColor)

Specified by:

setSubtitleColor in interface JRChart

getTitleExpression

public JRExpression getTitleExpression()

Description copied from interface: JRChart

Gets the expression whose evaluation will form the title.

Specified by:

getTitleExpression in interface JRChart

getSubtitleExpression

public JRExpression getSubtitleExpression()

Description copied from interface: JRChart

Gets the expression whose evaluation will form the subtitle.

Specified by:

getSubtitleExpression in interface JRChart

getHyperlinkType

public byte getHyperlinkType()

Description copied from interface: JRHyperlink

Retrieves the hyperlink type for the element.

Specified by:

getHyperlinkType in interface JRHyperlink

Returns:

one of the hyperlink type constants

getHyperlinkTarget

public byte getHyperlinkTarget()

Description copied from interface: JRHyperlink

Retrieves the hyperlink target for the element.

Specified by:

getHyperlinkTarget in interface JRHyperlink

Returns:

one of the hyperlink target constants

getAnchorNameExpression

public JRExpression getAnchorNameExpression()

Description copied from interface: JRAnchor

Returns an expression whose value represents the anchor name.

Specified by:

getAnchorNameExpression in interface JRAnchor

getHyperlinkReferenceExpression

public JRExpression getHyperlinkReferenceExpression()

Description copied from interface: JRHyperlink

Returns the expression whose value represents the hyperlink reference. It is only used when the hyperlink type is reference or anchor

Specified by:

getHyperlinkReferenceExpression in interface JRHyperlink

getHyperlinkAnchorExpression

public JRExpression getHyperlinkAnchorExpression()

Description copied from interface: JRHyperlink

Returns the expression whose value represents the anchor. It is only used when the hyperlink type is anchor.

Specified by:

getHyperlinkAnchorExpression in interface JRHyperlink

getHyperlinkPageExpression

public JRExpression getHyperlinkPageExpression()

Description copied from interface: JRHyperlink

Returns an integer representing the page index of the link. It is only used when the hyperlink type is page. If the expression does not evaluate to an integer, an exception will be thrown.

Specified by:

getHyperlinkPageExpression in interface JRHyperlink

getDataset

public JRChartDataset getDataset()

Description copied from interface: JRChart

Gets the chart dataset. Most chart types have different dataset structures, depending on the chart type.

Specified by:

getDataset in interface JRChart

getPlot

public JRChartPlot getPlot()

Description copied from interface: JRChart

Gets the chart plot. Plots are used to define various chart visual properties, such as colors and transparency.

Specified by:

getPlot in interface JRChart

getRenderer

protected JRRenderable getRenderer()

getAnchorName

protected java.lang.String getAnchorName()

getHyperlinkReference

protected java.lang.String getHyperlinkReference()

getHyperlinkAnchor

protected java.lang.String getHyperlinkAnchor()

getHyperlinkPage

protected java.lang.Integer getHyperlinkPage()

getJRTemplateImage

protected JRTemplateImage getJRTemplateImage()

evaluateExpression

protected java.lang.Object evaluateExpression(JRExpression expression,
                                              byte evaluation)
                                       throws JRException

Throws:

JRException

rewind

protected void rewind()

Specified by:

rewind in class JRFillElement

evaluate

protected void evaluate(byte evaluation)
                 throws JRException

Specified by:

evaluate in class JRFillElement

Throws:

JRException

evaluateImage

protected void evaluateImage(byte evaluation)
                      throws JRException

Throws:

JRException

prepare

protected boolean prepare(int availableStretchHeight,
                          boolean isOverflow)

Overrides:

prepare in class JRFillElement

fill

protected JRPrintElement fill()

Specified by:

fill in class JRFillElement

copy

protected void copy(JRPrintImage printImage)

getChartType

public byte getChartType()

Description copied from interface: JRChart

Gets the chart type. It must be one of the chart type constants in this class.

Specified by:

getChartType in interface JRChart

getCopy

public JRChild getCopy(JRAbstractObjectFactory factory)

Specified by:

getCopy in interface JRChild

collectExpressions

public void collectExpressions(JRExpressionCollector collector)

Specified by:

collectExpressions in interface JRElement

writeXml

public void writeXml(JRXmlWriter writer)

The method is never called for fill charts

Specified by:

writeXml in interface JRChild

Parameters:

writer -

evaluateAreaImage

protected org.jfree.chart.JFreeChart evaluateAreaImage(byte evaluation)
                                                throws JRException

Throws:

JRException

evaluateBar3DImage

protected org.jfree.chart.JFreeChart evaluateBar3DImage(byte evaluation)
                                                 throws JRException

Throws:

JRException

evaluateBarImage

protected org.jfree.chart.JFreeChart evaluateBarImage(byte evaluation)
                                               throws JRException

Throws:

JRException

evaluateBubbleImage

protected org.jfree.chart.JFreeChart evaluateBubbleImage(byte evaluation)
                                                  throws JRException

Throws:

JRException

evaluateCandlestickImage

protected org.jfree.chart.JFreeChart evaluateCandlestickImage(byte evaluation)
                                                       throws JRException

Parameters:

evaluation -

Throws:

JRException

evaluateHighLowImage

protected org.jfree.chart.JFreeChart evaluateHighLowImage(byte evaluation)
                                                   throws JRException

Parameters:

evaluation -

Throws:

JRException

evaluateLineImage

protected org.jfree.chart.JFreeChart evaluateLineImage(byte evaluation)
                                                throws JRException

Throws:

JRException

evaluatePie3DImage

protected org.jfree.chart.JFreeChart evaluatePie3DImage(byte evaluation)
                                                 throws JRException

Throws:

JRException

evaluatePieImage

protected org.jfree.chart.JFreeChart evaluatePieImage(byte evaluation)
                                               throws JRException

Throws:

JRException

evaluateScatterImage

protected org.jfree.chart.JFreeChart evaluateScatterImage(byte evaluation)
                                                   throws JRException

Throws:

JRException

evaluateStackedBar3DImage

protected org.jfree.chart.JFreeChart evaluateStackedBar3DImage(byte evaluation)
                                                        throws JRException

Throws:

JRException

evaluateStackedBarImage

protected org.jfree.chart.JFreeChart evaluateStackedBarImage(byte evaluation)
                                                      throws JRException

Throws:

JRException

evaluateXyAreaImage

protected org.jfree.chart.JFreeChart evaluateXyAreaImage(byte evaluation)
                                                  throws JRException

Throws:

JRException

evaluateXYBarImage

protected org.jfree.chart.JFreeChart evaluateXYBarImage(byte evaluation)
                                                 throws JRException

Throws:

JRException

evaluateXyLineImage

protected org.jfree.chart.JFreeChart evaluateXyLineImage(byte evaluation)
                                                  throws JRException

Throws:

JRException

evaluateTimeSeriesImage

protected org.jfree.chart.JFreeChart evaluateTimeSeriesImage(byte evaluation)
                                                      throws JRException

Throws:

JRException

resolveElement

protected void resolveElement(JRPrintElement element,
                              byte evaluation)
                       throws JRException

Description copied from class: JRFillElement

Resolves an element.

Specified by:

resolveElement in class JRFillElement

Parameters:

element - the element

evaluation - the evaluation type

Throws:

JRException

getBookmarkLevel

public int getBookmarkLevel()

Description copied from interface: JRAnchor

Returns the level of the bookmark corresponding to the anchor.

Specified by:

getBookmarkLevel in interface JRAnchor

Returns:

the level of the bookmark corresponding to the anchor (starting from 1) or NO_BOOKMARK if no bookmark should be created for this anchor

getCustomizerClass

public java.lang.String getCustomizerClass()

Description copied from interface: JRChart

Gets a user specified chart customizer class name.

Specified by:

getCustomizerClass in interface JRChart

See Also:

JRChartCustomizer