nl.gx.webmanager.cms.element
Interface ImageElement

All Superinterfaces:

DelegatedControllerAware, Element, Presentable, Wrapper

All Known Subinterfaces:

ImageMapElement

public interface ImageElement
extends Element

Image element.

Nested Class Summary

static class

ImageElement.Alignment

Method Summary

ImageElement.Alignment	getAlignment() Gets the alignment for the image.
java.lang.String	getAlternativeText() Returns the alt text for the image.
java.lang.String	getCode() Returns the internal link code needed to place an internal link tag around the image.
Image	getImage() Returns the representation of the actual image.
Image	getImageFile() Returns the representation of the actual image.
MediaItem	getMediaItem() Returns the media item representation of the actual image.
java.lang.String	getSubText() Returns the subtext of the image.
void	setAlignment(ImageElement.Alignment alternativeText) Sets the alignment for the image.
void	setAlternativeText(java.lang.String alternativeText) Sets the alt text for the image.
void	setCaption(boolean isCaption) Sets if the alternative text needs to be used as caption.
void	setCode(java.lang.String code) Sets the internal link code needed to place an internal link tag around the image.
void	setImageFile(FileResource image) Sets the representation of the actual image.

Methods inherited from interface nl.gx.webmanager.cms.element.Element

cleanup, copy, getEditElementHeader, getElementHolder, getHeader, getIcon, getMediaItemVersion, getPageModel, getPageModelElement, getPageVersion, getPersonalization, getWebsite, isAuthorized, setAuthorized, setDefaultPresentation, setEditElementHeader, setHeader, setIcon, setPersonalization

Methods inherited from interface nl.gx.webmanager.cms.core.Presentable

getPresentation, render, render, setPresentation

Methods inherited from interface nl.gx.webmanager.wrapper.Wrapper

getId, getUUID, setId, setUUID

Methods inherited from interface nl.gx.webmanager.springmvc.DelegatedControllerAware

getDelegatedController, setDelegatedController

Method Detail

getCode

java.lang.String getCode()

Returns the internal link code needed to place an internal link tag around the image.

Returns:

the internal link code needed to place an internal link tag around the image.

setCode

void setCode(java.lang.String code)

Sets the internal link code needed to place an internal link tag around the image.

Parameters:

code - the internal link code needed to place an internal link tag around the image.

getSubText

java.lang.String getSubText()

Returns the subtext of the image.

Returns:

the subtext of the image.

setCaption

void setCaption(boolean isCaption)

Sets if the alternative text needs to be used as caption.

Parameters:

isCaption -

getImageFile

Image getImageFile()

Returns the representation of the actual image.

Returns:

the representation of the actual image.

getImage

Image getImage()

Returns the representation of the actual image.

Returns:

the representation of the actual image.

setImageFile

void setImageFile(FileResource image)

Sets the representation of the actual image.

Parameters:

image - the representation of the actual image.

getAlternativeText

java.lang.String getAlternativeText()

Returns the alt text for the image.

Returns:

the alt text for the image.

setAlternativeText

void setAlternativeText(java.lang.String alternativeText)

Sets the alt text for the image.

Parameters:

alternativeText - the alt text for the image.

getAlignment

ImageElement.Alignment getAlignment()

Gets the alignment for the image.

Returns:

the alignment for the image.

setAlignment

void setAlignment(ImageElement.Alignment alternativeText)

Sets the alignment for the image.

Parameters:

alternativeText - the alignment for the image.

getMediaItem

MediaItem getMediaItem()

Returns the media item representation of the actual image. Returns null if the assigned image is not selected from the Object Manager.

Returns:

The media item representation of the assigned image, or null if not originating from the Object Manager.