public class JRDesignChart extends JRDesignElement implements JRChart
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_Ybackcolor, defaultStyleProvider, elementGroup, forecolor, height, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, key, modeValue, parentStyle, parentStyleNameReference, positionTypeValue, 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, stretchTypeValue, uuid, width, x, yCHART_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, PROPERTY_CHART_RENDER_TYPE, PROPERTY_CHART_THEME, RENDER_TYPE_DRAW, RENDER_TYPE_IMAGE, RENDER_TYPE_SVGNO_BOOKMARK| Constructor and Description |
|---|
JRDesignChart(JRDefaultStyleProvider defaultStyleProvider,
byte chartType) |
| Modifier and Type | Method and 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.
|
int |
getBookmarkLevel()
Returns the level of the bookmark corresponding to the anchor.
|
byte |
getChartType()
Gets the chart type.
|
String |
getCustomizerClass()
Gets a user specified chart customizer class name.
|
JRChartDataset |
getDataset()
Gets the chart dataset.
|
Color |
getDefaultLineColor() |
JRGroup |
getEvaluationGroup()
Gets the evaluation group for this text field.
|
EvaluationTimeEnum |
getEvaluationTimeValue()
Gets the evaluation time for this text field.
|
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.
|
byte |
getHyperlinkTarget()
Retrieves the hyperlink target for the element.
|
JRExpression |
getHyperlinkTooltipExpression()
Returns the expression which will generate the hyperlink tooltip.
|
byte |
getHyperlinkType()
Deprecated.
Replaced by
getHyperlinkTypeValue(). |
HyperlinkTypeEnum |
getHyperlinkTypeValue()
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 |
getLegendPositionValue() |
JRLineBox |
getLineBox() |
String |
getLinkTarget()
Returns the hyperlink target name.
|
String |
getLinkType()
Returns the hyperlink type.
|
ModeEnum |
getModeValue()
Returns the element transparency mode.
|
Color |
getOwnLegendBackgroundColor() |
Color |
getOwnLegendColor() |
Color |
getOwnSubtitleColor() |
Color |
getOwnTitleColor() |
JRChartPlot |
getPlot()
Gets the chart plot.
|
String |
getRenderType() |
Boolean |
getShowLegend() |
Color |
getSubtitleColor() |
JRExpression |
getSubtitleExpression()
Gets the expression whose evaluation will form the subtitle.
|
JRFont |
getSubtitleFont() |
String |
getTheme() |
Color |
getTitleColor() |
JRExpression |
getTitleExpression()
Gets the expression whose evaluation will form the title.
|
JRFont |
getTitleFont() |
EdgeEnum |
getTitlePositionValue()
Gets the title position relative to the chart.
|
void |
removeHyperlinkParameter(JRHyperlinkParameter parameter)
Removes a custom hyperlink parameter.
|
void |
removeHyperlinkParameter(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 |
setChartType(byte chartType) |
void |
setCustomizerClass(String customizerClass)
Sets a user specified chart customizer class name.
|
void |
setDataset(JRChartDataset ds) |
void |
setEvaluationGroup(JRGroup group) |
void |
setEvaluationTime(EvaluationTimeEnum evaluationTimeValue) |
void |
setHyperlinkAnchorExpression(JRExpression hyperlinkAnchorExpression) |
void |
setHyperlinkPageExpression(JRExpression hyperlinkPageExpression) |
void |
setHyperlinkReferenceExpression(JRExpression hyperlinkReferenceExpression) |
void |
setHyperlinkTarget(byte hyperlinkTarget)
Deprecated.
Replaced by
setHyperlinkTarget(HyperlinkTargetEnum). |
void |
setHyperlinkTarget(HyperlinkTargetEnum hyperlinkTarget) |
void |
setHyperlinkTooltipExpression(JRExpression hyperlinkTooltipExpression)
Sets the expression which will be used to generate the hyperlink tooltip.
|
void |
setHyperlinkType(byte hyperlinkType)
Deprecated.
Replaced by
setHyperlinkType(HyperlinkTypeEnum). |
void |
setHyperlinkType(HyperlinkTypeEnum hyperlinkType)
Sets the link type as a built-in hyperlink type.
|
void |
setHyperlinkWhenExpression(JRExpression hyperlinkWhenExpression) |
void |
setLegendBackgroundColor(Color legendBackgroundColor) |
void |
setLegendColor(Color legendColor) |
void |
setLegendFont(JRFont legendFont) |
void |
setLegendPosition(EdgeEnum legendPositionValue) |
void |
setLinkTarget(String target)
Sets the hyperlink target.
|
void |
setLinkType(String type)
Sets the hyperlink type.
|
void |
setRenderType(String renderType) |
void |
setShowLegend(Boolean isShowLegend) |
void |
setSubtitleColor(Color subtitleColor) |
void |
setSubtitleExpression(JRExpression expression) |
void |
setSubtitleFont(JRFont font) |
void |
setTheme(String theme) |
void |
setTitleColor(Color titleColor) |
void |
setTitleExpression(JRExpression expression) |
void |
setTitleFont(JRFont font) |
void |
setTitlePosition(EdgeEnum titlePositionValue)
Sets the title position relative to the chart.
|
void |
visit(JRVisitor visitor) |
addPropertyExpression, getPropertyExpressions, getPropertyExpressionsList, removePropertyExpression, removePropertyExpression, setElementGroup, setHeight, setKey, setPrintWhenExpression, setPrintWhenGroupChanges, setStyle, setStyleNameReference, setUUID, setYclone, clone, getBackcolor, getBaseStyle, getDefaultStyleProvider, getElementGroup, getEventSupport, getForecolor, getHeight, getKey, getOwnBackcolor, getOwnForecolor, getOwnModeValue, getParentProperties, getPositionTypeValue, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertiesMap, getStretchTypeValue, getStyle, getStyleNameReference, getStyleResolver, getUUID, getWidth, getX, getY, hasProperties, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, setMode, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setXequals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitclone, getElementGroup, getKey, getPositionTypeValue, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertyExpressions, getStretchTypeValue, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setXgetBackcolor, getForecolor, getHeight, getOwnBackcolor, getOwnForecolor, getOwnModeValue, getWidth, setBackcolor, setForecolor, setModegetDefaultStyleProvider, getStyle, getStyleNameReferencegetParentProperties, getPropertiesMap, hasPropertiesgetUUIDpublic static final String EXCEPTION_MESSAGE_KEY_UNSUPPORTED_CHART_TYPE
public static final String PROPERTY_ANCHOR_NAME_EXPRESSION
public static final String PROPERTY_BOOKMARK_LEVEL
public static final String PROPERTY_EVALUATION_GROUP
public static final String PROPERTY_EVALUATION_TIME
public static final String PROPERTY_CHART_TYPE
public static final String PROPERTY_CUSTOMIZER_CLASS
public static final String PROPERTY_DATASET
public static final String PROPERTY_LEGEND_FONT
public static final String PROPERTY_SUBTITLE_EXPRESSION
public static final String PROPERTY_SUBTITLE_FONT
public static final String PROPERTY_TITLE_EXPRESSION
public static final String PROPERTY_TITLE_FONT
protected byte chartType
protected Boolean showLegend
protected EvaluationTimeEnum evaluationTimeValue
protected String linkType
protected String linkTarget
protected Color titleColor
protected Color subtitleColor
protected Color legendColor
protected Color legendBackgroundColor
protected String renderType
protected String theme
protected JRFont titleFont
protected JRFont subtitleFont
protected JRFont legendFont
protected EdgeEnum legendPositionValue
protected EdgeEnum titlePositionValue
protected String customizerClass
protected JRGroup evaluationGroup
protected JRExpression titleExpression
protected JRExpression subtitleExpression
protected JRExpression anchorNameExpression
protected JRExpression hyperlinkReferenceExpression
protected JRExpression hyperlinkWhenExpression
protected JRExpression hyperlinkAnchorExpression
protected JRExpression hyperlinkPageExpression
protected JRChartDataset dataset
protected JRChartPlot plot
protected JRLineBox lineBox
protected int bookmarkLevel
JRAnchor.getBookmarkLevel()public JRDesignChart(JRDefaultStyleProvider defaultStyleProvider, byte chartType)
public Boolean getShowLegend()
getShowLegend in interface JRChartpublic void setShowLegend(Boolean isShowLegend)
setShowLegend in interface JRChartpublic String getRenderType()
getRenderType in interface JRChartpublic void setRenderType(String renderType)
setRenderType in interface JRChartpublic EvaluationTimeEnum getEvaluationTimeValue()
JREvaluationgetEvaluationTimeValue in interface JREvaluationJRExpressionpublic void setEvaluationTime(EvaluationTimeEnum evaluationTimeValue)
public JRGroup getEvaluationGroup()
JREvaluationgetEvaluationGroup in interface JREvaluationEvaluationTimeEnum.GROUPpublic void setEvaluationGroup(JRGroup group)
public JRLineBox getLineBox()
getLineBox in interface JRBoxContainerpublic JRFont getTitleFont()
getTitleFont in interface JRChartpublic void setTitleFont(JRFont font)
public EdgeEnum getTitlePositionValue()
JRChartgetTitlePositionValue in interface JRChartpublic void setTitlePosition(EdgeEnum titlePositionValue)
JRChartsetTitlePosition in interface JRChartpublic Color getTitleColor()
getTitleColor in interface JRChartpublic Color getOwnTitleColor()
getOwnTitleColor in interface JRChartpublic void setTitleColor(Color titleColor)
setTitleColor in interface JRChartpublic JRFont getSubtitleFont()
getSubtitleFont in interface JRChartpublic void setSubtitleFont(JRFont font)
public Color getSubtitleColor()
getSubtitleColor in interface JRChartpublic Color getOwnSubtitleColor()
getOwnSubtitleColor in interface JRChartpublic void setSubtitleColor(Color subtitleColor)
setSubtitleColor in interface JRChartpublic Color getOwnLegendColor()
getOwnLegendColor in interface JRChartpublic Color getLegendColor()
getLegendColor in interface JRChartpublic void setLegendColor(Color legendColor)
setLegendColor in interface JRChartpublic Color getOwnLegendBackgroundColor()
getOwnLegendBackgroundColor in interface JRChartpublic Color getLegendBackgroundColor()
getLegendBackgroundColor in interface JRChartpublic void setLegendBackgroundColor(Color legendBackgroundColor)
setLegendBackgroundColor in interface JRChartpublic JRFont getLegendFont()
getLegendFont in interface JRChartpublic void setLegendFont(JRFont legendFont)
public EdgeEnum getLegendPositionValue()
getLegendPositionValue in interface JRChartpublic void setLegendPosition(EdgeEnum legendPositionValue)
setLegendPosition in interface JRChartpublic byte getHyperlinkType()
getHyperlinkTypeValue().public HyperlinkTypeEnum getHyperlinkTypeValue()
JRHyperlink
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.
getHyperlinkTypeValue in interface JRHyperlinkJRHyperlink.getLinkType()public void setHyperlinkType(byte hyperlinkType)
setHyperlinkType(HyperlinkTypeEnum).public void setHyperlinkType(HyperlinkTypeEnum hyperlinkType)
hyperlinkType - the built-in hyperlink typegetLinkType()public byte getHyperlinkTarget()
JRHyperlink
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.
getHyperlinkTarget in interface JRHyperlinkJRHyperlink.getLinkTarget()public void setHyperlinkTarget(byte hyperlinkTarget)
setHyperlinkTarget(HyperlinkTargetEnum).public void setHyperlinkTarget(HyperlinkTargetEnum hyperlinkTarget)
public JRExpression getTitleExpression()
JRChartgetTitleExpression in interface JRChartpublic void setTitleExpression(JRExpression expression)
public JRExpression getSubtitleExpression()
JRChartgetSubtitleExpression in interface JRChartpublic void setSubtitleExpression(JRExpression expression)
public JRExpression getAnchorNameExpression()
JRAnchorgetAnchorNameExpression in interface JRAnchorpublic void setAnchorNameExpression(JRExpression anchorNameExpression)
public JRExpression getHyperlinkReferenceExpression()
JRHyperlinkgetHyperlinkReferenceExpression in interface JRHyperlinkpublic void setHyperlinkReferenceExpression(JRExpression hyperlinkReferenceExpression)
public JRExpression getHyperlinkWhenExpression()
JRHyperlinkgetHyperlinkWhenExpression in interface JRHyperlinkpublic void setHyperlinkWhenExpression(JRExpression hyperlinkWhenExpression)
public JRExpression getHyperlinkAnchorExpression()
JRHyperlinkgetHyperlinkAnchorExpression in interface JRHyperlinkpublic void setHyperlinkAnchorExpression(JRExpression hyperlinkAnchorExpression)
public JRExpression getHyperlinkPageExpression()
JRHyperlinkgetHyperlinkPageExpression in interface JRHyperlinkpublic void setHyperlinkPageExpression(JRExpression hyperlinkPageExpression)
public JRChartDataset getDataset()
JRChartgetDataset in interface JRChartpublic JRChartPlot getPlot()
JRChartpublic byte getChartType()
JRChartgetChartType in interface JRChartpublic void setChartType(byte chartType)
public void setDataset(JRChartDataset ds)
public void collectExpressions(JRExpressionCollector collector)
collectExpressions in interface JRElementpublic void visit(JRVisitor visitor)
visit in interface JRVisitablepublic int getBookmarkLevel()
JRAnchorgetBookmarkLevel in interface JRAnchorNO_BOOKMARK if no bookmark should be created for this anchorpublic void setBookmarkLevel(int bookmarkLevel)
bookmarkLevel - the bookmark level (starting from 1)
or NO_BOOKMARK if no bookmark should be createdpublic String getCustomizerClass()
JRChartgetCustomizerClass in interface JRChartJRChartCustomizerpublic void setCustomizerClass(String customizerClass)
JRChartCustomizerpublic ModeEnum getModeValue()
JRCommonElementgetModeValue in interface JRCommonElementgetModeValue in class JRBaseElementpublic String getLinkType()
JRHyperlinkThe type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.
getLinkType in interface JRHyperlinkpublic void setLinkType(String type)
The type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.
type - the hyperlink typepublic String getLinkTarget()
JRHyperlinkThe type can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.
getLinkTarget in interface JRHyperlinkpublic void setLinkTarget(String target)
The target can be one of the built-in target names (Self, Blank, Top, Parent), or can be an arbitrary target name.
target - the hyperlink targetpublic JRHyperlinkParameter[] getHyperlinkParameters()
JRHyperlinkThe parameters can be used by custom hyperlink types to generate dynamic links.
getHyperlinkParameters in interface JRHyperlinkpublic List<JRHyperlinkParameter> getHyperlinkParametersList()
public void addHyperlinkParameter(JRHyperlinkParameter parameter)
parameter - the parameter to addpublic void removeHyperlinkParameter(JRHyperlinkParameter parameter)
parameter - the parameter to removepublic void removeHyperlinkParameter(String parameterName)
If multiple parameters having the specified name exist, all of them will be removed
parameterName - the parameter namepublic JRExpression getHyperlinkTooltipExpression()
JRHyperlinkgetHyperlinkTooltipExpression in interface JRHyperlinkpublic void setHyperlinkTooltipExpression(JRExpression hyperlinkTooltipExpression)
hyperlinkTooltipExpression - the expression which will be used to generate the hyperlink tooltipgetHyperlinkTooltipExpression()public Color getDefaultLineColor()
getDefaultLineColor in interface JRBoxContainerpublic Object clone()
clone in interface JRCloneableclone in class JRDesignElementCopyright © 2017. All rights reserved.