Package net.sf.jasperreports.components.spiderchart

Class StandardChartSettings

java.lang.Object

net.sf.jasperreports.components.spiderchart.StandardChartSettings

All Implemented Interfaces:

Serializable, Cloneable, ChartSettings, JRChangeEventsSupport, JRAnchor, JRCloneable, JRHyperlink

public class StandardChartSettings
extends Object
implements ChartSettings, JRChangeEventsSupport

Author:

Sanda Zaharia (shertage@users.sourceforge.net)

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected JRExpression	anchorNameExpression
protected Color	backcolor
protected int	bookmarkLevel	The bookmark level for the anchor associated with this chart.
protected JRExpression	bookmarkLevelExpression
protected String	customizerClass
protected JRExpression	hyperlinkAnchorExpression
protected JRExpression	hyperlinkPageExpression
protected List<JRHyperlinkParameter>	hyperlinkParameters
protected JRExpression	hyperlinkReferenceExpression
protected JRExpression	hyperlinkTooltipExpression
protected JRExpression	hyperlinkWhenExpression
protected Color	legendBackgroundColor
protected Color	legendColor
protected JRFont	legendFont
protected EdgeEnum	legendPosition
protected String	linkTarget
protected String	linkType
static final String	PROPERTY_ANCHOR_NAME_EXPRESSION
static final String	PROPERTY_BACKCOLOR
static final String	PROPERTY_BOOKMARK_LEVEL
static final String	PROPERTY_BOOKMARK_LEVEL_EXPRESSION
static final String	PROPERTY_CHART_TYPE
static final String	PROPERTY_CUSTOMIZER_CLASS
static final String	PROPERTY_EVALUATION_GROUP
static final String	PROPERTY_EVALUATION_TIME
static final String	PROPERTY_HYPERLINK_ANCHOR_EXPRESSION
static final String	PROPERTY_HYPERLINK_PAGE_EXPRESSION
static final String	PROPERTY_HYPERLINK_PARAMETERS
static final String	PROPERTY_HYPERLINK_REFERENCE_EXPRESSION
static final String	PROPERTY_HYPERLINK_TARGET
static final String	PROPERTY_HYPERLINK_TOOLTIP_EXPRESSION
static final String	PROPERTY_HYPERLINK_WHEN_EXPRESSION
static final String	PROPERTY_LEGEND_BACKGROUND_COLOR
static final String	PROPERTY_LEGEND_COLOR
static final String	PROPERTY_LEGEND_FONT
static final String	PROPERTY_LEGEND_POSITION
static final String	PROPERTY_LINK_TARGET
static final String	PROPERTY_LINK_TYPE
static final String	PROPERTY_RENDER_TYPE
static final String	PROPERTY_SHOW_LEGEND
static final String	PROPERTY_SUBTITLE_COLOR
static final String	PROPERTY_SUBTITLE_EXPRESSION
static final String	PROPERTY_SUBTITLE_FONT
static final String	PROPERTY_TITLE_COLOR
static final String	PROPERTY_TITLE_EXPRESSION
static final String	PROPERTY_TITLE_FONT
static final String	PROPERTY_TITLE_POSITION
protected String	renderType
protected Boolean	showLegend
protected Color	subtitleColor
protected JRExpression	subtitleExpression
protected JRFont	subtitleFont
protected Color	titleColor
protected JRExpression	titleExpression
protected JRFont	titleFont
protected EdgeEnum	titlePosition

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

NO_BOOKMARK

Constructor Summary

Constructors

Constructor	Description
StandardChartSettings()
StandardChartSettings(ChartSettings chart, JRBaseObjectFactory factory)

Method Summary

Modifier and Type	Method	Description
void	addHyperlinkParameter(JRHyperlinkParameter parameter)	Adds a custom hyperlink parameter.
Object	clone()
void	collectExpressions(JRExpressionCollector collector)
JRExpression	getAnchorNameExpression()
Color	getBackcolor()
int	getBookmarkLevel()
JRExpression	getBookmarkLevelExpression()
String	getCustomizerClass()	Gets a user specified chart customizer class name.
JRPropertyChangeSupport	getEventSupport()
JRExpression	getHyperlinkAnchorExpression()
JRExpression	getHyperlinkPageExpression()
JRHyperlinkParameter[]	getHyperlinkParameters()
List<JRHyperlinkParameter>	getHyperlinkParametersList()	Returns the list of custom hyperlink parameters.
JRExpression	getHyperlinkReferenceExpression()
HyperlinkTargetEnum	getHyperlinkTarget()
JRExpression	getHyperlinkTooltipExpression()
HyperlinkTypeEnum	getHyperlinkType()
JRExpression	getHyperlinkWhenExpression()
Color	getLegendBackgroundColor()
Color	getLegendColor()
JRFont	getLegendFont()
EdgeEnum	getLegendPosition()
String	getLinkTarget()
String	getLinkType()
String	getRenderType()
Boolean	getShowLegend()
Color	getSubtitleColor()
JRExpression	getSubtitleExpression()
JRFont	getSubtitleFont()
Color	getTitleColor()
JRExpression	getTitleExpression()
JRFont	getTitleFont()
EdgeEnum	getTitlePosition()
void	removeHyperlinkParameter(String parameterName)	Removes a custom hyperlink parameter.
void	removeHyperlinkParameter(JRHyperlinkParameter parameter)	Removes a custom hyperlink parameter.
void	setAnchorNameExpression(JRExpression anchorNameExpression)
void	setBackcolor(Color backcolor)
void	setBookmarkLevel(int bookmarkLevel)
void	setBookmarkLevelExpression(JRExpression bookmarkLevelExpression)
void	setCustomizerClass(String customizerClass)
void	setHyperlinkAnchorExpression(JRExpression hyperlinkAnchorExpression)
void	setHyperlinkPageExpression(JRExpression hyperlinkPageExpression)
void	setHyperlinkReferenceExpression(JRExpression hyperlinkReferenceExpression)
void	setHyperlinkTooltipExpression(JRExpression hyperlinkTooltipExpression)
void	setHyperlinkWhenExpression(JRExpression hyperlinkWhenExpression)
void	setLegendBackgroundColor(Color legendBackgroundColor)
void	setLegendColor(Color legendColor)
void	setLegendFont(JRFont legendFont)
void	setLegendPosition(EdgeEnum legendPosition)
void	setLinkTarget(String linkTarget)
void	setLinkType(String linkType)
void	setRenderType(String renderType)
void	setShowLegend(Boolean isShowLegend)
void	setSubtitleColor(Color subtitleColor)
void	setSubtitleExpression(JRExpression subtitleExpression)
void	setSubtitleFont(JRFont subtitleFont)
void	setTitleColor(Color titleColor)
void	setTitleExpression(JRExpression titleExpression)
void	setTitleFont(JRFont titleFont)
void	setTitlePosition(EdgeEnum titlePosition)

Methods inherited from class java.lang.Object

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

Field Details

PROPERTY_LEGEND_BACKGROUND_COLOR

public static final String PROPERTY_LEGEND_BACKGROUND_COLOR

See Also:

• Constant Field Values

PROPERTY_LEGEND_COLOR

public static final String PROPERTY_LEGEND_COLOR

See Also:

• Constant Field Values

PROPERTY_LEGEND_POSITION

public static final String PROPERTY_LEGEND_POSITION

See Also:

• Constant Field Values

PROPERTY_SHOW_LEGEND

public static final String PROPERTY_SHOW_LEGEND

See Also:

• Constant Field Values

PROPERTY_SUBTITLE_COLOR

public static final String PROPERTY_SUBTITLE_COLOR

See Also:

• Constant Field Values

PROPERTY_TITLE_COLOR

public static final String PROPERTY_TITLE_COLOR

See Also:

• Constant Field Values

PROPERTY_TITLE_POSITION

public static final String PROPERTY_TITLE_POSITION

See Also:

• Constant Field Values

PROPERTY_RENDER_TYPE

public static final String PROPERTY_RENDER_TYPE

See Also:

• Constant Field Values

PROPERTY_BOOKMARK_LEVEL

public static final String PROPERTY_BOOKMARK_LEVEL

See Also:

• Constant Field Values

PROPERTY_BACKCOLOR

public static final String PROPERTY_BACKCOLOR

See Also:

• Constant Field Values

PROPERTY_ANCHOR_NAME_EXPRESSION

public static final String PROPERTY_ANCHOR_NAME_EXPRESSION

See Also:

• Constant Field Values

PROPERTY_BOOKMARK_LEVEL_EXPRESSION

public static final String PROPERTY_BOOKMARK_LEVEL_EXPRESSION

See Also:

• Constant Field Values

PROPERTY_EVALUATION_GROUP

public static final String PROPERTY_EVALUATION_GROUP

See Also:

• Constant Field Values

PROPERTY_EVALUATION_TIME

public static final String PROPERTY_EVALUATION_TIME

See Also:

• Constant Field Values

PROPERTY_CHART_TYPE

public static final String PROPERTY_CHART_TYPE

See Also:

• Constant Field Values

PROPERTY_LEGEND_FONT

public static final String PROPERTY_LEGEND_FONT

See Also:

• Constant Field Values

PROPERTY_SUBTITLE_EXPRESSION

public static final String PROPERTY_SUBTITLE_EXPRESSION

See Also:

• Constant Field Values

PROPERTY_SUBTITLE_FONT

public static final String PROPERTY_SUBTITLE_FONT

See Also:

• Constant Field Values

PROPERTY_TITLE_EXPRESSION

public static final String PROPERTY_TITLE_EXPRESSION

See Also:

• Constant Field Values

PROPERTY_TITLE_FONT

public static final String PROPERTY_TITLE_FONT

See Also:

• Constant Field Values

PROPERTY_HYPERLINK_ANCHOR_EXPRESSION

public static final String PROPERTY_HYPERLINK_ANCHOR_EXPRESSION

See Also:

• Constant Field Values

PROPERTY_HYPERLINK_PAGE_EXPRESSION

public static final String PROPERTY_HYPERLINK_PAGE_EXPRESSION

See Also:

• Constant Field Values

PROPERTY_HYPERLINK_REFERENCE_EXPRESSION

public static final String PROPERTY_HYPERLINK_REFERENCE_EXPRESSION

See Also:

• Constant Field Values

PROPERTY_HYPERLINK_WHEN_EXPRESSION

public static final String PROPERTY_HYPERLINK_WHEN_EXPRESSION

See Also:

• Constant Field Values

PROPERTY_HYPERLINK_TARGET

public static final String PROPERTY_HYPERLINK_TARGET

See Also:

• Constant Field Values

PROPERTY_LINK_TARGET

public static final String PROPERTY_LINK_TARGET

See Also:

• Constant Field Values

PROPERTY_HYPERLINK_TOOLTIP_EXPRESSION

public static final String PROPERTY_HYPERLINK_TOOLTIP_EXPRESSION

See Also:

• Constant Field Values

PROPERTY_LINK_TYPE

public static final String PROPERTY_LINK_TYPE

See Also:

• Constant Field Values

PROPERTY_HYPERLINK_PARAMETERS

public static final String PROPERTY_HYPERLINK_PARAMETERS

See Also:

• Constant Field Values

PROPERTY_CUSTOMIZER_CLASS

public static final String PROPERTY_CUSTOMIZER_CLASS

See Also:

• Constant Field Values

showLegend

protected Boolean showLegend

linkType

protected String linkType

linkTarget

protected String linkTarget

hyperlinkParameters

protected List<JRHyperlinkParameter> hyperlinkParameters

backcolor

protected Color backcolor

titleColor

protected Color titleColor

subtitleColor

protected Color subtitleColor

legendColor

protected Color legendColor

legendBackgroundColor

protected Color legendBackgroundColor

legendPosition

protected EdgeEnum legendPosition

titlePosition

protected EdgeEnum titlePosition

renderType

protected String renderType

titleFont

protected JRFont titleFont

subtitleFont

protected JRFont subtitleFont

legendFont

protected JRFont legendFont

titleExpression

protected JRExpression titleExpression

subtitleExpression

protected JRExpression subtitleExpression

anchorNameExpression

protected JRExpression anchorNameExpression

bookmarkLevelExpression

protected JRExpression bookmarkLevelExpression

hyperlinkReferenceExpression

protected JRExpression hyperlinkReferenceExpression

hyperlinkWhenExpression

protected JRExpression hyperlinkWhenExpression

hyperlinkAnchorExpression

protected JRExpression hyperlinkAnchorExpression

hyperlinkPageExpression

protected JRExpression hyperlinkPageExpression

hyperlinkTooltipExpression

protected JRExpression hyperlinkTooltipExpression

customizerClass

protected String customizerClass

bookmarkLevel

protected int bookmarkLevel

The bookmark level for the anchor associated with this chart.

See Also:

• JRAnchor.getBookmarkLevel()

Constructor Details

StandardChartSettings

public StandardChartSettings()

StandardChartSettings

public StandardChartSettings(ChartSettings chart,
 JRBaseObjectFactory factory)

Method Details

getShowLegend

public Boolean getShowLegend()

Specified by:

getShowLegend in interface ChartSettings

setShowLegend

public void setShowLegend(Boolean isShowLegend)

getBackcolor

public Color getBackcolor()

Specified by:

getBackcolor in interface ChartSettings

setBackcolor

public void setBackcolor(Color backcolor)

getTitleFont

public JRFont getTitleFont()

Specified by:

getTitleFont in interface ChartSettings

getTitlePosition

public EdgeEnum getTitlePosition()

Specified by:

getTitlePosition in interface ChartSettings

setTitlePosition

public void setTitlePosition(EdgeEnum titlePosition)

getTitleColor

public Color getTitleColor()

Specified by:

getTitleColor in interface ChartSettings

setTitleColor

public void setTitleColor(Color titleColor)

getSubtitleFont

public JRFont getSubtitleFont()

Specified by:

getSubtitleFont in interface ChartSettings

getSubtitleColor

public Color getSubtitleColor()

Specified by:

getSubtitleColor in interface ChartSettings

setSubtitleColor

public void setSubtitleColor(Color subtitleColor)

getLegendBackgroundColor

public Color getLegendBackgroundColor()

Specified by:

getLegendBackgroundColor in interface ChartSettings

getLegendColor

public Color getLegendColor()

Specified by:

getLegendColor in interface ChartSettings

getLegendFont

public JRFont getLegendFont()

Specified by:

getLegendFont in interface ChartSettings

setLegendBackgroundColor

public void setLegendBackgroundColor(Color legendBackgroundColor)

setLegendColor

public void setLegendColor(Color legendColor)

getLegendPosition

public EdgeEnum getLegendPosition()

Specified by:

getLegendPosition in interface ChartSettings

setLegendPosition

public void setLegendPosition(EdgeEnum legendPosition)

getHyperlinkType

public HyperlinkTypeEnum getHyperlinkType()

Specified by:

getHyperlinkType in interface JRHyperlink

getHyperlinkTarget

public HyperlinkTargetEnum getHyperlinkTarget()

Specified by:

getHyperlinkTarget in interface JRHyperlink

getTitleExpression

public JRExpression getTitleExpression()

Specified by:

getTitleExpression in interface ChartSettings

getSubtitleExpression

public JRExpression getSubtitleExpression()

Specified by:

getSubtitleExpression in interface ChartSettings

getAnchorNameExpression

public JRExpression getAnchorNameExpression()

Specified by:

getAnchorNameExpression in interface JRAnchor

getBookmarkLevelExpression

public JRExpression getBookmarkLevelExpression()

Specified by:

getBookmarkLevelExpression in interface JRAnchor

getHyperlinkReferenceExpression

public JRExpression getHyperlinkReferenceExpression()

Specified by:

getHyperlinkReferenceExpression in interface JRHyperlink

getHyperlinkWhenExpression

public JRExpression getHyperlinkWhenExpression()

Specified by:

getHyperlinkWhenExpression in interface JRHyperlink

getHyperlinkAnchorExpression

public JRExpression getHyperlinkAnchorExpression()

Specified by:

getHyperlinkAnchorExpression in interface JRHyperlink

getHyperlinkPageExpression

public JRExpression getHyperlinkPageExpression()

Specified by:

getHyperlinkPageExpression in interface JRHyperlink

getRenderType

public String getRenderType()

Specified by:

getRenderType in interface ChartSettings

setRenderType

public void setRenderType(String renderType)

getBookmarkLevel

public int getBookmarkLevel()

Specified by:

getBookmarkLevel in interface JRAnchor

setBookmarkLevel

public void setBookmarkLevel(int bookmarkLevel)

getLinkType

public String getLinkType()

Specified by:

getLinkType in interface JRHyperlink

getLinkTarget

public String getLinkTarget()

Specified by:

getLinkTarget in interface JRHyperlink

getHyperlinkTooltipExpression

public JRExpression getHyperlinkTooltipExpression()

Specified by:

getHyperlinkTooltipExpression in interface JRHyperlink

getCustomizerClass

public String getCustomizerClass()

Description copied from interface: ChartSettings

Gets a user specified chart customizer class name.

Specified by:

getCustomizerClass in interface ChartSettings

Returns:

the customizerClass

See Also:

• ChartCustomizer

setLinkType

public void setLinkType(String linkType)

Parameters:

linkType - the linkType to set

setLinkTarget

public void setLinkTarget(String linkTarget)

Parameters:

linkTarget - the linkTarget to set

setTitleFont

public void setTitleFont(JRFont titleFont)

Parameters:

titleFont - the titleFont to set

setSubtitleFont

public void setSubtitleFont(JRFont subtitleFont)

Parameters:

subtitleFont - the subtitleFont to set

setLegendFont

public void setLegendFont(JRFont legendFont)

Parameters:

legendFont - the legendFont to set

setTitleExpression

public void setTitleExpression(JRExpression titleExpression)

Parameters:

titleExpression - the titleExpression to set

setSubtitleExpression

public void setSubtitleExpression(JRExpression subtitleExpression)

Parameters:

subtitleExpression - the subtitleExpression to set

setAnchorNameExpression

public void setAnchorNameExpression(JRExpression anchorNameExpression)

Parameters:

anchorNameExpression - the anchorNameExpression to set

setBookmarkLevelExpression

public void setBookmarkLevelExpression(JRExpression bookmarkLevelExpression)

Parameters:

bookmarkLevelExpression - the bookmarkLevelExpression to set

setHyperlinkReferenceExpression

public void setHyperlinkReferenceExpression(JRExpression hyperlinkReferenceExpression)

Parameters:

hyperlinkReferenceExpression - the hyperlinkReferenceExpression to set

setHyperlinkWhenExpression

public void setHyperlinkWhenExpression(JRExpression hyperlinkWhenExpression)

Parameters:

hyperlinkWhenExpression - the hyperlinkWhenExpression to set

setHyperlinkAnchorExpression

public void setHyperlinkAnchorExpression(JRExpression hyperlinkAnchorExpression)

Parameters:

hyperlinkAnchorExpression - the hyperlinkAnchorExpression to set

setHyperlinkPageExpression

public void setHyperlinkPageExpression(JRExpression hyperlinkPageExpression)

Parameters:

hyperlinkPageExpression - the hyperlinkPageExpression to set

setHyperlinkTooltipExpression

public void setHyperlinkTooltipExpression(JRExpression hyperlinkTooltipExpression)

Parameters:

hyperlinkTooltipExpression - the hyperlinkTooltipExpression to set

setCustomizerClass

public void setCustomizerClass(String customizerClass)

Parameters:

customizerClass - the customizerClass to set

collectExpressions

public void collectExpressions(JRExpressionCollector collector)

clone

public Object clone()

Specified by:

clone in interface JRCloneable

Overrides:

clone in class Object

getEventSupport

public JRPropertyChangeSupport getEventSupport()

Specified by:

getEventSupport in interface JRChangeEventsSupport

getHyperlinkParameters

public JRHyperlinkParameter[] getHyperlinkParameters()

Specified by:

getHyperlinkParameters in interface JRHyperlink

getHyperlinkParametersList

public List<JRHyperlinkParameter> getHyperlinkParametersList()

Returns the list of custom hyperlink parameters.

Returns:

the list of custom hyperlink parameters

addHyperlinkParameter

public void addHyperlinkParameter(JRHyperlinkParameter parameter)

Adds a custom hyperlink parameter.

Parameters:

parameter - the parameter to add

removeHyperlinkParameter

public void removeHyperlinkParameter(JRHyperlinkParameter parameter)

Removes a custom hyperlink parameter.

Parameters:

parameter - the parameter to remove

removeHyperlinkParameter

public void removeHyperlinkParameter(String parameterName)

Removes a custom hyperlink parameter.

If multiple parameters having the specified name exist, all of them will be removed

Parameters:

parameterName - the parameter name