Class StandardChartSettings

    • Field Detail

      • PROPERTY_LEGEND_BACKGROUND_COLOR

        public static final java.lang.String PROPERTY_LEGEND_BACKGROUND_COLOR
        See Also:
        Constant Field Values
      • PROPERTY_LEGEND_COLOR

        public static final java.lang.String PROPERTY_LEGEND_COLOR
        See Also:
        Constant Field Values
      • PROPERTY_LEGEND_POSITION

        public static final java.lang.String PROPERTY_LEGEND_POSITION
        See Also:
        Constant Field Values
      • PROPERTY_SHOW_LEGEND

        public static final java.lang.String PROPERTY_SHOW_LEGEND
        See Also:
        Constant Field Values
      • PROPERTY_SUBTITLE_COLOR

        public static final java.lang.String PROPERTY_SUBTITLE_COLOR
        See Also:
        Constant Field Values
      • PROPERTY_TITLE_COLOR

        public static final java.lang.String PROPERTY_TITLE_COLOR
        See Also:
        Constant Field Values
      • PROPERTY_TITLE_POSITION

        public static final java.lang.String PROPERTY_TITLE_POSITION
        See Also:
        Constant Field Values
      • PROPERTY_RENDER_TYPE

        public static final java.lang.String PROPERTY_RENDER_TYPE
        See Also:
        Constant Field Values
      • PROPERTY_BOOKMARK_LEVEL

        public static final java.lang.String PROPERTY_BOOKMARK_LEVEL
        See Also:
        Constant Field Values
      • PROPERTY_BACKCOLOR

        public static final java.lang.String PROPERTY_BACKCOLOR
        See Also:
        Constant Field Values
      • PROPERTY_ANCHOR_NAME_EXPRESSION

        public static final java.lang.String PROPERTY_ANCHOR_NAME_EXPRESSION
        See Also:
        Constant Field Values
      • PROPERTY_BOOKMARK_LEVEL_EXPRESSION

        public static final java.lang.String PROPERTY_BOOKMARK_LEVEL_EXPRESSION
        See Also:
        Constant Field Values
      • PROPERTY_EVALUATION_GROUP

        public static final java.lang.String PROPERTY_EVALUATION_GROUP
        See Also:
        Constant Field Values
      • PROPERTY_EVALUATION_TIME

        public static final java.lang.String PROPERTY_EVALUATION_TIME
        See Also:
        Constant Field Values
      • PROPERTY_CHART_TYPE

        public static final java.lang.String PROPERTY_CHART_TYPE
        See Also:
        Constant Field Values
      • PROPERTY_LEGEND_FONT

        public static final java.lang.String PROPERTY_LEGEND_FONT
        See Also:
        Constant Field Values
      • PROPERTY_SUBTITLE_EXPRESSION

        public static final java.lang.String PROPERTY_SUBTITLE_EXPRESSION
        See Also:
        Constant Field Values
      • PROPERTY_SUBTITLE_FONT

        public static final java.lang.String PROPERTY_SUBTITLE_FONT
        See Also:
        Constant Field Values
      • PROPERTY_TITLE_EXPRESSION

        public static final java.lang.String PROPERTY_TITLE_EXPRESSION
        See Also:
        Constant Field Values
      • PROPERTY_TITLE_FONT

        public static final java.lang.String PROPERTY_TITLE_FONT
        See Also:
        Constant Field Values
      • PROPERTY_HYPERLINK_ANCHOR_EXPRESSION

        public static final java.lang.String PROPERTY_HYPERLINK_ANCHOR_EXPRESSION
        See Also:
        Constant Field Values
      • PROPERTY_HYPERLINK_PAGE_EXPRESSION

        public static final java.lang.String PROPERTY_HYPERLINK_PAGE_EXPRESSION
        See Also:
        Constant Field Values
      • PROPERTY_HYPERLINK_REFERENCE_EXPRESSION

        public static final java.lang.String PROPERTY_HYPERLINK_REFERENCE_EXPRESSION
        See Also:
        Constant Field Values
      • PROPERTY_HYPERLINK_WHEN_EXPRESSION

        public static final java.lang.String PROPERTY_HYPERLINK_WHEN_EXPRESSION
        See Also:
        Constant Field Values
      • PROPERTY_HYPERLINK_TARGET

        public static final java.lang.String PROPERTY_HYPERLINK_TARGET
        See Also:
        Constant Field Values
      • PROPERTY_LINK_TARGET

        public static final java.lang.String PROPERTY_LINK_TARGET
        See Also:
        Constant Field Values
      • PROPERTY_HYPERLINK_TOOLTIP_EXPRESSION

        public static final java.lang.String PROPERTY_HYPERLINK_TOOLTIP_EXPRESSION
        See Also:
        Constant Field Values
      • PROPERTY_LINK_TYPE

        public static final java.lang.String PROPERTY_LINK_TYPE
        See Also:
        Constant Field Values
      • PROPERTY_HYPERLINK_PARAMETERS

        public static final java.lang.String PROPERTY_HYPERLINK_PARAMETERS
        See Also:
        Constant Field Values
      • PROPERTY_CUSTOMIZER_CLASS

        public static final java.lang.String PROPERTY_CUSTOMIZER_CLASS
        See Also:
        Constant Field Values
      • chartType

        protected java.lang.Byte chartType
      • showLegend

        protected java.lang.Boolean showLegend
      • linkType

        protected java.lang.String linkType
      • linkTarget

        protected java.lang.String linkTarget
      • backcolor

        protected java.awt.Color backcolor
      • titleColor

        protected java.awt.Color titleColor
      • subtitleColor

        protected java.awt.Color subtitleColor
      • legendColor

        protected java.awt.Color legendColor
      • legendBackgroundColor

        protected java.awt.Color legendBackgroundColor
      • legendPosition

        protected EdgeEnum legendPosition
      • titlePosition

        protected EdgeEnum titlePosition
      • renderType

        protected java.lang.String renderType
      • titleFont

        protected JRFont titleFont
      • subtitleFont

        protected JRFont subtitleFont
      • legendFont

        protected JRFont legendFont
      • 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 java.lang.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()
    • Method Detail

      • setShowLegend

        public void setShowLegend​(java.lang.Boolean isShowLegend)
      • setBackcolor

        public void setBackcolor​(java.awt.Color backcolor)
      • setTitlePosition

        public void setTitlePosition​(EdgeEnum titlePosition)
      • setTitleColor

        public void setTitleColor​(java.awt.Color titleColor)
      • setSubtitleColor

        public void setSubtitleColor​(java.awt.Color subtitleColor)
      • setLegendBackgroundColor

        public void setLegendBackgroundColor​(java.awt.Color legendBackgroundColor)
      • setLegendColor

        public void setLegendColor​(java.awt.Color legendColor)
      • setLegendPosition

        public void setLegendPosition​(EdgeEnum legendPosition)
      • getHyperlinkTypeValue

        public HyperlinkTypeEnum getHyperlinkTypeValue()
        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:
        getHyperlinkTypeValue in interface JRHyperlink
        Returns:
        one of the hyperlink type constants
        See Also:
        JRHyperlink.getLinkType()
      • 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
      • setRenderType

        public void setRenderType​(java.lang.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 java.lang.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 java.lang.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
      • setChartType

        public void setChartType​(java.lang.Byte chartType)
        Parameters:
        chartType - the chartType to set
      • setLinkType

        public void setLinkType​(java.lang.String linkType)
        Parameters:
        linkType - the linkType to set
      • setLinkTarget

        public void setLinkTarget​(java.lang.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​(java.lang.String customizerClass)
        Parameters:
        customizerClass - the customizerClass to set
      • clone

        public java.lang.Object clone()
        Specified by:
        clone in interface JRCloneable
        Overrides:
        clone in class java.lang.Object
      • 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 java.util.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​(java.lang.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