JRDesignImage (JasperReports Library 6.17.0 API)

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

All Implemented Interfaces:

Serializable, Cloneable, JRChangeEventsSupport, JRAnchor, JRBoxContainer, JRChild, JRCloneable, JRCommonElement, JRCommonGraphicElement, JRCommonImage, JRElement, JREvaluation, JRGraphicElement, JRHyperlink, JRIdentifiable, JRImage, JRImageAlignment, JRPenContainer, JRPropertiesHolder, JRStyleContainer, JRVisitable
```
public class JRDesignImage
extends JRDesignGraphicElement
implements JRImage
```
The actual implementation of a graphic element representing an image, used at design time.

Author:

Teodor Danciu ([email protected])

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected JRExpression`	`anchorNameExpression`
`protected int`	`bookmarkLevel` The bookmark level for the anchor associated with this image.
`protected JRExpression`	`bookmarkLevelExpression`
`protected JRGroup`	`evaluationGroup`
`protected EvaluationTimeEnum`	`evaluationTimeValue`
`protected JRExpression`	`expression`
`protected HorizontalImageAlignEnum`	`horizontalImageAlign`
`protected JRExpression`	`hyperlinkAnchorExpression`
`protected JRExpression`	`hyperlinkPageExpression`
`protected JRExpression`	`hyperlinkReferenceExpression`
`protected JRExpression`	`hyperlinkWhenExpression`
`protected boolean`	`isLazy`
`protected Boolean`	`isUsingCache`
`protected JRLineBox`	`lineBox`
`protected String`	`linkTarget`
`protected String`	`linkType`
`protected OnErrorTypeEnum`	`onErrorTypeValue`
`static String`	`PROPERTY_ANCHOR_NAME_EXPRESSION`
`static String`	`PROPERTY_BOOKMARK_LEVEL`
`static String`	`PROPERTY_BOOKMARK_LEVEL_EXPRESSION`
`static String`	`PROPERTY_EVALUATION_GROUP`
`static String`	`PROPERTY_EVALUATION_TIME`
`static String`	`PROPERTY_EXPRESSION`
`protected RotationEnum`	`rotation`
`protected ScaleImageEnum`	`scaleImageValue`
`protected VerticalImageAlignEnum`	`verticalImageAlign`

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

Constructors
Constructor and Description

JRDesignImage(JRDefaultStyleProvider defaultStyleProvider)

Constructors
Constructor and Description
`JRDesignImage(JRDefaultStyleProvider defaultStyleProvider)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
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.
`JRExpression`	`getBookmarkLevelExpression()` Returns an expression whose value represents the bookmark level (starting from 1) corresponding to this anchor.
`Float`	`getDefaultLineWidth()`
`JRGroup`	`getEvaluationGroup()` Gets the evaluation group for this text field.
`EvaluationTimeEnum`	`getEvaluationTimeValue()` Gets the evaluation time for this text field.
`JRExpression`	`getExpression()`
`HorizontalImageAlignEnum`	`getHorizontalImageAlign()` Gets the image 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.
`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.
`JRLineBox`	`getLineBox()`
`String`	`getLinkTarget()` Returns the hyperlink target name.
`String`	`getLinkType()` Returns the hyperlink type.
`ModeEnum`	`getModeValue()` Returns the element transparency mode.
`OnErrorTypeEnum`	`getOnErrorTypeValue()` Indicates how the engine will treat a missing image.
`HorizontalImageAlignEnum`	`getOwnHorizontalImageAlign()`
`RotationEnum`	`getOwnRotation()` Gets the image own rotation.
`ScaleImageEnum`	`getOwnScaleImageValue()` Gets the image own scale type.
`VerticalImageAlignEnum`	`getOwnVerticalImageAlign()`
`RotationEnum`	`getRotation()` Gets the image rotation.
`ScaleImageEnum`	`getScaleImageValue()` Gets the image scale type.
`Boolean`	`getUsingCache()` Indicates if the engine is loading the current image from cache.
`VerticalImageAlignEnum`	`getVerticalImageAlign()` Gets the image vertical alignment.
`boolean`	`isLazy()` Indicates if the images will be loaded lazily or not.
`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 image.
`void`	`setBookmarkLevelExpression(JRExpression bookmarkLevelExpression)`
`void`	`setEvaluationGroup(JRGroup evaluationGroup)`
`void`	`setEvaluationTime(EvaluationTimeEnum evaluationTimeValue)` Sets the evaluation time for this image.
`void`	`setExpression(JRExpression expression)`
`void`	`setHorizontalImageAlign(HorizontalImageAlignEnum horizontalImageAlign)` Sets the image horizontal alignment.
`void`	`setHyperlinkAnchorExpression(JRExpression hyperlinkAnchorExpression)`
`void`	`setHyperlinkPageExpression(JRExpression hyperlinkPageExpression)`
`void`	`setHyperlinkReferenceExpression(JRExpression hyperlinkReferenceExpression)`
`void`	`setHyperlinkTarget(HyperlinkTargetEnum hyperlinkTarget)`
`void`	`setHyperlinkTooltipExpression(JRExpression hyperlinkTooltipExpression)` Sets the expression which will be used to generate the hyperlink tooltip.
`void`	`setHyperlinkType(HyperlinkTypeEnum hyperlinkType)` Sets the link type as a built-in hyperlink type.
`void`	`setHyperlinkWhenExpression(JRExpression hyperlinkWhenExpression)`
`void`	`setLazy(boolean isLazy)` Gives control over when the images are retrieved from their specified location.
`void`	`setLinkTarget(String target)` Sets the hyperlink target name.
`void`	`setLinkType(String type)` Sets the hyperlink type.
`void`	`setOnErrorType(OnErrorTypeEnum onErrorTypeValue)` Specifies how the engine should treat a missing image.
`void`	`setRotation(RotationEnum rotation)` Sets the image rotation.
`void`	`setScaleImage(ScaleImageEnum scaleImageValue)` Sets the image scale type.
`void`	`setUsingCache(boolean isUsingCache)` Deprecated. Replaced by `setUsingCache(Boolean)`.
`void`	`setUsingCache(Boolean isUsingCache)` Specifies if the engine should be loading the current image from cache.
`void`	`setVerticalImageAlign(VerticalImageAlignEnum verticalImageAlign)` Gets the image 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
clone, 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.JRIdentifiable
getUUID

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.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
  - PROPERTY_ANCHOR_NAME_EXPRESSION
```
public static final String PROPERTY_ANCHOR_NAME_EXPRESSION
```
    See Also:
    
    Constant Field Values
  - PROPERTY_BOOKMARK_LEVEL
```
public static final String PROPERTY_BOOKMARK_LEVEL
```
    See Also:
    
    Constant Field Values
  - PROPERTY_BOOKMARK_LEVEL_EXPRESSION
```
public static final String PROPERTY_BOOKMARK_LEVEL_EXPRESSION
```
    See Also:
    
    Constant Field Values
  - PROPERTY_EVALUATION_GROUP
```
public static final String PROPERTY_EVALUATION_GROUP
```
    See Also:
    
    Constant Field Values
  - PROPERTY_EVALUATION_TIME
```
public static final String PROPERTY_EVALUATION_TIME
```
    See Also:
    
    Constant Field Values
  - PROPERTY_EXPRESSION
```
public static final String PROPERTY_EXPRESSION
```
    See Also:
    
    Constant Field Values
  - scaleImageValue
```
protected ScaleImageEnum scaleImageValue
```
  - rotation
```
protected RotationEnum rotation
```
  - horizontalImageAlign
```
protected HorizontalImageAlignEnum horizontalImageAlign
```
  - verticalImageAlign
```
protected VerticalImageAlignEnum verticalImageAlign
```
  - isUsingCache
```
protected Boolean isUsingCache
```
  - isLazy
```
protected boolean isLazy
```
  - onErrorTypeValue
```
protected OnErrorTypeEnum onErrorTypeValue
```
  - evaluationTimeValue
```
protected EvaluationTimeEnum evaluationTimeValue
```
  - linkType
```
protected String linkType
```
  - linkTarget
```
protected String linkTarget
```
  - lineBox
```
protected JRLineBox lineBox
```
  - evaluationGroup
```
protected JRGroup evaluationGroup
```
  - expression
```
protected JRExpression expression
```
  - anchorNameExpression
```
protected JRExpression anchorNameExpression
```
  - bookmarkLevelExpression
```
protected JRExpression bookmarkLevelExpression
```
  - hyperlinkReferenceExpression
```
protected JRExpression hyperlinkReferenceExpression
```
  - hyperlinkWhenExpression
```
protected JRExpression hyperlinkWhenExpression
```
  - hyperlinkAnchorExpression
```
protected JRExpression hyperlinkAnchorExpression
```
  - hyperlinkPageExpression
```
protected JRExpression hyperlinkPageExpression
```
  - bookmarkLevel
```
protected int bookmarkLevel
```
    The bookmark level for the anchor associated with this image.
    
    See Also:
    
    JRAnchor.getBookmarkLevel()
- Constructor Detail
  - JRDesignImage
```
public JRDesignImage(JRDefaultStyleProvider defaultStyleProvider)
```
- Method Detail
  - getModeValue
```
public ModeEnum getModeValue()
```
    Description copied from interface: JRCommonElement
    
    Returns the element transparency mode. The default value depends on the type of the report element. Graphic elements like rectangles and lines are opaque by default, but the images are transparent. Both static texts and text fields are transparent by default, and so are the subreport elements.
    
    Specified by:
    
    getModeValue in interface JRCommonElement
    
    Overrides:
    
    getModeValue in class JRBaseElement
  - getScaleImageValue
```
public ScaleImageEnum getScaleImageValue()
```
    Description copied from interface: JRCommonImage
    
    Gets the image scale type.
    
    Specified by:
    
    getScaleImageValue in interface JRCommonImage
    
    Returns:
    
    a value representing one of the scale type constants in ScaleImageEnum
  - getOwnScaleImageValue
```
public ScaleImageEnum getOwnScaleImageValue()
```
    Description copied from interface: JRCommonImage
    
    Gets the image own scale type.
    
    Specified by:
    
    getOwnScaleImageValue in interface JRCommonImage
    
    Returns:
    
    a value representing one of the scale type constants in ScaleImageEnum
  - setScaleImage
```
public void setScaleImage(ScaleImageEnum scaleImageValue)
```
    Description copied from interface: JRCommonImage
    
    Sets the image scale type.
    
    Specified by:
    
    setScaleImage in interface JRCommonImage
    
    Parameters:
    
    scaleImageValue - a value representing one of the scale type constants in ScaleImageEnum
  - getRotation
```
public RotationEnum getRotation()
```
    Description copied from interface: JRCommonImage
    
    Gets the image rotation.
    
    Specified by:
    
    getRotation in interface JRCommonImage
    
    Returns:
    
    a value representing one of the image rotation constants in RotationEnum
  - getOwnRotation
```
public RotationEnum getOwnRotation()
```
    Description copied from interface: JRCommonImage
    
    Gets the image own rotation.
    
    Specified by:
    
    getOwnRotation in interface JRCommonImage
    
    Returns:
    
    a value representing one of the image rotation constants in RotationEnum
  - setRotation
```
public void setRotation(RotationEnum rotation)
```
    Description copied from interface: JRCommonImage
    
    Sets the image rotation.
    
    Specified by:
    
    setRotation in interface JRCommonImage
    
    Parameters:
    
    rotation - a value representing one of the image rotation constants in RotationEnum
  - getHorizontalImageAlign
```
public HorizontalImageAlignEnum getHorizontalImageAlign()
```
    Description copied from interface: JRImageAlignment
    
    Gets the image horizontal alignment.
    
    Specified by:
    
    getHorizontalImageAlign in interface JRImageAlignment
    
    Returns:
    
    a value representing one of the horizontal image alignment constants in HorizontalImageAlignEnum
  - getOwnHorizontalImageAlign
```
public HorizontalImageAlignEnum getOwnHorizontalImageAlign()
```
    Specified by:
    
    getOwnHorizontalImageAlign in interface JRImageAlignment
  - setHorizontalImageAlign
```
public void setHorizontalImageAlign(HorizontalImageAlignEnum horizontalImageAlign)
```
    Description copied from interface: JRImageAlignment
    
    Sets the image horizontal alignment.
    
    Specified by:
    
    setHorizontalImageAlign in interface JRImageAlignment
    
    Parameters:
    
    horizontalImageAlign - a value representing one of the horizontal image alignment constants in HorizontalImageAlignEnum
  - getVerticalImageAlign
```
public VerticalImageAlignEnum getVerticalImageAlign()
```
    Description copied from interface: JRImageAlignment
    
    Gets the image vertical alignment.
    
    Specified by:
    
    getVerticalImageAlign in interface JRImageAlignment
    
    Returns:
    
    a value representing one of the vertical image alignment constants in VerticalImageAlignEnum
  - getOwnVerticalImageAlign
```
public VerticalImageAlignEnum getOwnVerticalImageAlign()
```
    Specified by:
    
    getOwnVerticalImageAlign in interface JRImageAlignment
  - setVerticalImageAlign
```
public void setVerticalImageAlign(VerticalImageAlignEnum verticalImageAlign)
```
    Description copied from interface: JRImageAlignment
    
    Gets the image vertical alignment.
    
    Specified by:
    
    setVerticalImageAlign in interface JRImageAlignment
    
    Parameters:
    
    verticalImageAlign - a value representing one of the vertical image alignment constants in VerticalImageAlignEnum
  - getUsingCache
```
public Boolean getUsingCache()
```
    Description copied from interface: JRImage
    
    Indicates if the engine is loading the current image from cache. Implementations of this method return the actual value for the internal flag that was explicitly set on this image element.
    
    Specified by:
    
    getUsingCache in interface JRImage
    
    Returns:
    
    Boolean.TRUE if the image should be loaded from cache, Boolean.FALSE otherwise or null in case the flag was never explicitly set on this image element
  - getEvaluationTimeValue
```
public EvaluationTimeEnum getEvaluationTimeValue()
```
    Description copied from interface: JREvaluation
    
    Gets the evaluation time for this text field.
    
    Specified by:
    
    getEvaluationTimeValue in interface JREvaluation
    
    Returns:
    
    one of the evaluation time constants in JRExpression
  - getLineBox
```
public JRLineBox getLineBox()
```
    Specified by:
    
    getLineBox in interface JRBoxContainer
  - getHyperlinkType
```
public byte getHyperlinkType()
```
    Deprecated. Replaced by getHyperlinkTypeValue().
  - 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()
  - getHyperlinkTarget
```
public byte getHyperlinkTarget()
```
    Description copied from interface: JRHyperlink
    
    Retrieves the hyperlink target for the element.
    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.
    
    Specified by:
    
    getHyperlinkTarget in interface JRHyperlink
    
    Returns:
    
    one of the hyperlink target constants
    
    See Also:
    
    JRHyperlink.getLinkTarget()
  - getEvaluationGroup
```
public JRGroup getEvaluationGroup()
```
    Description copied from interface: JREvaluation
    
    Gets the evaluation group for this text field. Used only when evaluation time is group.
    
    Specified by:
    
    getEvaluationGroup in interface JREvaluation
    
    See Also:
    
    EvaluationTimeEnum.GROUP
  - getExpression
```
public JRExpression getExpression()
```
    Specified by:
    
    getExpression in interface JRImage
  - getAnchorNameExpression
```
public JRExpression getAnchorNameExpression()
```
    Description copied from interface: JRAnchor
    
    Returns an expression whose value represents the anchor name.
    
    Specified by:
    
    getAnchorNameExpression in interface JRAnchor
  - 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
  - setUsingCache
```
public void setUsingCache(boolean isUsingCache)
```
    Deprecated. Replaced by setUsingCache(Boolean).
    
    Description copied from interface: JRImage
    
    Specifies if the engine should be loading the current image from cache. If set to true, the reporting engine will try to recognize previously loaded images using their specified source. For example, it will recognize an image if the image source is a file name that it has already loaded, or if it is the same URL.
    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.
    
    Specified by:
    
    setUsingCache in interface JRImage
  - setUsingCache
```
public void setUsingCache(Boolean isUsingCache)
```
    Description copied from interface: JRImage
    
    Specifies if the engine should be loading the current image from cache. If set to Boolean.TRUE, the reporting engine will try to recognize previously loaded images using their specified source. For example, it will recognize an image if the image source is a file name that it has already loaded, or if it is the same URL.
    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.
    
    Specified by:
    
    setUsingCache in interface JRImage
  - isLazy
```
public boolean isLazy()
```
    Description copied from interface: JRImage
    
    Indicates if the images will be loaded lazily or not.
    
    Specified by:
    
    isLazy in interface JRImage
  - setLazy
```
public void setLazy(boolean isLazy)
```
    Description copied from interface: JRImage
    
    Gives control over when the images are retrieved from their specified location. If set to true, the image is loaded from the specified location only when the document is viewed or exported to other formats. Otherwise it is loaded during the report filling process and stored in the resulting document.
    
    Specified by:
    
    setLazy in interface JRImage
    
    Parameters:
    
    isLazy - specifies whether
  - getOnErrorTypeValue
```
public OnErrorTypeEnum getOnErrorTypeValue()
```
    Description copied from interface: JRImage
    
    Indicates how the engine will treat a missing image.
    
    Specified by:
    
    getOnErrorTypeValue in interface JRImage
    
    Returns:
    
    a value representing one of the missing image handling constants in OnErrorTypeEnum
  - setOnErrorType
```
public void setOnErrorType(OnErrorTypeEnum onErrorTypeValue)
```
    Description copied from interface: JRImage
    
    Specifies how the engine should treat a missing image.
    
    Specified by:
    
    setOnErrorType in interface JRImage
    
    Parameters:
    
    onErrorTypeValue - a value representing one of the missing image handling constants in OnErrorTypeEnum
  - setEvaluationTime
```
public void setEvaluationTime(EvaluationTimeEnum evaluationTimeValue)
```
    Sets the evaluation time for this image.
  - setHyperlinkType
```
public void setHyperlinkType(HyperlinkTypeEnum hyperlinkType)
```
    Sets the link type as a built-in hyperlink type.
    
    Parameters:
    
    hyperlinkType - the built-in hyperlink type
    
    See Also:
    
    getLinkType()
  - setHyperlinkTarget
```
public void setHyperlinkTarget(HyperlinkTargetEnum hyperlinkTarget)
```
  - setEvaluationGroup
```
public void setEvaluationGroup(JRGroup evaluationGroup)
```
  - setExpression
```
public void setExpression(JRExpression expression)
```
  - setAnchorNameExpression
```
public void setAnchorNameExpression(JRExpression anchorNameExpression)
```
  - setBookmarkLevelExpression
```
public void setBookmarkLevelExpression(JRExpression bookmarkLevelExpression)
```
  - setHyperlinkReferenceExpression
```
public void setHyperlinkReferenceExpression(JRExpression hyperlinkReferenceExpression)
```
  - setHyperlinkWhenExpression
```
public void setHyperlinkWhenExpression(JRExpression hyperlinkWhenExpression)
```
  - setHyperlinkAnchorExpression
```
public void setHyperlinkAnchorExpression(JRExpression hyperlinkAnchorExpression)
```
  - setHyperlinkPageExpression
```
public void setHyperlinkPageExpression(JRExpression hyperlinkPageExpression)
```
  - visit
```
public void visit(JRVisitor visitor)
```
    Specified by:
    
    visit in interface JRVisitable
  - collectExpressions
```
public void collectExpressions(JRExpressionCollector collector)
```
    Specified by:
    
    collectExpressions in interface JRElement
  - 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)
```
    Sets the boomark level for the anchor associated with this image.
    
    Parameters:
    
    bookmarkLevel - the bookmark level (starting from 1) or NO_BOOKMARK if no bookmark should be created
  - getDefaultLineWidth
```
public Float getDefaultLineWidth()
```
    Specified by:
    
    getDefaultLineWidth in interface JRPenContainer
    
    Overrides:
    
    getDefaultLineWidth in class JRDesignGraphicElement
  - getLinkType
```
public 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 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
  - setLinkType
```
public void setLinkType(String type)
```
    Sets the hyperlink type.
    The type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.
    
    Parameters:
    
    type - the hyperlink type
  - setLinkTarget
```
public void setLinkTarget(String target)
```
    Sets the hyperlink target name.
    The target name can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.
    
    Parameters:
    
    target - the hyperlink target name
  - 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 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(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
  - 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
  - setHyperlinkTooltipExpression
```
public void setHyperlinkTooltipExpression(JRExpression hyperlinkTooltipExpression)
```
    Sets the expression which will be used to generate the hyperlink tooltip.
    
    Parameters:
    
    hyperlinkTooltipExpression - the expression which will be used to generate the hyperlink tooltip
    
    See Also:
    
    getHyperlinkTooltipExpression()
  - clone
```
public Object clone()
```
    Specified by:
    
    clone in interface JRCloneable
    
    Overrides:
    
    clone in class JRDesignGraphicElement

Class JRDesignImage

Field Summary

Fields inherited from class net.sf.jasperreports.engine.design.JRDesignGraphicElement

Fields inherited from class net.sf.jasperreports.engine.design.JRDesignElement

Fields inherited from class net.sf.jasperreports.engine.base.JRBaseElement

Fields inherited from interface net.sf.jasperreports.engine.JRAnchor

Constructor Summary

Method Summary

Methods inherited from class net.sf.jasperreports.engine.design.JRDesignGraphicElement

Methods inherited from class net.sf.jasperreports.engine.design.JRDesignElement

Methods inherited from class net.sf.jasperreports.engine.base.JRBaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface net.sf.jasperreports.engine.JRElement

Methods inherited from interface net.sf.jasperreports.engine.JRChild

Methods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder

Methods inherited from interface net.sf.jasperreports.engine.JRIdentifiable

Methods inherited from interface net.sf.jasperreports.engine.JRCommonGraphicElement

Methods inherited from interface net.sf.jasperreports.engine.JRCommonElement

Methods inherited from interface net.sf.jasperreports.engine.JRPenContainer

Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer

Methods inherited from interface net.sf.jasperreports.engine.JRBoxContainer

Field Detail

PROPERTY_ANCHOR_NAME_EXPRESSION

PROPERTY_BOOKMARK_LEVEL

PROPERTY_BOOKMARK_LEVEL_EXPRESSION

PROPERTY_EVALUATION_GROUP

PROPERTY_EVALUATION_TIME

PROPERTY_EXPRESSION

scaleImageValue

rotation

horizontalImageAlign

verticalImageAlign

isUsingCache

isLazy

onErrorTypeValue

evaluationTimeValue

linkType

linkTarget

lineBox

evaluationGroup

expression

anchorNameExpression

bookmarkLevelExpression

hyperlinkReferenceExpression

hyperlinkWhenExpression

hyperlinkAnchorExpression

hyperlinkPageExpression

bookmarkLevel

Constructor Detail

JRDesignImage

Method Detail

getModeValue

getScaleImageValue

getOwnScaleImageValue

setScaleImage

getRotation

getOwnRotation

setRotation

getHorizontalImageAlign

getOwnHorizontalImageAlign

setHorizontalImageAlign

getVerticalImageAlign

getOwnVerticalImageAlign

setVerticalImageAlign

getUsingCache

getEvaluationTimeValue

getLineBox

getHyperlinkType

getHyperlinkTypeValue

getHyperlinkTarget

getEvaluationGroup

getExpression

getAnchorNameExpression

getBookmarkLevelExpression

getHyperlinkReferenceExpression

getHyperlinkWhenExpression

getHyperlinkAnchorExpression

getHyperlinkPageExpression

setUsingCache

setUsingCache