|
||||||||||
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.JRDesignGraphicElement net.sf.jasperreports.engine.design.JRDesignImage
public class JRDesignImage
The actual implementation of a graphic element representing an image, used at design time.
Fields inherited from class net.sf.jasperreports.engine.design.JRDesignGraphicElement |
---|
fillValue, linePen |
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 | |
---|---|
JRDesignImage(JRDefaultStyleProvider defaultStyleProvider)
|
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. |
java.lang.Float |
getDefaultLineWidth()
|
JRGroup |
getEvaluationGroup()
Gets the evaluation group for this text field. |
EvaluationTimeEnum |
getEvaluationTimeValue()
Indicates the evaluation time for this image. |
JRExpression |
getExpression()
|
HorizontalAlignEnum |
getHorizontalAlignmentValue()
Gets the text horizontal alignment. |
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. |
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. |
OnErrorTypeEnum |
getOnErrorTypeValue()
Indicates how the engine will treat a missing image. |
HorizontalAlignEnum |
getOwnHorizontalAlignmentValue()
|
ScaleImageEnum |
getOwnScaleImageValue()
Gets the image own scale type. |
VerticalAlignEnum |
getOwnVerticalAlignmentValue()
|
ScaleImageEnum |
getScaleImageValue()
Gets the image scale type. |
java.lang.Boolean |
getUsingCache()
Indicates if the engine is loading the current image from cache. |
VerticalAlignEnum |
getVerticalAlignmentValue()
Gets the text vertical alignment. |
boolean |
isLazy()
Indicates if the images will be loaded lazily or not. |
java.lang.Boolean |
isOwnUsingCache()
Deprecated. Replaced by getUsingCache() . |
boolean |
isUsingCache()
Deprecated. Replaced by getUsingCache() . |
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 image. |
void |
setEvaluationGroup(JRGroup evaluationGroup)
|
void |
setEvaluationTime(EvaluationTimeEnum evaluationTimeValue)
Sets the evaluation time for this image. |
void |
setExpression(JRExpression expression)
|
void |
setHorizontalAlignment(HorizontalAlignEnum horizontalAlignmentValue)
Sets the text horizontal alignment. |
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 |
setLazy(boolean isLazy)
Gives control over when the images are retrieved from their specified location. |
void |
setLinkTarget(java.lang.String target)
Sets the hyperlink target name. |
void |
setLinkType(java.lang.String type)
Sets the hyperlink type. |
void |
setOnErrorType(OnErrorTypeEnum onErrorTypeValue)
Specifies how the engine should treat a missing image. |
void |
setScaleImage(ScaleImageEnum scaleImageValue)
Sets the image scale type. |
void |
setUsingCache(boolean isUsingCache)
Specifies if the engine should be loading the current image from cache. |
void |
setUsingCache(java.lang.Boolean isUsingCache)
Specifies if the engine should be loading the current image from cache. |
void |
setVerticalAlignment(VerticalAlignEnum verticalAlignmentValue)
Gets the text vertical alignment. |
void |
visit(JRVisitor visitor)
|
Methods inherited from class net.sf.jasperreports.engine.design.JRDesignGraphicElement |
---|
getDefaultLineColor, getFillValue, getLinePen, getOwnFillValue, setFill |
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.JRPropertiesHolder |
---|
getParentProperties, getPropertiesMap, hasProperties |
Methods inherited from interface net.sf.jasperreports.engine.JRCommonGraphicElement |
---|
getFillValue, getLinePen, getOwnFillValue, setFill |
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.JRIdentifiable |
---|
getUUID |
Methods inherited from interface net.sf.jasperreports.engine.JRPenContainer |
---|
getDefaultLineColor |
Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer |
---|
getDefaultStyleProvider, getStyle, getStyleNameReference |
Methods inherited from interface net.sf.jasperreports.engine.JRBoxContainer |
---|
getDefaultLineColor |
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_EXPRESSION
protected ScaleImageEnum scaleImageValue
protected HorizontalAlignEnum horizontalAlignmentValue
protected VerticalAlignEnum verticalAlignmentValue
protected java.lang.Boolean isUsingCache
protected boolean isLazy
protected OnErrorTypeEnum onErrorTypeValue
protected EvaluationTimeEnum evaluationTimeValue
protected java.lang.String linkType
protected java.lang.String linkTarget
protected JRLineBox lineBox
protected JRGroup evaluationGroup
protected JRExpression expression
protected JRExpression anchorNameExpression
protected JRExpression hyperlinkReferenceExpression
protected JRExpression hyperlinkAnchorExpression
protected JRExpression hyperlinkPageExpression
protected int bookmarkLevel
JRAnchor.getBookmarkLevel()
Constructor Detail |
---|
public JRDesignImage(JRDefaultStyleProvider defaultStyleProvider)
Method Detail |
---|
public ModeEnum getModeValue()
JRCommonElement
getModeValue
in interface JRCommonElement
getModeValue
in class JRBaseElement
public ScaleImageEnum getScaleImageValue()
JRCommonImage
getScaleImageValue
in interface JRCommonImage
ScaleImageEnum
public ScaleImageEnum getOwnScaleImageValue()
JRCommonImage
getOwnScaleImageValue
in interface JRCommonImage
ScaleImageEnum
public void setScaleImage(ScaleImageEnum scaleImageValue)
JRCommonImage
setScaleImage
in interface JRCommonImage
scaleImageValue
- a value representing one of the scale type constants in ScaleImageEnum
public HorizontalAlignEnum getHorizontalAlignmentValue()
JRAlignment
getHorizontalAlignmentValue
in interface JRAlignment
HorizontalAlignEnum
public HorizontalAlignEnum getOwnHorizontalAlignmentValue()
getOwnHorizontalAlignmentValue
in interface JRAlignment
public void setHorizontalAlignment(HorizontalAlignEnum horizontalAlignmentValue)
JRAlignment
setHorizontalAlignment
in interface JRAlignment
horizontalAlignmentValue
- a value representing one of the horizontal alignment constants in HorizontalAlignEnum
public VerticalAlignEnum getVerticalAlignmentValue()
JRAlignment
getVerticalAlignmentValue
in interface JRAlignment
VerticalAlignEnum
public VerticalAlignEnum getOwnVerticalAlignmentValue()
getOwnVerticalAlignmentValue
in interface JRAlignment
public void setVerticalAlignment(VerticalAlignEnum verticalAlignmentValue)
JRAlignment
setVerticalAlignment
in interface JRAlignment
verticalAlignmentValue
- a value representing one of the vertical alignment constants in VerticalAlignEnum
public boolean isUsingCache()
getUsingCache()
.
JRImage
isUsingCache
in interface JRImage
public java.lang.Boolean isOwnUsingCache()
getUsingCache()
.
isOwnUsingCache
in interface JRImage
public java.lang.Boolean getUsingCache()
JRImage
getUsingCache
in interface JRImage
public EvaluationTimeEnum getEvaluationTimeValue()
JRImage
getEvaluationTimeValue
in interface JRImage
EvaluationTimeEnum
public JRLineBox getLineBox()
getLineBox
in interface JRBoxContainer
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 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 JRGroup getEvaluationGroup()
JRImage
getEvaluationGroup
in interface JRImage
EvaluationTimeEnum.GROUP
public JRExpression getExpression()
getExpression
in interface JRImage
public JRExpression getAnchorNameExpression()
JRAnchor
getAnchorNameExpression
in interface JRAnchor
public JRExpression getHyperlinkReferenceExpression()
JRHyperlink
getHyperlinkReferenceExpression
in interface JRHyperlink
public JRExpression getHyperlinkAnchorExpression()
JRHyperlink
getHyperlinkAnchorExpression
in interface JRHyperlink
public JRExpression getHyperlinkPageExpression()
JRHyperlink
getHyperlinkPageExpression
in interface JRHyperlink
public void setUsingCache(boolean isUsingCache)
JRImage
For image elements that have expressions returning java.lang.String objects as the image source, representing file names, URLs or classpath resources, the default value for this flag is true.
setUsingCache
in interface JRImage
public void setUsingCache(java.lang.Boolean isUsingCache)
JRImage
If set to null, the engine will rely on some default value which depends on the type of the image expression. The cache is turned on by default only for images that have java.lang.String objects in their expressions.
setUsingCache
in interface JRImage
public boolean isLazy()
JRImage
isLazy
in interface JRImage
public void setLazy(boolean isLazy)
JRImage
setLazy
in interface JRImage
isLazy
- specifies whetherpublic OnErrorTypeEnum getOnErrorTypeValue()
JRImage
getOnErrorTypeValue
in interface JRImage
OnErrorTypeEnum
public void setOnErrorType(OnErrorTypeEnum onErrorTypeValue)
JRImage
setOnErrorType
in interface JRImage
onErrorTypeValue
- a value representing one of the missing image handling constants in OnErrorTypeEnum
public void setEvaluationTime(EvaluationTimeEnum evaluationTimeValue)
public void setHyperlinkType(byte hyperlinkType)
setHyperlinkType(HyperlinkTypeEnum)
.
public void setHyperlinkType(HyperlinkTypeEnum hyperlinkType)
hyperlinkType
- the built-in hyperlink typegetLinkType()
public void setHyperlinkTarget(byte hyperlinkTarget)
setHyperlinkTarget(HyperlinkTargetEnum)
.
public void setHyperlinkTarget(HyperlinkTargetEnum hyperlinkTarget)
public void setEvaluationGroup(JRGroup evaluationGroup)
public void setExpression(JRExpression expression)
public void setAnchorNameExpression(JRExpression anchorNameExpression)
public void setHyperlinkReferenceExpression(JRExpression hyperlinkReferenceExpression)
public void setHyperlinkAnchorExpression(JRExpression hyperlinkAnchorExpression)
public void setHyperlinkPageExpression(JRExpression hyperlinkPageExpression)
public void visit(JRVisitor visitor)
visit
in interface JRVisitable
public void collectExpressions(JRExpressionCollector collector)
collectExpressions
in interface JRElement
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.Float getDefaultLineWidth()
getDefaultLineWidth
in interface JRPenContainer
getDefaultLineWidth
in class JRDesignGraphicElement
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 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 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 void setLinkTarget(java.lang.String target)
The target name can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.
target
- the hyperlink target namepublic 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.lang.Object clone()
clone
in interface JRCloneable
clone
in class JRDesignGraphicElement
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |