Package de.espirit.firstspirit.access.editor.value

Interface MappingMedium

All Superinterfaces:

BinaryMedium

public interface MappingMedium
extends BinaryMedium

Value container for an image map.

Since:

4.0

See Also:

• ImageMapEditorValue

Nested Class Summary

Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.editor.value.BinaryMedium

BinaryMedium.Type

Field Summary

Fields inherited from interface de.espirit.firstspirit.access.editor.value.BinaryMedium

MEDIA_FOLDER_REF_PREFIX, MEDIA_REF_PREFIX

Method Summary

Modifier and Type	Method	Description
@NotNull List<Area>	getAreas()	Provides the areas defined for mapping to links.
int	getHeight()	Provides the height of the medium.
Media	getImage()	Provides the medium the map bases upon.
Resolution	getResolution()	Provides the medium's resolution.
int	getWidth()	Provides the width of the medium.
void	setAreas(List<? extends Area> areas)	Allows to define the areas mapping to links.
void	setResolution(Resolution resolution)	Define the resolution to be used for the medium

Methods inherited from interface de.espirit.firstspirit.access.editor.value.BinaryMedium

getAltText, getComment, getElement, getElementName, getFile, getFolder, getLanguage, getMedium, getPicture, getRemoteName, getType, isEmpty, setAltText, setComment, setElementName, setFolder, setMedium, setRemoteName

Method Details

getResolution

@ApiDoc(comment="Provides the medium\'s resolution.",
        since="4.0")
Resolution getResolution()

Provides the medium's resolution.

Returns:

The resolution.

Since:

4.0

setResolution

@ApiDoc(comment="Define the resolution to be used for the medium",
        since="4.0")
void setResolution(Resolution resolution)

Define the resolution to be used for the medium

Parameters:

resolution - The resolution.

Since:

4.0

getAreas

@ApiDoc(comment="Provides the areas defined for mapping to links.",
        since="4.0")
@NotNull
@NotNull List<Area> getAreas()

Provides the areas defined for mapping to links.

Returns:

A list of areas.

Since:

4.0

setAreas

@ApiDoc(comment="Allows to define the areas mapping to links.",
        since="4.0")
void setAreas(List<? extends Area> areas)

Allows to define the areas mapping to links.

Parameters:

areas - The areas to be used.

Since:

4.0

getWidth

@ApiDoc(comment="Provides the width of the medium.",
        since="4.0")
int getWidth()

Provides the width of the medium.

Returns:

The width.

Since:

4.0

getHeight

@ApiDoc(comment="Provides the height of the medium.",
        since="4.0")
int getHeight()

Provides the height of the medium.

Returns:

The height.

Since:

4.0

getImage

@ApiDoc(comment="Provides the medium the map bases upon.",
        since="4.0")
Media getImage()

Provides the medium the map bases upon.

Returns:

The medium.

Since:

4.0