Package net.sf.jasperreports.engine.design

Class JRDesignImage

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 (teodord@users.sourceforge.net)
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • getMode

      public ModeEnum getMode()
      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:
      getMode in interface JRCommonElement
      Overrides:
      getMode in class JRBaseElement

    • getScaleImage

      public ScaleImageEnum getScaleImage()
      Description copied from interface: JRCommonImage
      Gets the image scale type.
      Specified by:
      getScaleImage in interface JRCommonImage
      Returns:
      a value representing one of the scale type constants in ScaleImageEnum

    • getOwnScaleImage

      public ScaleImageEnum getOwnScaleImage()
      Description copied from interface: JRCommonImage
      Gets the image own scale type.
      Specified by:
      getOwnScaleImage in interface JRCommonImage
      Returns:
      a value representing one of the scale type constants in ScaleImageEnum

    • setScaleImage

      public void setScaleImage(ScaleImageEnum scaleImage)
      Description copied from interface: JRCommonImage
      Sets the image scale type.
      Specified by:
      setScaleImage in interface JRCommonImage
      Parameters:
      scaleImage - 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

    • getEvaluationTime

      public EvaluationTimeEnum getEvaluationTime()
      Description copied from interface: JREvaluation
      Gets the evaluation time for this text field.
      Specified by:
      getEvaluationTime in interface JREvaluation
      Returns:
      one of the evaluation time constants in JRExpression

    • getLineBox

      public JRLineBox getLineBox()
      Specified by:
      getLineBox in interface JRBoxContainer

    • getHyperlinkType

      public HyperlinkTypeEnum getHyperlinkType()
      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:
      getHyperlinkType in interface JRHyperlink
      Returns:
      one of the hyperlink type constants
      See Also:

    • getHyperlinkTarget

      public HyperlinkTargetEnum 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:

    • getEvaluationGroup

      public String 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:

    • 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)
      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

    • getOnErrorType

      public OnErrorTypeEnum getOnErrorType()
      Description copied from interface: JRImage
      Indicates how the engine will treat a missing image.
      Specified by:
      getOnErrorType in interface JRImage
      Returns:
      a value representing one of the missing image handling constants in OnErrorTypeEnum

    • setOnErrorType

      public void setOnErrorType(OnErrorTypeEnum onErrorType)
      Description copied from interface: JRImage
      Specifies how the engine should treat a missing image.
      Specified by:
      setOnErrorType in interface JRImage
      Parameters:
      onErrorType - a value representing one of the missing image handling constants in OnErrorTypeEnum

    • setEvaluationTime

      public void setEvaluationTime(EvaluationTimeEnum evaluationTime)
      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:

    • setHyperlinkTarget

      public void setHyperlinkTarget(HyperlinkTargetEnum hyperlinkTarget)

    • setEvaluationGroup

      public void setEvaluationGroup(String 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:

    • clone

      public Object clone()
      Specified by:
      clone in interface JRCloneable
      Overrides:
      clone in class JRDesignGraphicElement