Package net.sf.jasperreports.components.spiderchart

Class FillSpiderChart

java.lang.Object

net.sf.jasperreports.engine.component.BaseFillComponent

net.sf.jasperreports.components.spiderchart.FillSpiderChart

All Implemented Interfaces:

FillComponent, JRFillCloneable

public class FillSpiderChart
extends BaseFillComponent
implements JRFillCloneable

Author:

Sanda Zaharia (shertage@users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field	Description
protected ChartCustomizer	chartCustomizer
static final String	EXCEPTION_MESSAGE_KEY_CUSTOMIZER_INSTANCE_ERROR

Fields inherited from class net.sf.jasperreports.engine.component.BaseFillComponent

fillContext, printElementOriginator

Constructor Summary

Constructors

Constructor	Description
FillSpiderChart(SpiderChartComponent chartComponent, ChartsFillObjectFactory factory)

Method Summary

Modifier and Type	Method	Description
protected void	copy(JRPrintImage printImage)
JRFillCloneable	createClone(JRFillCloneFactory factory)	Creates a working clone of itself.
void	evaluate(byte evaluation)	Evaluates the fill component.
void	evaluateDelayedElement(JRPrintElement element, byte evaluation)	The default implementation throws UnsupportedOperationException.
protected void	evaluateRenderer(byte evaluation)
JRPrintElement	fill()	Fills the component by creating a print element which will be included in the generated report.
String	getAnchorName()
int	getBookmarkLevel()
FillChartSettings	getChartSettings()
FillSpiderDataset	getDataset()
JRFillExpressionEvaluator	getExpressionEvaluator()
String	getHyperlinkAnchor()
Integer	getHyperlinkPage()
JRPrintHyperlinkParameters	getHyperlinkParameters()
protected ChartHyperlinkProvider	getHyperlinkProvider()
String	getHyperlinkReference()
String	getHyperlinkTooltip()
String	getLinkTarget()
String	getLinkType()
Double	getMaxValue()
FillSpiderPlot	getPlot()
Renderable	getRenderable()
String	getSubtitleText()
String	getTitleText()
protected boolean	isEvaluateNow()
FillPrepareResult	prepare(int availableHeight)
FillPrepareResult	prepare(int availableHeight, boolean isOverflowAllowed)	Prepares to fill the component by deciding whether the component will print, and how much vertical space it will require.

Methods inherited from class net.sf.jasperreports.engine.component.BaseFillComponent

deduplicate, evaluateExpression, initialize, rewind

Methods inherited from class java.lang.Object

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

Field Details

EXCEPTION_MESSAGE_KEY_CUSTOMIZER_INSTANCE_ERROR

public static final String EXCEPTION_MESSAGE_KEY_CUSTOMIZER_INSTANCE_ERROR

See Also:

• Constant Field Values

chartCustomizer

protected ChartCustomizer chartCustomizer

Constructor Details

FillSpiderChart

public FillSpiderChart(SpiderChartComponent chartComponent,
 ChartsFillObjectFactory factory)

Method Details

isEvaluateNow

protected boolean isEvaluateNow()

evaluate

public void evaluate(byte evaluation)
              throws JRException

Description copied from interface: FillComponent

Evaluates the fill component.

This method would evaluate the component expressions and store the results to be used in FillComponent.fill().

If the component needs to delay the evaluation of some of its expressions, it would call FillContext.registerDelayedEvaluation(JRPrintElement, EvaluationTimeEnum, String) to register a delayed evaluation print element, and perform the delayed evaluations on FillComponent.evaluateDelayedElement(JRPrintElement, byte).

Specified by:

evaluate in interface FillComponent

Parameters:

evaluation - the evaluation type

Throws:

JRException

See Also:

• FillContext.evaluate(net.sf.jasperreports.engine.JRExpression, byte)

evaluateRenderer

protected void evaluateRenderer(byte evaluation)
                         throws JRException

Throws:

JRException

fill

public JRPrintElement fill()

Description copied from interface: FillComponent

Fills the component by creating a print element which will be included in the generated report.

This method will get called only if FillComponent.prepare(int) returned a result that indicated that the component will print.

Specified by:

fill in interface FillComponent

Returns:

the print element generated by the component

prepare

public FillPrepareResult prepare(int availableHeight)

Specified by:

prepare in interface FillComponent

prepare

public FillPrepareResult prepare(int availableHeight,
 boolean isOverflowAllowed)

Description copied from interface: FillComponent

Prepares to fill the component by deciding whether the component will print, and how much vertical space it will require.

Specified by:

prepare in interface FillComponent

Parameters:

availableHeight - the amount of vertical space available for the component, starting from the top of the component element.

isOverflowAllowed - flag indicating if overflow is allowed for the component.

Returns:

the result of the preparation, which specifies whether the component will print and how much it will stretch vertically.

createClone

public JRFillCloneable createClone(JRFillCloneFactory factory)

Description copied from interface: JRFillCloneable

Creates a working clone of itself.

Specified by:

createClone in interface JRFillCloneable

Parameters:

factory - the clone factory to use while creating the clone

Returns:

a working clone of itself

evaluateDelayedElement

public void evaluateDelayedElement(JRPrintElement element,
 byte evaluation)
                            throws JRException

Description copied from class: BaseFillComponent

The default implementation throws UnsupportedOperationException.

If a component supports delayed evaluation, it needs to override this method.

Specified by:

evaluateDelayedElement in interface FillComponent

Overrides:

evaluateDelayedElement in class BaseFillComponent

Parameters:

element - the print element for which delayed evaluation has been registered

evaluation - the evaluation type

Throws:

JRException

See Also:

• FillComponent.evaluate(byte)

copy

protected void copy(JRPrintImage printImage)

getHyperlinkProvider

protected ChartHyperlinkProvider getHyperlinkProvider()

getChartSettings

public FillChartSettings getChartSettings()

Returns:

the chartSettings

getDataset

public FillSpiderDataset getDataset()

Returns:

the dataset

getPlot

public FillSpiderPlot getPlot()

Returns:

the plot

getMaxValue

public Double getMaxValue()

Returns:

the maxValue

getTitleText

public String getTitleText()

Returns:

the titleText

getSubtitleText

public String getSubtitleText()

Returns:

the subtitleText

getAnchorName

public String getAnchorName()

Returns:

the anchorName

getHyperlinkReference

public String getHyperlinkReference()

Returns:

the hyperlinkReference

getHyperlinkAnchor

public String getHyperlinkAnchor()

Returns:

the hyperlinkAnchor

getHyperlinkPage

public Integer getHyperlinkPage()

Returns:

the hyperlinkPage

getHyperlinkTooltip

public String getHyperlinkTooltip()

Returns:

the hyperlinkTooltip

getBookmarkLevel

public int getBookmarkLevel()

Returns:

the bookmark level

getExpressionEvaluator

public JRFillExpressionEvaluator getExpressionEvaluator()

Returns:

the expressionEvaluator

getRenderable

public Renderable getRenderable()

Returns:

the renderer

getLinkType

public String getLinkType()

getLinkTarget

public String getLinkTarget()

getHyperlinkParameters

public JRPrintHyperlinkParameters getHyperlinkParameters()

Returns:

the hyperlinkParameters