Package com.storedobject.ui

Class ImageMap.Area

java.lang.Object

com.storedobject.ui.ImageMap.Area

Enclosing class:

ImageMap

public static class ImageMap.Area
extends Object

A clickable rectangular area in an image map. Instances are created using ImageMap.addArea(int, int, int, int).

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.shared.Registration	addClickListener(com.vaadin.flow.component.ComponentEventListener<ImageMap.AreaClickEvent> listener)	Adds a click listener that is invoked whenever this area is clicked.
ImageMap.Area	setBackground(String background)	Sets the CSS background definition to use for this area when it is not hovered.
ImageMap.Area	setBorder(String border)	Sets the CSS border definition to use for this area when it is not hovered.
ImageMap.Area	setHeight(int height)	Sets the height of this area.
ImageMap.Area	setHoverBackground(String hoverBackground)	Sets the CSS background definition to use for this area when it is hovered.
ImageMap.Area	setHoverBorder(String hoverBorder)	Sets the CSS border definition to use for this area when it is hovered.
ImageMap.Area	setLeft(int left)	Sets the position of the left edge of this area, relative to the left edge of the image map.
ImageMap.Area	setTitle(String title)	Sets the title of this area.
ImageMap.Area	setTop(int top)	Sets the position of the top edge of this area, relative to the top edge of the image map.
ImageMap.Area	setWidth(int width)	Sets the width of this area.

Methods inherited from class java.lang.Object

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

Method Details

setLeft

public ImageMap.Area setLeft(int left)

Sets the position of the left edge of this area, relative to the left edge of the image map.

Parameters:

left - The left edge position, in pixels

Returns:

this area, for chaining

setTop

public ImageMap.Area setTop(int top)

Sets the position of the top edge of this area, relative to the top edge of the image map.

Parameters:

top - The top edge position, in pixels

Returns:

this area, for chaining

setWidth

public ImageMap.Area setWidth(int width)

Sets the width of this area.

Parameters:

width - The area width, in pixels

Returns:

this area, for chaining

setHeight

public ImageMap.Area setHeight(int height)

Sets the height of this area.

Parameters:

height - The area height, in pixels

Returns:

this area, for chaining

addClickListener

public com.vaadin.flow.shared.Registration addClickListener(com.vaadin.flow.component.ComponentEventListener<ImageMap.AreaClickEvent> listener)

Adds a click listener that is invoked whenever this area is clicked.

Parameters:

listener - The listener to add, not null

Returns:

a registration for removing the listener

setTitle

public ImageMap.Area setTitle(String title)

Sets the title of this area. The title is typically shown as a tooltip.

Parameters:

title - The title to set, or "" to remove any previously set title. Not null.

Returns:

this area, for chaining

setBackground

public ImageMap.Area setBackground(String background)

Sets the CSS background definition to use for this area when it is not hovered. If no value is set, then the value set using ImageMap.setAreaBackground(String) is used as the default.

Parameters:

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

Returns:

this area, for chaining

setHoverBackground

public ImageMap.Area setHoverBackground(String hoverBackground)

Sets the CSS background definition to use for this area when it is hovered. If no value is set, then the value set using setBackground(String) is used as the default.

Parameters:

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

Returns:

this area, for chaining

setBorder

public ImageMap.Area setBorder(String border)

Sets the CSS border definition to use for this area when it is not hovered. If no value is set, then the value set using ImageMap.setAreaBorder(String) is used as the default.

Parameters:

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

Returns:

this area, for chaining

setHoverBorder

public ImageMap.Area setHoverBorder(String hoverBorder)

Sets the CSS border definition to use for this area when it is hovered. If no value is set, then the value set using ImageMap.setHoverBorder(String) is used as the default.

Parameters:

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

Returns:

this area, for chaining