nl.gx.webmanager.cms.mediarepository
Interface MediaCollectionElement

All Superinterfaces:

DelegatedControllerAware, Element, Presentable, Wrapper

All Known Subinterfaces:

MediaCollectionOverviewElement

public interface MediaCollectionElement
extends Element

List of MediaItems.

Nested Class Summary

static class

MediaCollectionElement.TargetType

Method Summary

void	appendMediaItem(MediaItem mediaItem) Appends a mediaItem at the end of the list.
Page	getAlternativeTargetPage() Target page to be used in case ALTERNATIVE_PAGE
MediaItem[]	getMediaItems() Return array of MediaItem.
int	getNumberOfMediaItems() Returns the number of mediaitemss in this list.
MediaCollectionElement.TargetType	getTargetType() Indicates how the target page needs to determined.
java.lang.String	getTitle() Returns the title of the element.
void	insertMediaItem(int position, MediaItem mediaItem) Inserts a mediaItem at the specified position in the list, or at the first position if this is the first item.
boolean	isShownOnCurrentPage() Deprecated.
void	removeMediaItem(int position) Remove a mediaItem at the specified position in the list.
void	setAlternativeTargetPage(Page page) Set the Target page to be used in case ALTERNATIVE_PAGE.
void	setMediaItems(MediaItem[] mediaItems) Set or replace the mediaitems within this element with the ones provided.
void	setTargetType(MediaCollectionElement.TargetType targetType) Sets how the target page needs to determined.
void	setTitle(java.lang.String title) Sets the title of the element.

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

getMediaItems

MediaItem[] getMediaItems()

Return array of MediaItem.

Returns:

array of MediaItem.

appendMediaItem

void appendMediaItem(MediaItem mediaItem)

Appends a mediaItem at the end of the list.

Parameters:

mediaItem - The mediaItem to be added

insertMediaItem

void insertMediaItem(int position,
                     MediaItem mediaItem)

Inserts a mediaItem at the specified position in the list, or at the first position if this is the first item.

Parameters:

position - The zero bound position at which the MediaItem needs to be added

mediaItem - The mediaItem to be added

setMediaItems

void setMediaItems(MediaItem[] mediaItems)

Set or replace the mediaitems within this element with the ones provided.

Parameters:

mediaItems - The MediaItems Array that need to be set

removeMediaItem

void removeMediaItem(int position)

Remove a mediaItem at the specified position in the list.

Parameters:

position - The zero bound position at which the MediaItem needs to be removed

getNumberOfMediaItems

int getNumberOfMediaItems()

Returns the number of mediaitemss in this list.

Returns:

Mediaitem array

isShownOnCurrentPage

@Deprecated
boolean isShownOnCurrentPage()

Deprecated.

Indicates whether target page of media item is ignored.

Returns:

indication whether target page of media item is ignored

getTargetType

MediaCollectionElement.TargetType getTargetType()

Indicates how the target page needs to determined.

Returns:

indication of the target type to be used

setTargetType

void setTargetType(MediaCollectionElement.TargetType targetType)

Sets how the target page needs to determined. For example: element.setTargetType(MediaCollectionElement.TargetType.ALTERNATIVE_PAGE);

Parameters:

indication - of the target type to be used

getAlternativeTargetPage

Page getAlternativeTargetPage()

Target page to be used in case ALTERNATIVE_PAGE

Returns:

target page to be used in case of ALTERNATIVE_PAGE

setAlternativeTargetPage

void setAlternativeTargetPage(Page page)

Set the Target page to be used in case ALTERNATIVE_PAGE.

Parameters:

target - page to be used in case of ALTERNATIVE_PAGE

getTitle

java.lang.String getTitle()

Returns the title of the element.

Returns:

the title of the element

setTitle

void setTitle(java.lang.String title)

Sets the title of the element.

Parameters:

the - title of the element