Package net.sf.jasperreports.charts.design

Class JRDesignChart

java.lang.Object
net.sf.jasperreports.engine.base.JRBaseElement
net.sf.jasperreports.engine.design.JRDesignElement
net.sf.jasperreports.charts.design.JRDesignChart
All Implemented Interfaces:
Serializable, Cloneable, JRChart, JRChangeEventsSupport, JRAnchor, JRBoxContainer, JRChild, JRCloneable, JRCommonElement, JRElement, JREvaluation, JRHyperlink, JRIdentifiable, JRPropertiesHolder, JRStyleContainer, JRVisitable
public class JRDesignChart extends JRDesignElement implements JRChart
Author:
Teodor Danciu (teodord@users.sourceforge.net)
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • getShowLegend

      public Boolean getShowLegend()
      Specified by:
      getShowLegend in interface JRChart

    • setShowLegend

      public void setShowLegend(Boolean isShowLegend)
      Specified by:
      setShowLegend in interface JRChart

    • getRenderType

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

    • setRenderType

      public void setRenderType(String renderType)
      Specified by:
      setRenderType in interface JRChart

    • getTheme

      public String getTheme()
      Specified by:
      getTheme in interface JRChart

    • setTheme

      public void setTheme(String theme)
      Specified by:
      setTheme in interface JRChart

    • getEvaluationTime

      public EvaluationTimeEnum getEvaluationTime()
      Description copied from interface: JREvaluation
      Gets the evaluation time for this text field.
      Specified by:
      getEvaluationTime in interface JREvaluation
      Returns:
      one of the evaluation time constants in JRExpression

    • setEvaluationTime

      public void setEvaluationTime(EvaluationTimeEnum evaluationTime)

    • getEvaluationGroup

      public String getEvaluationGroup()
      Description copied from interface: JREvaluation
      Gets the evaluation group for this text field. Used only when evaluation time is group.
      Specified by:
      getEvaluationGroup in interface JREvaluation
      See Also:

    • setEvaluationGroup

      public void setEvaluationGroup(String group)

    • getLineBox

      public JRLineBox getLineBox()
      Specified by:
      getLineBox in interface JRBoxContainer

    • getTitleFont

      public JRFont getTitleFont()
      Specified by:
      getTitleFont in interface JRChart

    • setTitleFont

      public void setTitleFont(JRFont font)

    • getTitlePosition

      public EdgeEnum getTitlePosition()
      Description copied from interface: JRChart
      Gets the title position relative to the chart.
      Specified by:
      getTitlePosition in interface JRChart

    • setTitlePosition

      public void setTitlePosition(EdgeEnum titlePosition)
      Description copied from interface: JRChart
      Sets the title position relative to the chart.
      Specified by:
      setTitlePosition in interface JRChart

    • getTitleColor

      public Color getTitleColor()
      Specified by:
      getTitleColor in interface JRChart

    • getOwnTitleColor

      public Color getOwnTitleColor()
      Specified by:
      getOwnTitleColor in interface JRChart

    • setTitleColor

      public void setTitleColor(Color titleColor)
      Specified by:
      setTitleColor in interface JRChart

    • getSubtitleFont

      public JRFont getSubtitleFont()
      Specified by:
      getSubtitleFont in interface JRChart

    • setSubtitleFont

      public void setSubtitleFont(JRFont font)

    • getSubtitleColor

      public Color getSubtitleColor()
      Specified by:
      getSubtitleColor in interface JRChart

    • getOwnSubtitleColor

      public Color getOwnSubtitleColor()
      Specified by:
      getOwnSubtitleColor in interface JRChart

    • setSubtitleColor

      public void setSubtitleColor(Color subtitleColor)
      Specified by:
      setSubtitleColor in interface JRChart

    • getOwnLegendColor

      public Color getOwnLegendColor()
      Specified by:
      getOwnLegendColor in interface JRChart

    • getLegendColor

      public Color getLegendColor()
      Specified by:
      getLegendColor in interface JRChart

    • setLegendColor

      public void setLegendColor(Color legendColor)
      Specified by:
      setLegendColor in interface JRChart

    • getOwnLegendBackgroundColor

      public Color getOwnLegendBackgroundColor()
      Specified by:
      getOwnLegendBackgroundColor in interface JRChart

    • getLegendBackgroundColor

      public Color getLegendBackgroundColor()
      Specified by:
      getLegendBackgroundColor in interface JRChart

    • setLegendBackgroundColor

      public void setLegendBackgroundColor(Color legendBackgroundColor)
      Specified by:
      setLegendBackgroundColor in interface JRChart

    • getLegendFont

      public JRFont getLegendFont()
      Specified by:
      getLegendFont in interface JRChart

    • setLegendFont

      public void setLegendFont(JRFont legendFont)

    • getLegendPosition

      public EdgeEnum getLegendPosition()
      Specified by:
      getLegendPosition in interface JRChart

    • setLegendPosition

      public void setLegendPosition(EdgeEnum legendPosition)
      Specified by:
      setLegendPosition in interface JRChart

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

    • setHyperlinkType

      public void setHyperlinkType(HyperlinkTypeEnum hyperlinkType)
      Sets the link type as a built-in hyperlink type.
      Parameters:
      hyperlinkType - the built-in hyperlink type
      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:

    • setHyperlinkTarget

      public void setHyperlinkTarget(HyperlinkTargetEnum hyperlinkTarget)

    • getTitleExpression

      public JRExpression getTitleExpression()
      Description copied from interface: JRChart
      Gets the expression whose evaluation will form the title.
      Specified by:
      getTitleExpression in interface JRChart

    • setTitleExpression

      public void setTitleExpression(JRExpression expression)

    • getSubtitleExpression

      public JRExpression getSubtitleExpression()
      Description copied from interface: JRChart
      Gets the expression whose evaluation will form the subtitle.
      Specified by:
      getSubtitleExpression in interface JRChart

    • setSubtitleExpression

      public void setSubtitleExpression(JRExpression expression)

    • getAnchorNameExpression

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

    • setAnchorNameExpression

      public void setAnchorNameExpression(JRExpression anchorNameExpression)

    • 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

    • setBookmarkLevelExpression

      public void setBookmarkLevelExpression(JRExpression bookmarkLevelExpression)

    • 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

    • setHyperlinkReferenceExpression

      public void setHyperlinkReferenceExpression(JRExpression hyperlinkReferenceExpression)

    • 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

    • setHyperlinkWhenExpression

      public void setHyperlinkWhenExpression(JRExpression hyperlinkWhenExpression)

    • 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

    • setHyperlinkAnchorExpression

      public void setHyperlinkAnchorExpression(JRExpression hyperlinkAnchorExpression)

    • 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

    • setHyperlinkPageExpression

      public void setHyperlinkPageExpression(JRExpression hyperlinkPageExpression)

    • 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

    • getChartType

      public ChartTypeEnum 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

    • setChartType

      public void setChartType(ChartTypeEnum chartType)

    • setDataset

      public void setDataset(JRChartDataset ds)

    • collectExpressions

      public void collectExpressions(JRExpressionCollector collector)
      Specified by:
      collectExpressions in interface JRElement

    • visit

      public void visit(JRVisitor visitor)
      Specified by:
      visit in interface JRVisitable

    • 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)
      Sets the boomark level for the anchor associated with this chart.
      Parameters:
      bookmarkLevel - the bookmark level (starting from 1) or NO_BOOKMARK if no bookmark should be created

    • getCustomizerClass

      public String getCustomizerClass()
      Description copied from interface: JRChart
      Gets a user specified chart customizer class name.
      Specified by:
      getCustomizerClass in interface JRChart
      See Also:

    • setCustomizerClass

      public void setCustomizerClass(String customizerClass)
      Sets a user specified chart customizer class name.
      See Also:

    • getMode

      public ModeEnum getMode()
      Description copied from interface: JRCommonElement
      Returns the element transparency mode. The default value depends on the type of the report element. Graphic elements like rectangles and lines are opaque by default, but the images are transparent. Both static texts and text fields are transparent by default, and so are the subreport elements.
      Specified by:
      getMode in interface JRCommonElement
      Overrides:
      getMode in class JRBaseElement

    • 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

    • setLinkType

      public void setLinkType(String type)
      Sets the hyperlink type.

      The type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.

      Parameters:
      type - 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

    • setLinkTarget

      public void setLinkTarget(String target)
      Sets the hyperlink target.

      The target can be one of the built-in target names (Self, Blank, Top, Parent), or can be an arbitrary target name.

      Parameters:
      target - the hyperlink target

    • 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

    • 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

    • setHyperlinkTooltipExpression

      public void setHyperlinkTooltipExpression(JRExpression hyperlinkTooltipExpression)
      Sets the expression which will be used to generate the hyperlink tooltip.
      Parameters:
      hyperlinkTooltipExpression - the expression which will be used to generate the hyperlink tooltip
      See Also:

    • getDefaultLineColor

      public Color getDefaultLineColor()
      Specified by:
      getDefaultLineColor in interface JRBoxContainer

    • clone

      public Object clone()
      Specified by:
      clone in interface JRCloneable
      Overrides:
      clone in class JRDesignElement