|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.jasperreports.engine.base.JRBaseElement net.sf.jasperreports.engine.design.JRDesignElement net.sf.jasperreports.engine.design.JRDesignChart
public class JRDesignChart
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 EvaluationTimeEnum |
evaluationTimeValue
|
protected JRExpression |
hyperlinkAnchorExpression
|
protected JRExpression |
hyperlinkPageExpression
|
protected JRExpression |
hyperlinkReferenceExpression
|
protected java.awt.Color |
legendBackgroundColor
|
protected java.awt.Color |
legendColor
|
protected JRFont |
legendFont
|
protected EdgeEnum |
legendPositionValue
|
protected JRLineBox |
lineBox
|
protected java.lang.String |
linkTarget
|
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.lang.Boolean |
showLegend
|
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 EdgeEnum |
titlePositionValue
|
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 interface net.sf.jasperreports.engine.JRAnchor |
---|
NO_BOOKMARK |
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 |
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). |
EvaluationTimeEnum |
getEvaluationTimeValue()
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<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. |
java.awt.Color |
getLegendBackgroundColor()
|
java.awt.Color |
getLegendColor()
|
JRFont |
getLegendFont()
|
EdgeEnum |
getLegendPositionValue()
|
JRLineBox |
getLineBox()
|
java.lang.String |
getLinkTarget()
Returns the hyperlink target name. |
java.lang.String |
getLinkType()
Returns the hyperlink type. |
ModeEnum |
getModeValue()
Returns the element transparency mode. |
java.awt.Color |
getOwnLegendBackgroundColor()
|
java.awt.Color |
getOwnLegendColor()
|
java.awt.Color |
getOwnSubtitleColor()
|
java.awt.Color |
getOwnTitleColor()
|
JRChartPlot |
getPlot()
Gets the chart plot. |
java.lang.String |
getRenderType()
|
java.lang.Boolean |
getShowLegend()
|
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()
|
EdgeEnum |
getTitlePositionValue()
Gets the title position relative to the chart. |
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 |
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(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 |
setLegendBackgroundColor(java.awt.Color legendBackgroundColor)
|
void |
setLegendColor(java.awt.Color legendColor)
|
void |
setLegendFont(JRFont legendFont)
|
void |
setLegendPosition(EdgeEnum legendPositionValue)
|
void |
setLinkTarget(java.lang.String target)
Sets the hyperlink target. |
void |
setLinkType(java.lang.String type)
Sets the hyperlink type. |
void |
setRenderType(java.lang.String renderType)
|
void |
setShowLegend(java.lang.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(EdgeEnum titlePositionValue)
Sets the title position relative to the chart. |
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, setUUID, setY |
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, getKey, getPositionTypeValue, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertyExpressions, getStretchTypeValue, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, 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, getHeight, getOwnBackcolor, getOwnForecolor, getOwnModeValue, getWidth, setBackcolor, setForecolor, setMode |
Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer |
---|
getDefaultStyleProvider, getStyle, getStyleNameReference |
Methods inherited from interface net.sf.jasperreports.engine.JRIdentifiable |
---|
getUUID |
Methods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder |
---|
getParentProperties, getPropertiesMap, hasProperties |
Field Detail |
---|
public static final java.lang.String PROPERTY_ANCHOR_NAME_EXPRESSION
public static final java.lang.String PROPERTY_BOOKMARK_LEVEL
public static final java.lang.String PROPERTY_EVALUATION_GROUP
public static final java.lang.String PROPERTY_EVALUATION_TIME
public static final java.lang.String PROPERTY_CHART_TYPE
public static final java.lang.String PROPERTY_CUSTOMIZER_CLASS
public static final java.lang.String PROPERTY_DATASET
public static final java.lang.String PROPERTY_LEGEND_FONT
public static final java.lang.String PROPERTY_SUBTITLE_EXPRESSION
public static final java.lang.String PROPERTY_SUBTITLE_FONT
public static final java.lang.String PROPERTY_TITLE_EXPRESSION
public static final java.lang.String PROPERTY_TITLE_FONT
protected byte chartType
protected java.lang.Boolean showLegend
protected EvaluationTimeEnum evaluationTimeValue
protected java.lang.String linkType
protected java.lang.String linkTarget
protected java.awt.Color titleColor
protected java.awt.Color subtitleColor
protected java.awt.Color legendColor
protected java.awt.Color legendBackgroundColor
protected java.lang.String renderType
protected java.lang.String theme
protected JRFont titleFont
protected JRFont subtitleFont
protected JRFont legendFont
protected EdgeEnum legendPositionValue
protected EdgeEnum titlePositionValue
protected java.lang.String customizerClass
protected JRGroup evaluationGroup
protected JRExpression titleExpression
protected JRExpression subtitleExpression
protected JRExpression anchorNameExpression
protected JRExpression hyperlinkReferenceExpression
protected JRExpression hyperlinkAnchorExpression
protected JRExpression hyperlinkPageExpression
protected JRChartDataset dataset
protected JRChartPlot plot
protected JRLineBox lineBox
protected int bookmarkLevel
JRAnchor.getBookmarkLevel()
Constructor Detail |
---|
public JRDesignChart(JRDefaultStyleProvider defaultStyleProvider, byte chartType)
Method Detail |
---|
public java.lang.Boolean getShowLegend()
getShowLegend
in interface JRChart
public void setShowLegend(java.lang.Boolean isShowLegend)
setShowLegend
in interface JRChart
public java.lang.String getRenderType()
getRenderType
in interface JRChart
public void setRenderType(java.lang.String renderType)
setRenderType
in interface JRChart
public java.lang.String getTheme()
getTheme
in interface JRChart
public void setTheme(java.lang.String theme)
setTheme
in interface JRChart
public EvaluationTimeEnum getEvaluationTimeValue()
JRChart
getEvaluationTimeValue
in interface JRChart
public void setEvaluationTime(EvaluationTimeEnum evaluationTimeValue)
public JRGroup getEvaluationGroup()
JRChart
getEvaluationGroup
in interface JRChart
public void setEvaluationGroup(JRGroup group)
public JRLineBox getLineBox()
getLineBox
in interface JRBoxContainer
public JRFont getTitleFont()
getTitleFont
in interface JRChart
public void setTitleFont(JRFont font)
public EdgeEnum getTitlePositionValue()
JRChart
getTitlePositionValue
in interface JRChart
public void setTitlePosition(EdgeEnum titlePositionValue)
JRChart
setTitlePosition
in interface JRChart
public java.awt.Color getTitleColor()
getTitleColor
in interface JRChart
public java.awt.Color getOwnTitleColor()
getOwnTitleColor
in interface JRChart
public void setTitleColor(java.awt.Color titleColor)
setTitleColor
in interface JRChart
public JRFont getSubtitleFont()
getSubtitleFont
in interface JRChart
public void setSubtitleFont(JRFont font)
public java.awt.Color getSubtitleColor()
getSubtitleColor
in interface JRChart
public java.awt.Color getOwnSubtitleColor()
getOwnSubtitleColor
in interface JRChart
public void setSubtitleColor(java.awt.Color subtitleColor)
setSubtitleColor
in interface JRChart
public java.awt.Color getOwnLegendColor()
getOwnLegendColor
in interface JRChart
public java.awt.Color getLegendColor()
getLegendColor
in interface JRChart
public void setLegendColor(java.awt.Color legendColor)
setLegendColor
in interface JRChart
public java.awt.Color getOwnLegendBackgroundColor()
getOwnLegendBackgroundColor
in interface JRChart
public java.awt.Color getLegendBackgroundColor()
getLegendBackgroundColor
in interface JRChart
public void setLegendBackgroundColor(java.awt.Color legendBackgroundColor)
setLegendBackgroundColor
in interface JRChart
public JRFont getLegendFont()
getLegendFont
in interface JRChart
public void setLegendFont(JRFont legendFont)
public EdgeEnum getLegendPositionValue()
getLegendPositionValue
in interface JRChart
public void setLegendPosition(EdgeEnum legendPositionValue)
setLegendPosition
in interface JRChart
public byte getHyperlinkType()
getHyperlinkTypeValue()
.
getHyperlinkType
in interface JRHyperlink
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 JRHyperlink
JRHyperlink.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 JRHyperlink
JRHyperlink.getLinkTarget()
public void setHyperlinkTarget(byte hyperlinkTarget)
setHyperlinkTarget(HyperlinkTargetEnum)
.
public void setHyperlinkTarget(HyperlinkTargetEnum hyperlinkTarget)
public JRExpression getTitleExpression()
JRChart
getTitleExpression
in interface JRChart
public void setTitleExpression(JRExpression expression)
public JRExpression getSubtitleExpression()
JRChart
getSubtitleExpression
in interface JRChart
public void setSubtitleExpression(JRExpression expression)
public JRExpression getAnchorNameExpression()
JRAnchor
getAnchorNameExpression
in interface JRAnchor
public void setAnchorNameExpression(JRExpression anchorNameExpression)
public JRExpression getHyperlinkReferenceExpression()
JRHyperlink
getHyperlinkReferenceExpression
in interface JRHyperlink
public void setHyperlinkReferenceExpression(JRExpression hyperlinkReferenceExpression)
public JRExpression getHyperlinkAnchorExpression()
JRHyperlink
getHyperlinkAnchorExpression
in interface JRHyperlink
public void setHyperlinkAnchorExpression(JRExpression hyperlinkAnchorExpression)
public JRExpression getHyperlinkPageExpression()
JRHyperlink
getHyperlinkPageExpression
in interface JRHyperlink
public void setHyperlinkPageExpression(JRExpression hyperlinkPageExpression)
public JRChartDataset getDataset()
JRChart
getDataset
in interface JRChart
public JRChartPlot getPlot()
JRChart
getPlot
in interface JRChart
public byte getChartType()
JRChart
getChartType
in interface JRChart
public void setChartType(byte chartType)
public void setDataset(JRChartDataset ds)
public void collectExpressions(JRExpressionCollector collector)
collectExpressions
in interface JRElement
public void visit(JRVisitor visitor)
visit
in interface JRVisitable
public int getBookmarkLevel()
JRAnchor
getBookmarkLevel
in interface JRAnchor
NO_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 java.lang.String getCustomizerClass()
JRChart
getCustomizerClass
in interface JRChart
JRChartCustomizer
public void setCustomizerClass(java.lang.String customizerClass)
JRChartCustomizer
public ModeEnum getModeValue()
JRCommonElement
getModeValue
in interface JRCommonElement
getModeValue
in class JRBaseElement
public java.lang.String getLinkType()
JRHyperlink
The type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.
getLinkType
in interface JRHyperlink
public void setLinkType(java.lang.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 java.lang.String getLinkTarget()
JRHyperlink
The type can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.
getLinkTarget
in interface JRHyperlink
public void setLinkTarget(java.lang.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()
JRHyperlink
The parameters can be used by custom hyperlink types to generate dynamic links.
getHyperlinkParameters
in interface JRHyperlink
public java.util.List<JRHyperlinkParameter> getHyperlinkParametersList()
public void addHyperlinkParameter(JRHyperlinkParameter parameter)
parameter
- the parameter to addpublic void removeHyperlinkParameter(JRHyperlinkParameter parameter)
parameter
- the parameter to removepublic void removeHyperlinkParameter(java.lang.String parameterName)
If multiple parameters having the specified name exist, all of them will be removed
parameterName
- the parameter namepublic JRExpression getHyperlinkTooltipExpression()
JRHyperlink
getHyperlinkTooltipExpression
in interface JRHyperlink
public void setHyperlinkTooltipExpression(JRExpression hyperlinkTooltipExpression)
hyperlinkTooltipExpression
- the expression which will be used to generate the hyperlink tooltipgetHyperlinkTooltipExpression()
public java.awt.Color getDefaultLineColor()
getDefaultLineColor
in interface JRBoxContainer
public java.lang.Object clone()
clone
in interface JRCloneable
clone
in class JRBaseElement
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |