Package com.aquima.interactions.composer

Interface IImage

All Superinterfaces:
IElement, Serializable
All Known Implementing Classes:
Image
public interface IImage extends IElement
The image model interface represents an image node that needs to be displayed in the document or page.
Since:
7.0
Author:
Jon van Leuven

  • Method Details

    • getImageData

      byte[] getImageData()
      This method returns the image data.
      Returns:
      byte array containing raw image data.

    • getImageDataIdentifier

      String getImageDataIdentifier()
      Returns an identifier based on the image data, two images with the same data will always have the same identifier.

      The identifier can be used to identify dynamic image based on their content rather than based on its name, as multiple dynamic images may share the same name, but have different content.

      Returns:
      the identifier of the image data

    • isDynamic

      boolean isDynamic()
      Indicates whether this image is dynamic.

      If an image is not dynamic, then all images with the same name will have the same image content. If an image is dynamic, then two images with the same name are not guaranteed to have the same image content, as the image content may have been generated based on a dynamic value (e.g. a QR code).

      Returns:
      true if this image is dynamic, false otherwise.

    • getHeight

      IntegerValue getHeight()
      This method returns the height of the image.
      Returns:
      height of the image, null if none specified.

    • getWidth

      IntegerValue getWidth()
      This method returns the width of the image.
      Returns:
      Width of the image, null if none specified.

    • getImageType

      ImageType getImageType()
      This method returns the image's type.
      Returns:
      the image type

    • getImageContentType

      ImageContentType getImageContentType()
      This method returns the image content type.
      Returns:
      the image's content type

    • getQRCodeContent

      String getQRCodeContent()
      THis method returns the QR Code content.
      Returns:
      the image's QR Code content