Package com.vaadin.flow.component.html

Class Image

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.HtmlComponent
com.vaadin.flow.component.HtmlContainer
com.vaadin.flow.component.html.Image
All Implemented Interfaces:
AttachNotifier, ClickNotifier<Image>, DetachNotifier, HasAriaLabel, HasComponents, HasElement, HasEnabled, HasSize, HasStyle, HasText, Serializable
@Tag("img") public class Image extends HtmlContainer implements ClickNotifier<Image>, HasAriaLabel
Component representing a <img> element.
Since:
1.0
Author:
Vaadin Ltd
See Also:

  • Constructor Details

    • Image

      public Image()
      Creates a new empty image.

    • Image

      public Image(String src, String alt)
      Creates an image with the given URL and an alternative text. The alternative text given to constructor is always set even if it is the default empty string which is not retained with setAlt(String).
      Parameters:
      src - the image URL
      alt - the alternate text
      See Also:

    • Image

      @Deprecated(since="24.8", forRemoval=true) public Image(AbstractStreamResource src, String alt)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use Image(DownloadHandler, String) instead
      Creates an image with the given stream resource and an alternative text. The alternative text given to constructor is always set even if it is the default empty string which is not retained with setAlt(String).
      Parameters:
      src - the resource value, not null
      alt - the alternate text
      See Also:

    • Image

      public Image(DownloadHandler downloadHandler, String alt)
      Creates an image with the given download handler callback for providing an image data and an alternative text. The alternative text given to constructor is always set even if it is the default empty string which is not retained with setAlt(String). Sets the Content-Disposition header to inline for pre-defined download handlers, created by factory methods in DownloadHandler, as well as for other AbstractDownloadHandler implementations.
      Parameters:
      downloadHandler - the download handler callback that provides an image data, not null
      alt - the alternate text
      See Also:

    • Image

      public Image(byte[] imageContent, String imageName)
      Creates an image from byte array content with the given image name. This convenience constructor simplifies the creation of images from in-memory byte data by automatically handling the creation of a DownloadHandler with a DownloadResponse. The MIME type is automatically determined from the file extension in the image name using URLConnection.guessContentTypeFromName(String). If the image name does not have a recognizable extension, the content type will be null and the browser will attempt to determine it. The alternative text is set to the provided image name. Sets the Content-Disposition header to inline to ensure the image is displayed in the browser rather than downloaded.
      Parameters:
      imageContent - the image data as a byte array, not null
      imageName - the image name (including file extension for MIME type detection), not null
      See Also:

    • Image

      public Image(byte[] imageContent, String imageName, String mimeType)
      Creates an image from byte array content with the given image name and MIME type. This convenience constructor simplifies the creation of images from in-memory byte data by automatically handling the creation of a DownloadHandler with a DownloadResponse. Use this constructor when you need to explicitly specify the MIME type, either because URLConnection.guessContentTypeFromName(String) does not recognize the file extension or when you want explicit control over the content type. The alternative text is set to the provided image name. Sets the Content-Disposition header to inline to ensure the image is displayed in the browser rather than downloaded.
      Parameters:
      imageContent - the image data as a byte array, not null
      imageName - the image name, not null
      mimeType - the MIME type of the image (e.g., "image/png", "image/webp"), or null to let the browser determine it
      See Also:

  • Method Details

    • getSrc

      public String getSrc()
      Gets the image URL.
      Returns:
      the image URL

    • setSrc

      public void setSrc(String src)
      Sets the image URL.
      Parameters:
      src - the image URL

    • setSrc

      @Deprecated(since="24.8", forRemoval=true) public void setSrc(AbstractStreamResource src)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use setSrc(DownloadHandler) instead
      Sets the image URL with the URL of the given StreamResource.
      Parameters:
      src - the resource value, not null

    • setSrc

      public void setSrc(DownloadHandler downloadHandler)
      Sets the image URL with the URL of the given DownloadHandler callback. Sets the Content-Disposition header to inline for pre-defined download handlers, created by factory methods in DownloadHandler, as well as for other AbstractDownloadHandler implementations.
      Parameters:
      downloadHandler - the download handler resource, not null

    • setAlt

      public void setAlt(String alt)
      Sets the alternate text for the image.
      Parameters:
      alt - the alternate text

    • getAlt

      public Optional<String> getAlt()
      Gets the alternate text for the image.
      Returns:
      an optional alternate text, or an empty optional if no alternate text has been set