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 inherited from interface net.sf.jasperreports.engine.JRAnchor
NO_BOOKMARK
-
-
Constructor Summary
Constructors Constructor Description StandardChartSettings()
StandardChartSettings(ChartSettings chart, JRBaseObjectFactory factory)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addHyperlinkParameter(JRHyperlinkParameter parameter)
Adds a custom hyperlink parameter.Object
clone()
void
collectExpressions(JRExpressionCollector collector)
JRExpression
getAnchorNameExpression()
Returns an expression whose value represents the anchor name.Color
getBackcolor()
int
getBookmarkLevel()
Returns the level of the bookmark corresponding to the anchor.JRExpression
getBookmarkLevelExpression()
Returns an expression whose value represents the bookmark level (starting from 1) corresponding to this anchor.String
getCustomizerClass()
Gets a user specified chart customizer class name.JRPropertyChangeSupport
getEventSupport()
Returns the property change support object for this instance.JRExpression
getHyperlinkAnchorExpression()
Returns the expression whose value represents the anchor.JRExpression
getHyperlinkPageExpression()
Returns an integer representing the page index of the link.JRHyperlinkParameter[]
getHyperlinkParameters()
Returns the list of hyperlink parameters.List<JRHyperlinkParameter>
getHyperlinkParametersList()
Returns the list of custom hyperlink parameters.JRExpression
getHyperlinkReferenceExpression()
Returns the expression whose value represents the hyperlink reference.HyperlinkTargetEnum
getHyperlinkTarget()
Retrieves the hyperlink target for the element.JRExpression
getHyperlinkTooltipExpression()
Returns the expression which will generate the hyperlink tooltip.HyperlinkTypeEnum
getHyperlinkType()
Retrieves the hyperlink type for the element.JRExpression
getHyperlinkWhenExpression()
Returns the expression that is evaluated in order to decide if the hyperlink should be displayed.Color
getLegendBackgroundColor()
Color
getLegendColor()
JRFont
getLegendFont()
EdgeEnum
getLegendPosition()
String
getLinkTarget()
Returns the hyperlink target name.String
getLinkType()
Returns the hyperlink type.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)
-
-
-
Field Detail
-
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 Detail
-
StandardChartSettings
public StandardChartSettings()
-
StandardChartSettings
public StandardChartSettings(ChartSettings chart, JRBaseObjectFactory factory)
-
-
Method Detail
-
getShowLegend
public Boolean getShowLegend()
- Specified by:
getShowLegend
in interfaceChartSettings
-
setShowLegend
public void setShowLegend(Boolean isShowLegend)
-
getBackcolor
public Color getBackcolor()
- Specified by:
getBackcolor
in interfaceChartSettings
-
setBackcolor
public void setBackcolor(Color backcolor)
-
getTitleFont
public JRFont getTitleFont()
- Specified by:
getTitleFont
in interfaceChartSettings
-
getTitlePosition
public EdgeEnum getTitlePosition()
- Specified by:
getTitlePosition
in interfaceChartSettings
-
setTitlePosition
public void setTitlePosition(EdgeEnum titlePosition)
-
getTitleColor
public Color getTitleColor()
- Specified by:
getTitleColor
in interfaceChartSettings
-
setTitleColor
public void setTitleColor(Color titleColor)
-
getSubtitleFont
public JRFont getSubtitleFont()
- Specified by:
getSubtitleFont
in interfaceChartSettings
-
getSubtitleColor
public Color getSubtitleColor()
- Specified by:
getSubtitleColor
in interfaceChartSettings
-
setSubtitleColor
public void setSubtitleColor(Color subtitleColor)
-
getLegendBackgroundColor
public Color getLegendBackgroundColor()
- Specified by:
getLegendBackgroundColor
in interfaceChartSettings
-
getLegendColor
public Color getLegendColor()
- Specified by:
getLegendColor
in interfaceChartSettings
-
getLegendFont
public JRFont getLegendFont()
- Specified by:
getLegendFont
in interfaceChartSettings
-
setLegendBackgroundColor
public void setLegendBackgroundColor(Color legendBackgroundColor)
-
setLegendColor
public void setLegendColor(Color legendColor)
-
getLegendPosition
public EdgeEnum getLegendPosition()
- Specified by:
getLegendPosition
in interfaceChartSettings
-
setLegendPosition
public void setLegendPosition(EdgeEnum legendPosition)
-
getHyperlinkType
public HyperlinkTypeEnum getHyperlinkType()
Description copied from interface:JRHyperlink
Retrieves the hyperlink type for the element.The actual hyperlink type is determined by
getLinkType()
. This method can is used to determine whether the hyperlink type is one of the built-in types or a custom type. When hyperlink is of custom type,CUSTOM
is returned.- Specified by:
getHyperlinkType
in interfaceJRHyperlink
- Returns:
- one of the hyperlink type constants
- See Also:
JRHyperlink.getLinkType()
-
getHyperlinkTarget
public HyperlinkTargetEnum getHyperlinkTarget()
Description copied from interface:JRHyperlink
Retrieves the hyperlink target for the element.The actual hyperlink target is determined by
getLinkTarget()
. This method can is used to determine whether the hyperlink target is one of the built-in target names or a custom one. When hyperlink has a custom target name,HyperlinkTargetEnum.CUSTOM
is returned.- Specified by:
getHyperlinkTarget
in interfaceJRHyperlink
- Returns:
- one of the hyperlink target constants
- See Also:
JRHyperlink.getLinkTarget()
-
getTitleExpression
public JRExpression getTitleExpression()
- Specified by:
getTitleExpression
in interfaceChartSettings
-
getSubtitleExpression
public JRExpression getSubtitleExpression()
- Specified by:
getSubtitleExpression
in interfaceChartSettings
-
getAnchorNameExpression
public JRExpression getAnchorNameExpression()
Description copied from interface:JRAnchor
Returns an expression whose value represents the anchor name.- Specified by:
getAnchorNameExpression
in interfaceJRAnchor
-
getBookmarkLevelExpression
public JRExpression getBookmarkLevelExpression()
Description copied from interface:JRAnchor
Returns an expression whose value represents the bookmark level (starting from 1) corresponding to this anchor. When the expression is set and its value is not null, it will override the value of the bookmarkLevel attribute.- Specified by:
getBookmarkLevelExpression
in interfaceJRAnchor
-
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 interfaceJRHyperlink
-
getHyperlinkWhenExpression
public JRExpression getHyperlinkWhenExpression()
Description copied from interface:JRHyperlink
Returns the expression that is evaluated in order to decide if the hyperlink should be displayed. This expression always returns a boolean value.- Specified by:
getHyperlinkWhenExpression
in interfaceJRHyperlink
-
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 interfaceJRHyperlink
-
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 interfaceJRHyperlink
-
getRenderType
public String getRenderType()
- Specified by:
getRenderType
in interfaceChartSettings
-
setRenderType
public void setRenderType(String renderType)
-
getBookmarkLevel
public int getBookmarkLevel()
Description copied from interface:JRAnchor
Returns the level of the bookmark corresponding to the anchor.- Specified by:
getBookmarkLevel
in interfaceJRAnchor
- 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
-
setBookmarkLevel
public void setBookmarkLevel(int bookmarkLevel)
-
getLinkType
public String getLinkType()
Description copied from interface:JRHyperlink
Returns the hyperlink type.The type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.
- Specified by:
getLinkType
in interfaceJRHyperlink
- Returns:
- the hyperlink type
-
getLinkTarget
public String getLinkTarget()
Description copied from interface:JRHyperlink
Returns the hyperlink target name.The type can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.
- Specified by:
getLinkTarget
in interfaceJRHyperlink
- Returns:
- the hyperlink target name
-
getHyperlinkTooltipExpression
public JRExpression getHyperlinkTooltipExpression()
Description copied from interface:JRHyperlink
Returns the expression which will generate the hyperlink tooltip.- Specified by:
getHyperlinkTooltipExpression
in interfaceJRHyperlink
- Returns:
- the expression which will generate the hyperlink tooltip
-
getCustomizerClass
public String getCustomizerClass()
Description copied from interface:ChartSettings
Gets a user specified chart customizer class name.- Specified by:
getCustomizerClass
in interfaceChartSettings
- 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 interfaceJRCloneable
- Overrides:
clone
in classObject
-
getEventSupport
public JRPropertyChangeSupport getEventSupport()
Description copied from interface:JRChangeEventsSupport
Returns the property change support object for this instance.- Specified by:
getEventSupport
in interfaceJRChangeEventsSupport
- Returns:
- the property change support object for this instance
-
getHyperlinkParameters
public JRHyperlinkParameter[] getHyperlinkParameters()
Description copied from interface:JRHyperlink
Returns the list of hyperlink parameters.The parameters can be used by custom hyperlink types to generate dynamic links.
- Specified by:
getHyperlinkParameters
in interfaceJRHyperlink
- Returns:
- the list of hyperlink parameters
-
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
-
-