nl.gx.webmanager.cms.element
Interface EcardElement

All Superinterfaces:

DelegatedControllerAware, Element, FormElement, Presentable, Wrapper

public interface EcardElement
extends FormElement

Interface for object EcardElement.

Method Summary

java.lang.String	getAlternativeText() Return the alternative text to show instead of the image.
Ecard[]	getConfiguredECards() Return all ecards that are actually selected for this element.
EcardInstance	getECardInstance() Return the instance of an ecard (ecard that has been send).
EcardLabel[]	getEcardLabels() Return the Ecard labels configured for this ecard element.
Ecard[]	getECards() Return all possible ecards the www user can choose from.
java.lang.String	getTitle() Return the title of the ecard element.
boolean	isSendAsHyperlink() Return if the ecard should be send inline or as a hyperlink to the page on which the ecard is shown.
boolean	isUseLabels() Return true if the ecard element should select ecards by label.
void	setAlternativeText(java.lang.String alternativeText) Set the alternative text to show instead of the image.

Methods inherited from interface nl.gx.webmanager.cms.form.FormElement

getAllSteps, getClientSideValidations, getCurrentStep, getDecentralParameters, getFlowId, getForm, getFormName, getFormStepIdentifier, getSeeEvent

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

getTitle

java.lang.String getTitle()

Return the title of the ecard element.

Returns:

the title of the ecard element.

getECards

Ecard[] getECards()

Return all possible ecards the www user can choose from.

Returns:

all possible ecards the www user can choose from.

getConfiguredECards

Ecard[] getConfiguredECards()

Return all ecards that are actually selected for this element. This excludes ecards that are selected by using labels.

Returns:

all ecards that are selected for this element

getECardInstance

EcardInstance getECardInstance()

Return the instance of an ecard (ecard that has been send).

Returns:

the instance of an ecard (ecard that has been send)

getEcardLabels

EcardLabel[] getEcardLabels()

Return the Ecard labels configured for this ecard element.

Returns:

Ecard labels configured for this ecard

isSendAsHyperlink

boolean isSendAsHyperlink()

Return if the ecard should be send inline or as a hyperlink to the page on which the ecard is shown.

Returns:

true if the ecard should be send as hyperlink, false otherwise

getAlternativeText

java.lang.String getAlternativeText()

Return the alternative text to show instead of the image.

Returns:

the alternative text

setAlternativeText

void setAlternativeText(java.lang.String alternativeText)

Set the alternative text to show instead of the image.

Parameters:

alternativeText - the alternative text

isUseLabels

boolean isUseLabels()

Return true if the ecard element should select ecards by label. If false, specific ecards are selected with the element.

Returns:

true if labels should be used to select the ecards