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:

  • Field Details

  • Constructor Details

  • 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()
      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 interface JRHyperlink
      Returns:
      one of the hyperlink type constants
      See Also:

    • 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 interface JRHyperlink
      Returns:
      one of the hyperlink target constants
      See Also:

    • getTitleExpression

      public JRExpression getTitleExpression()
      Specified by:
      getTitleExpression in interface ChartSettings

    • getSubtitleExpression

      public JRExpression getSubtitleExpression()
      Specified by:
      getSubtitleExpression in interface ChartSettings

    • getAnchorNameExpression

      public JRExpression getAnchorNameExpression()
      Description copied from interface: JRAnchor
      Returns an expression whose value represents the anchor name.
      Specified by:
      getAnchorNameExpression in interface JRAnchor

    • 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 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

    • 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 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

    • getRenderType

      public String getRenderType()
      Specified by:
      getRenderType in interface ChartSettings

    • 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 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

    • 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 interface JRHyperlink
      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 interface JRHyperlink
      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 interface JRHyperlink
      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 interface ChartSettings
      Returns:
      the customizerClass
      See Also:

    • 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()
      Description copied from interface: JRChangeEventsSupport
      Returns the property change support object for this instance.
      Specified by:
      getEventSupport in interface JRChangeEventsSupport
      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 interface JRHyperlink
      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