nl.gx.webmanager.cms.element
Interface Element

All Superinterfaces:

DelegatedControllerAware, Presentable, Wrapper

All Known Subinterfaces:

AnchorElement, ApplicationElement, CalendarElement, DirectoryElement, DownloadElement, EcardElement, FaqElement, FlashElement, FormElement, ForumElement, ImageElement, ImageMapElement, ListElement, MediaCollectionElement, MediaCollectionOverviewElement, PageCollectionElement, PollElement, ProductElement, QueryElement, RichTextElement, RichTextInlineElement, RisDocumentsElement, RssFeedElement, SearchElement, SeparatorElement, TableElement, TextElement, WhoIsWhoElement

All Known Implementing Classes:

ElementBase, nl.gx.webmanager.cms.element.implementation.JcrElementBase

public interface Element
extends Presentable, DelegatedControllerAware

Elements are put on a page and have a layout, may be personalized. All element interfaces extend this interface.

See Also:

ElementHolder, Presentable

Method Summary

void	cleanup() Deprecated.
Element	copy() Deprecated.
java.lang.String	getEditElementHeader() Get the header text of an element.
ElementHolder	getElementHolder() Return the ElementHolder that contains this Element.
java.lang.String	getHeader() Return the header of the element to display in the title bar of the element
java.lang.String	getIcon() Get the name of the icon on disk.
MediaItemVersion	getMediaItemVersion() Return the media item version this element is on.
PageModel	getPageModel() Return the page model this element is on.
PageModelElement	getPageModelElement() If the element is a page model element returns the page model element representation of the element, else returns null.
PageVersion	getPageVersion() Return the page version this element is on.
Personalization	getPersonalization() Return the personalization object of this element or null if it is not personalized.
Website	getWebsite() Return the web site this element is on.
boolean	isAuthorized() Returns true if the current user has permission to edit the element.
void	setAuthorized(boolean authorized) Sets if the current user has permission to edit the element.
void	setDefaultPresentation() Sets a default presentation for the element.
void	setEditElementHeader(java.lang.String header) Set the header text of an element.
void	setHeader(java.lang.String header) Set the header of the element to display in the title bar of the element
void	setIcon(java.lang.String icon) Sets the name of the icon on disk.
void	setPersonalization(Personalization personalization) Set the personalization object of this element or null if it is not personalized.

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

getPersonalization

Personalization getPersonalization()

Return the personalization object of this element or null if it is not personalized.

Returns:

the personalization object of this element or null.

setPersonalization

void setPersonalization(Personalization personalization)

Set the personalization object of this element or null if it is not personalized.

Parameters:

personalization - the personalization object of this element or null.

getPageVersion

PageVersion getPageVersion()

Return the page version this element is on.

Returns:

the page version this element is on.

getMediaItemVersion

MediaItemVersion getMediaItemVersion()

Return the media item version this element is on. Returns null if the element is not contained by a media item version

Returns:

media item version this element is on

getPageModel

PageModel getPageModel()

Return the page model this element is on. Returns null if the element is not contained by a page model

Returns:

page model this element is on

getPageModelElement

PageModelElement getPageModelElement()

If the element is a page model element returns the page model element representation of the element, else returns null.

Returns:

The page model element representation of the element.

getElementHolder

ElementHolder getElementHolder()

Return the ElementHolder that contains this Element.

Returns:

the ElementHolder that contains this Element.

getWebsite

Website getWebsite()

Return the web site this element is on.

Returns:

the web site this element is on.

getEditElementHeader

java.lang.String getEditElementHeader()

Get the header text of an element.

Returns:

header text

setEditElementHeader

void setEditElementHeader(java.lang.String header)

Set the header text of an element.

Parameters:

header - header text to set

getHeader

java.lang.String getHeader()

Return the header of the element to display in the title bar of the element

Returns:

header of the element

setHeader

void setHeader(java.lang.String header)

Set the header of the element to display in the title bar of the element

Parameters:

header - header of the element to set

getIcon

java.lang.String getIcon()

Get the name of the icon on disk.

Returns:

the name of the icon on disk

setIcon

void setIcon(java.lang.String icon)

Sets the name of the icon on disk.

Parameters:

icon - the name of the icon on disk to set

isAuthorized

boolean isAuthorized()

Returns true if the current user has permission to edit the element.

Returns:

true if the current user has permission to edit the element

setAuthorized

void setAuthorized(boolean authorized)

Sets if the current user has permission to edit the element.

Parameters:

authorized - indicating if the current user has permission to edit the element

cleanup

@Deprecated
void cleanup()

Deprecated.

Lifecycle method which is called just before the element is deleted.

copy

@Deprecated
Element copy()

Deprecated.

Copy this object.

Returns:

the copy.

setDefaultPresentation

void setDefaultPresentation()

Sets a default presentation for the element.