net.sf.jasperreports.engine.design
Class JRDesignChart

java.lang.Object
  extended by net.sf.jasperreports.engine.base.JRBaseElement
      extended by net.sf.jasperreports.engine.design.JRDesignElement
          extended by net.sf.jasperreports.engine.design.JRDesignChart
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, JRChangeEventsSupport, JRAnchor, JRBox, JRBoxContainer, JRChart, JRChild, JRCloneable, JRCommonElement, JRElement, JRHyperlink, JRPropertiesHolder, JRStyleContainer, JRVisitable

public class JRDesignChart
extends JRDesignElement
implements JRChart

Version:
$Id: JRDesignChart.java 2336 2008-09-02 12:18:37Z lucianc $
Author:
Teodor Danciu (teodord@users.sourceforge.net)
See Also:
Serialized Form

Field Summary
protected  JRExpression anchorNameExpression
           
protected  int bookmarkLevel
          The bookmark level for the anchor associated with this chart.
protected  byte chartType
           
protected  java.lang.String customizerClass
           
protected  JRChartDataset dataset
           
protected  JRGroup evaluationGroup
           
protected  byte evaluationTime
           
protected  JRExpression hyperlinkAnchorExpression
           
protected  JRExpression hyperlinkPageExpression
           
protected  JRExpression hyperlinkReferenceExpression
           
protected  byte hyperlinkTarget
           
protected  byte hyperlinkType
           
protected  boolean isShowLegend
           
protected  java.awt.Color legendBackgroundColor
           
protected  java.awt.Color legendColor
           
protected  JRFont legendFont
           
protected  byte legendPosition
           
protected  JRLineBox lineBox
           
protected  java.lang.String linkType
           
protected  JRChartPlot plot
           
static java.lang.String PROPERTY_ANCHOR_NAME_EXPRESSION
           
static java.lang.String PROPERTY_BOOKMARK_LEVEL
           
static java.lang.String PROPERTY_CHART_TYPE
           
static java.lang.String PROPERTY_CUSTOMIZER_CLASS
           
static java.lang.String PROPERTY_DATASET
           
static java.lang.String PROPERTY_EVALUATION_GROUP
           
static java.lang.String PROPERTY_EVALUATION_TIME
           
static java.lang.String PROPERTY_LEGEND_FONT
           
static java.lang.String PROPERTY_SUBTITLE_EXPRESSION
           
static java.lang.String PROPERTY_SUBTITLE_FONT
           
static java.lang.String PROPERTY_TITLE_EXPRESSION
           
static java.lang.String PROPERTY_TITLE_FONT
           
protected  java.lang.String renderType
           
protected  java.awt.Color subtitleColor
           
protected  JRExpression subtitleExpression
           
protected  JRFont subtitleFont
           
protected  java.lang.String theme
           
protected  java.awt.Color titleColor
           
protected  JRExpression titleExpression
           
protected  JRFont titleFont
           
protected  byte titlePosition
           
 
Fields inherited from class net.sf.jasperreports.engine.design.JRDesignElement
PROPERTY_ELEMENT_GROUP, PROPERTY_HEIGHT, PROPERTY_KEY, PROPERTY_PARENT_STYLE, PROPERTY_PARENT_STYLE_NAME_REFERENCE, PROPERTY_PRINT_WHEN_EXPRESSION, PROPERTY_PRINT_WHEN_GROUP_CHANGES, PROPERTY_PROPERTY_EXPRESSIONS, PROPERTY_Y
 
Fields inherited from class net.sf.jasperreports.engine.base.JRBaseElement
backcolor, defaultStyleProvider, elementGroup, forecolor, height, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, key, mode, parentStyle, parentStyleNameReference, positionType, printWhenExpression, printWhenGroupChanges, PROPERTY_POSITION_TYPE, PROPERTY_PRINT_IN_FIRST_WHOLE_BAND, PROPERTY_PRINT_REPEATED_VALUES, PROPERTY_PRINT_WHEN_DETAIL_OVERFLOWS, PROPERTY_REMOVE_LINE_WHEN_BLANK, PROPERTY_STRETCH_TYPE, PROPERTY_WIDTH, PROPERTY_X, stretchType, width, x, y
 
Fields inherited from interface net.sf.jasperreports.engine.JRChart
CHART_TYPE_AREA, CHART_TYPE_BAR, CHART_TYPE_BAR3D, CHART_TYPE_BUBBLE, CHART_TYPE_CANDLESTICK, CHART_TYPE_GANTT, CHART_TYPE_HIGHLOW, CHART_TYPE_LINE, CHART_TYPE_METER, CHART_TYPE_MULTI_AXIS, CHART_TYPE_PIE, CHART_TYPE_PIE3D, CHART_TYPE_SCATTER, CHART_TYPE_STACKEDAREA, CHART_TYPE_STACKEDBAR, CHART_TYPE_STACKEDBAR3D, CHART_TYPE_THERMOMETER, CHART_TYPE_TIMESERIES, CHART_TYPE_XYAREA, CHART_TYPE_XYBAR, CHART_TYPE_XYLINE, EDGE_BOTTOM, EDGE_LEFT, EDGE_RIGHT, EDGE_TOP, PROPERTY_CHART_RENDER_TYPE, PROPERTY_CHART_THEME, RENDER_TYPE_DRAW, RENDER_TYPE_IMAGE, RENDER_TYPE_SVG, TITLE_POSITION_BOTTOM, TITLE_POSITION_LEFT, TITLE_POSITION_RIGHT, TITLE_POSITION_TOP
 
Fields inherited from interface net.sf.jasperreports.engine.JRElement
MODE_OPAQUE, MODE_TRANSPARENT, POSITION_TYPE_FIX_RELATIVE_TO_BOTTOM, POSITION_TYPE_FIX_RELATIVE_TO_TOP, POSITION_TYPE_FLOAT, STRETCH_TYPE_NO_STRETCH, STRETCH_TYPE_RELATIVE_TO_BAND_HEIGHT, STRETCH_TYPE_RELATIVE_TO_TALLEST_OBJECT
 
Fields inherited from interface net.sf.jasperreports.engine.JRAnchor
NO_BOOKMARK
 
Fields inherited from interface net.sf.jasperreports.engine.JRHyperlink
HYPERLINK_TARGET_BLANK, HYPERLINK_TARGET_PARENT, HYPERLINK_TARGET_SELF, HYPERLINK_TARGET_TOP, HYPERLINK_TYPE_CUSTOM, HYPERLINK_TYPE_LOCAL_ANCHOR, HYPERLINK_TYPE_LOCAL_PAGE, HYPERLINK_TYPE_NONE, HYPERLINK_TYPE_NULL, HYPERLINK_TYPE_REFERENCE, HYPERLINK_TYPE_REMOTE_ANCHOR, HYPERLINK_TYPE_REMOTE_PAGE
 
Constructor Summary
JRDesignChart(JRDefaultStyleProvider defaultStyleProvider, byte chartType)
           
 
Method Summary
 void addHyperlinkParameter(JRHyperlinkParameter parameter)
          Adds a custom hyperlink parameter.
 java.lang.Object clone()
           
 void collectExpressions(JRExpressionCollector collector)
           
 JRExpression getAnchorNameExpression()
          Returns an expression whose value represents the anchor name.
 int getBookmarkLevel()
          Returns the level of the bookmark corresponding to the anchor.
 byte getBorder()
          Deprecated. Replaced by getBox()
 java.awt.Color getBorderColor()
          Deprecated. Replaced by getBox()
 byte getBottomBorder()
          Deprecated. Replaced by getBox()
 java.awt.Color getBottomBorderColor()
          Deprecated. Replaced by getBox()
 int getBottomPadding()
          Deprecated. Replaced by getBox()
 JRBox getBox()
          Deprecated. Replaced by getLineBox()
 byte getChartType()
          Gets the chart type.
 java.lang.String getCustomizerClass()
          Gets a user specified chart customizer class name.
 JRChartDataset getDataset()
          Gets the chart dataset.
 java.awt.Color getDefaultLineColor()
           
 JRGroup getEvaluationGroup()
          Gets the evaluation group for this chart (only applies when evaluation time is group).
 byte getEvaluationTime()
          Returns the evaluation time for this chart.
 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.
 java.util.List getHyperlinkParametersList()
          Returns the list of custom hyperlink parameters.
 JRExpression getHyperlinkReferenceExpression()
          Returns the expression whose value represents the hyperlink reference.
 byte getHyperlinkTarget()
          Retrieves the hyperlink target for the element.
 JRExpression getHyperlinkTooltipExpression()
          Returns the expression which will generate the hyperlink tooltip.
 byte getHyperlinkType()
          Retrieves the hyperlink type for the element.
 byte getLeftBorder()
          Deprecated. Replaced by getBox()
 java.awt.Color getLeftBorderColor()
          Deprecated. Replaced by getBox()
 int getLeftPadding()
          Deprecated. Replaced by getBox()
 java.awt.Color getLegendBackgroundColor()
           
 java.awt.Color getLegendColor()
           
 JRFont getLegendFont()
           
 byte getLegendPosition()
           
 JRLineBox getLineBox()
           
 java.lang.String getLinkType()
          Returns the hyperlink type.
 byte getMode()
          Returns the element transparency mode.
 java.lang.Byte getOwnBorder()
          Deprecated. Replaced by getBox()
 java.awt.Color getOwnBorderColor()
          Deprecated. Replaced by getBox()
 java.lang.Byte getOwnBottomBorder()
          Deprecated. Replaced by getBox()
 java.awt.Color getOwnBottomBorderColor()
          Deprecated. Replaced by getBox()
 java.lang.Integer getOwnBottomPadding()
          Deprecated. Replaced by getBox()
 java.lang.Byte getOwnLeftBorder()
          Deprecated. Replaced by getBox()
 java.awt.Color getOwnLeftBorderColor()
          Deprecated. Replaced by getBox()
 java.lang.Integer getOwnLeftPadding()
          Deprecated. Replaced by getBox()
 java.awt.Color getOwnLegendBackgroundColor()
           
 java.awt.Color getOwnLegendColor()
           
 java.lang.Integer getOwnPadding()
          Deprecated. Replaced by getBox()
 java.lang.Byte getOwnRightBorder()
          Deprecated. Replaced by getBox()
 java.awt.Color getOwnRightBorderColor()
          Deprecated. Replaced by getBox()
 java.lang.Integer getOwnRightPadding()
          Deprecated. Replaced by getBox()
 java.awt.Color getOwnSubtitleColor()
           
 java.awt.Color getOwnTitleColor()
           
 java.lang.Byte getOwnTopBorder()
          Deprecated. Replaced by getBox()
 java.awt.Color getOwnTopBorderColor()
          Deprecated. Replaced by getBox()
 java.lang.Integer getOwnTopPadding()
          Deprecated. Replaced by getBox()
 int getPadding()
          Deprecated. Replaced by getBox()
 JRChartPlot getPlot()
          Gets the chart plot.
 java.lang.String getRenderType()
           
 byte getRightBorder()
          Deprecated. Replaced by getBox()
 java.awt.Color getRightBorderColor()
          Deprecated. Replaced by getBox()
 int getRightPadding()
          Deprecated. Replaced by getBox()
 java.awt.Color getSubtitleColor()
           
 JRExpression getSubtitleExpression()
          Gets the expression whose evaluation will form the subtitle.
 JRFont getSubtitleFont()
           
 java.lang.String getTheme()
           
 java.awt.Color getTitleColor()
           
 JRExpression getTitleExpression()
          Gets the expression whose evaluation will form the title.
 JRFont getTitleFont()
           
 byte getTitlePosition()
          Gets the title position relative to the chart.
 byte getTopBorder()
          Deprecated. Replaced by getBox()
 java.awt.Color getTopBorderColor()
          Deprecated. Replaced by getBox()
 int getTopPadding()
          Deprecated. Replaced by getBox()
 boolean isShowLegend()
           
protected  void normalizeLinkType()
           
 void removeHyperlinkParameter(JRHyperlinkParameter parameter)
          Removes a custom hyperlink parameter.
 void removeHyperlinkParameter(java.lang.String parameterName)
          Removes a custom hyperlink parameter.
 void setAnchorNameExpression(JRExpression anchorNameExpression)
           
 void setBookmarkLevel(int bookmarkLevel)
          Sets the boomark level for the anchor associated with this chart.
 void setBorder(byte border)
          Deprecated. Replaced by getBox()
 void setBorder(java.lang.Byte border)
          Deprecated. Replaced by getBox()
 void setBorderColor(java.awt.Color borderColor)
          Deprecated. Replaced by getBox()
 void setBottomBorder(byte bottomBorder)
          Deprecated. Replaced by getBox()
 void setBottomBorder(java.lang.Byte bottomBorder)
          Deprecated. Replaced by getBox()
 void setBottomBorderColor(java.awt.Color bottomBorderColor)
          Deprecated. Replaced by getBox()
 void setBottomPadding(int bottomPadding)
          Deprecated. Replaced by getBox()
 void setBottomPadding(java.lang.Integer bottomPadding)
          Deprecated. Replaced by getBox()
 void setBox(JRBox box)
          Deprecated. Replaced by getLineBox()
 void setChartType(byte chartType)
           
 void setCustomizerClass(java.lang.String customizerClass)
          Sets a user specified chart customizer class name.
 void setDataset(JRChartDataset ds)
           
 void setEvaluationGroup(JRGroup group)
           
 void setEvaluationTime(byte evaluationTime)
           
 void setHyperlinkAnchorExpression(JRExpression hyperlinkAnchorExpression)
           
 void setHyperlinkPageExpression(JRExpression hyperlinkPageExpression)
           
 void setHyperlinkReferenceExpression(JRExpression hyperlinkReferenceExpression)
           
 void setHyperlinkTarget(byte hyperlinkTarget)
           
 void setHyperlinkTooltipExpression(JRExpression hyperlinkTooltipExpression)
          Sets the expression which will be used to generate the hyperlink tooltip.
 void setHyperlinkType(byte hyperlinkType)
          Sets the link type as a built-in hyperlink type.
 void setLeftBorder(byte leftBorder)
          Deprecated. Replaced by getBox()
 void setLeftBorder(java.lang.Byte leftBorder)
          Deprecated. Replaced by getBox()
 void setLeftBorderColor(java.awt.Color leftBorderColor)
          Deprecated. Replaced by getBox()
 void setLeftPadding(int leftPadding)
          Deprecated. Replaced by getBox()
 void setLeftPadding(java.lang.Integer leftPadding)
          Deprecated. Replaced by getBox()
 void setLegendBackgroundColor(java.awt.Color legendBackgroundColor)
           
 void setLegendColor(java.awt.Color legendColor)
           
 void setLegendFont(JRFont legendFont)
           
 void setLegendPosition(byte legendPosition)
           
 void setLinkType(java.lang.String type)
          Sets the hyperlink type.
 void setPadding(int padding)
          Deprecated. Replaced by getBox()
 void setPadding(java.lang.Integer padding)
          Deprecated. Replaced by getBox()
 void setRenderType(java.lang.String renderType)
           
 void setRightBorder(byte rightBorder)
          Deprecated. Replaced by getBox()
 void setRightBorder(java.lang.Byte rightBorder)
          Deprecated. Replaced by getBox()
 void setRightBorderColor(java.awt.Color rightBorderColor)
          Deprecated. Replaced by getBox()
 void setRightPadding(int rightPadding)
          Deprecated. Replaced by getBox()
 void setRightPadding(java.lang.Integer rightPadding)
          Deprecated. Replaced by getBox()
 void setShowLegend(boolean isShowLegend)
           
 void setSubtitleColor(java.awt.Color subtitleColor)
           
 void setSubtitleExpression(JRExpression expression)
           
 void setSubtitleFont(JRFont font)
           
 void setTheme(java.lang.String theme)
           
 void setTitleColor(java.awt.Color titleColor)
           
 void setTitleExpression(JRExpression expression)
           
 void setTitleFont(JRFont font)
           
 void setTitlePosition(byte titlePosition)
          Sets the title position relative to the chart.
 void setTopBorder(byte topBorder)
          Deprecated. Replaced by getBox()
 void setTopBorder(java.lang.Byte topBorder)
          Deprecated. Replaced by getBox()
 void setTopBorderColor(java.awt.Color topBorderColor)
          Deprecated. Replaced by getBox()
 void setTopPadding(int topPadding)
          Deprecated. Replaced by getBox()
 void setTopPadding(java.lang.Integer topPadding)
          Deprecated. Replaced by getBox()
 void visit(JRVisitor visitor)
           
 
Methods inherited from class net.sf.jasperreports.engine.design.JRDesignElement
addPropertyExpression, getPropertyExpressions, getPropertyExpressionsList, removePropertyExpression, removePropertyExpression, setElementGroup, setHeight, setKey, setPrintWhenExpression, setPrintWhenGroupChanges, setStyle, setStyleNameReference, setY
 
Methods inherited from class net.sf.jasperreports.engine.base.JRBaseElement
clone, getBackcolor, getBaseStyle, getDefaultStyleProvider, getElementGroup, getEventSupport, getForecolor, getHeight, getKey, getOwnBackcolor, getOwnForecolor, getOwnMode, getParentProperties, getPositionType, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertiesMap, getStretchType, getStyle, getStyleNameReference, getWidth, getX, getY, hasProperties, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, setMode, setMode, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setX
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface net.sf.jasperreports.engine.JRElement
getElementGroup, getHeight, getKey, getPositionType, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertyExpressions, getStretchType, getWidth, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, setMode, setMode, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setX
 
Methods inherited from interface net.sf.jasperreports.engine.JRChild
clone
 
Methods inherited from interface net.sf.jasperreports.engine.JRCommonElement
getBackcolor, getForecolor, getOwnBackcolor, getOwnForecolor, getOwnMode
 
Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer
getDefaultStyleProvider, getStyle, getStyleNameReference
 
Methods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder
getParentProperties, getPropertiesMap, hasProperties
 

Field Detail

PROPERTY_ANCHOR_NAME_EXPRESSION

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

PROPERTY_BOOKMARK_LEVEL

public static final java.lang.String PROPERTY_BOOKMARK_LEVEL
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_CUSTOMIZER_CLASS

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

PROPERTY_DATASET

public static final java.lang.String PROPERTY_DATASET
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

chartType

protected byte chartType

isShowLegend

protected boolean isShowLegend

evaluationTime

protected byte evaluationTime

hyperlinkType

protected byte hyperlinkType

linkType

protected java.lang.String linkType

hyperlinkTarget

protected byte hyperlinkTarget

titlePosition

protected byte titlePosition

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 byte legendPosition

renderType

protected java.lang.String renderType

theme

protected java.lang.String theme

titleFont

protected JRFont titleFont

subtitleFont

protected JRFont subtitleFont

legendFont

protected JRFont legendFont

customizerClass

protected java.lang.String customizerClass

evaluationGroup

protected JRGroup evaluationGroup

titleExpression

protected JRExpression titleExpression

subtitleExpression

protected JRExpression subtitleExpression

anchorNameExpression

protected JRExpression anchorNameExpression

hyperlinkReferenceExpression

protected JRExpression hyperlinkReferenceExpression