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:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.ClickNotifier<Image>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasAriaLabel, com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasText, Serializable

@Tag("img")
public class Image
extends com.vaadin.flow.component.HtmlContainer
implements com.vaadin.flow.component.ClickNotifier<Image>, com.vaadin.flow.component.HasAriaLabel

Component representing a <img> element.

Since:

1.0

Author:

Vaadin Ltd

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasText

com.vaadin.flow.component.HasText.WhiteSpace

Constructor Summary

Constructors

Constructor	Description
Image()	Creates a new empty image.
Image(com.vaadin.flow.server.AbstractStreamResource src, String alt)	Deprecated, for removal: This API element is subject to removal in a future version. use Image(DownloadHandler, String) instead
Image(com.vaadin.flow.server.streams.DownloadHandler downloadHandler, String alt)	Creates an image with the given download handler callback for providing an image data and an alternative text.
Image(String src, String alt)	Creates an image with the given URL and an alternative text.

Method Summary

Modifier and Type	Method	Description
Optional<String>	getAlt()	Gets the alternate text for the image.
String	getSrc()	Gets the image URL.
void	setAlt(String alt)	Sets the alternate text for the image.
void	setSrc(com.vaadin.flow.server.AbstractStreamResource src)	Deprecated, for removal: This API element is subject to removal in a future version. use setSrc(DownloadHandler) instead
void	setSrc(com.vaadin.flow.server.streams.DownloadHandler downloadHandler)	Sets the image URL with the URL of the given DownloadHandler callback.
void	setSrc(String src)	Sets the image URL.

Methods inherited from class com.vaadin.flow.component.HtmlComponent

getTitle, setTitle

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.ClickNotifier

addClickListener, addClickShortcut, addDoubleClickListener, addSingleClickListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.HasAriaLabel

getAriaLabel, getAriaLabelledBy, setAriaLabel, setAriaLabelledBy

Methods inherited from interface com.vaadin.flow.component.HasComponents

add, add, add, addComponentAsFirst, addComponentAtIndex, remove, remove, removeAll

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.component.HasSize

getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Methods inherited from interface com.vaadin.flow.component.HasText

getText, getWhiteSpace, setText, setWhiteSpace

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:

• setSrc(String)
• setAlt(String)

Image

@Deprecated(since="24.8",
            forRemoval=true)
public Image(com.vaadin.flow.server.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:

• setSrc(AbstractStreamResource)
• setAlt(String)

Image

public Image(com.vaadin.flow.server.streams.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:

• setSrc(DownloadHandler)
• setAlt(String)

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(com.vaadin.flow.server.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(com.vaadin.flow.server.streams.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