Package com.storedobject.ui

Class ImageMap

java.lang.Object

com.vaadin.flow.component.Component

com.storedobject.ui.ImageMap

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasStyle, Serializable

@Tag("div")
public class ImageMap
extends com.vaadin.flow.component.Component

An image component with clickable rectangular areas.

Author:

Syam (Original version was written by Leif Åstrand of Vaadin)

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImageMap.Area	A clickable rectangular area in an image map.
static class	ImageMap.AreaClickEvent	Event fired when an area is clicked.

Constructor Summary

Constructors

Constructor	Description
ImageMap()	Creates an empty image map.
ImageMap(com.vaadin.flow.server.AbstractStreamResource source)	Creates an empty image map with the given image resource and alt text.
ImageMap(String source)	Creates an empty image map with the given image URL and alt text.

Method Summary

Modifier and Type	Method	Description
ImageMap.Area	addArea(int x, int y, int width, int height)	Adds a clickable rectangle area to this image map.
com.vaadin.flow.shared.Registration	addClickHandler(ClickHandler clickHandler)	Add click handler.
Optional<String>	getAlt()	Gets the alternate text for the image.
void	removeArea(ImageMap.Area area)	Removes an Area that was added earlier.
void	setAlt(String alt)	Sets the alternate text for the image.
void	setAreaBackground(String areaBackground)	Sets the default CSS background definition to use for areas that are not hovered.
void	setAreaBorder(String areaBorder)	Sets the default CSS border definition to use for areas that are not hovered.
void	setHoverBackground(String hoverBackground)	Sets the default CSS background definition to use for hovered areas.
void	setHoverBorder(String hoverBorder)	Sets the default CSS border definition to use for hovered areas.
void	setSource(com.vaadin.flow.server.AbstractStreamResource source)	Sets the image URL with the URL of the given StreamResource.
void	setSource(String source)	Sets the image URL.

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.DetachNotifier

addDetachListener

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

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

Constructor Details

ImageMap

public ImageMap()

Creates an empty image map.

ImageMap

public ImageMap(String source)

Creates an empty image map with the given image URL and alt text.

Parameters:

source - The image URL to use, not null

ImageMap

public ImageMap(com.vaadin.flow.server.AbstractStreamResource source)

Creates an empty image map with the given image resource and alt text.

Parameters:

source - The image resource to use, not null

Method Details

addArea

public ImageMap.Area addArea(int x,
 int y,
 int width,
 int height)

Adds a clickable rectangle area to this image map. The area coordinates are relative to the upper left corner of the image map.

Parameters:

x - The x coordinate of the area, in pixels

y - The y coordinate of the area, in pixels

width - The area width, in pixels

height - The area height, in pixels

Returns:

the created area, not null

removeArea

public void removeArea(ImageMap.Area area)

Removes an Area that was added earlier.

Parameters:

area - Area to be removed

addClickHandler

public com.vaadin.flow.shared.Registration addClickHandler(ClickHandler clickHandler)

Add click handler.

Parameters:

clickHandler - Click handler

Returns:

Registration.

setSource

public void setSource(String source)

Sets the image URL.

Parameters:

source - The image URL.

setSource

public void setSource(com.vaadin.flow.server.AbstractStreamResource source)

Sets the image URL with the URL of the given StreamResource.

Parameters:

source - The resource value, 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

setHoverBackground

public void setHoverBackground(String hoverBackground)

Sets the default CSS background definition to use for hovered areas. The setting can be overridden on a per-area basis using ImageMap.Area.setHoverBackground(String). By default, black with 90% transparency is used (defined as rgba(0,0,0,0.1)).

Parameters:

hoverBackground - The CSS background definition, or null to clear any set value and use the default

setHoverBorder

public void setHoverBorder(String hoverBorder)

Sets the default CSS border definition to use for hovered areas. The setting can be overridden on a per-area basis using ImageMap.Area.setHoverBorder(String). By default, no border is used

Parameters:

hoverBorder - The CSS border definition, or null to clear any set value and use the default

setAreaBackground

public void setAreaBackground(String areaBackground)

Sets the default CSS background definition to use for areas that are not hovered. The setting can be overridden on a per-area basis using ImageMap.Area.setBackground(String). By default, no background is used.

Parameters:

areaBackground - The CSS background definition, or null to clear any set value and use the default

setAreaBorder

public void setAreaBorder(String areaBorder)

Sets the default CSS border definition to use for areas that are not hovered. The setting can be overridden on a per-area basis using ImageMap.Area.setBorder(String). By default, no border is used.

Parameters:

areaBorder - The CSS border definition, or null to clear any set value and use the default