nl.gx.webmanager.cms.core
Interface ElementHolder

All Superinterfaces:
Presentable, Wrapper
All Known Subinterfaces:
DatabaseEntity, DatabasePageType, MediaItemArticleVersion, PageModel, PageVersion

public interface ElementHolder
extends Presentable

ElementHolders contain zero or more Elements. For example a GX WebManager Page consists of one or more PageVersion objects. The PageVersion interface extends ElementHolder (i.e. pages are an element holders).

See Also:
Element

Method Summary
 void addRelatedLink(RelatedLink relatedLink)
          Add related link to this ElementHolder
 void createRichTextElements()
          Make sure between every content element is a richText element for wysiwyg editting
 Element[] getElementHolderElements()
          Return the elements contained by this ElementHolder, not including the model elements.
 Element[] getElements()
          Return the elements contained by this ElementHolder.
 java.util.Map<java.lang.String,Element> getElementsFBOMap()
          Return the elements as Hash map.
 java.util.Map<java.lang.String,Element> getFBOMap()
          Return the elements and model elements as Hash map.
 Element getLastElement()
          Returns the last element that is currently assigned to the ElementHolder object, or null if no element is assigned to the ElementHolder.
 PageModelElement[] getModelElements()
          Return the model elements contained by this ElementHolder.
 java.util.Map<java.lang.String,PageModelElement> getModelElementsFBOMap()
          Return the elements as Hash map.
 RelatedLink getRelatedLink(java.lang.String code)
          Return RelatedLink for a particular code.
 RelatedLink[] getRelatedLinks()
          Return related links for this ElementHolder.
 Website getWebsite()
          Return website this ElementHolder is on.
 void insertLastElementAtCursor()
          Move the new ( last ) element to the cursor position
 boolean isAdditionalElementsAllowed()
          Return whether adding of additional elements is allowed
 void setElementHolderElements(Element[] elements)
          Update the elements contained by this ElementHolder, not including the model elements.
 void setModelElements(Element[] elements)
          Update the model elemens contained by this ElementHolder.
 
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
 

Method Detail

getElements

Element[] getElements()
Return the elements contained by this ElementHolder.

Returns:
the elements contained by this ElementHolder.

getElementHolderElements

Element[] getElementHolderElements()
Return the elements contained by this ElementHolder, not including the model elements.

Returns:
the elements contained by this ElementHolder, not including the model elements

setElementHolderElements

void setElementHolderElements(Element[] elements)
Update the elements contained by this ElementHolder, not including the model elements.


setModelElements

void setModelElements(Element[] elements)
Update the model elemens contained by this ElementHolder.


getModelElements

PageModelElement[] getModelElements()
Return the model elements contained by this ElementHolder.

Returns:
the model elements contained by this ElementHolder

isAdditionalElementsAllowed

boolean isAdditionalElementsAllowed()
Return whether adding of additional elements is allowed

Returns:
whether adding of additional elements is allowed

getFBOMap

java.util.Map<java.lang.String,Element> getFBOMap()
Return the elements and model elements as Hash map. This is used for spring binding. For example: binds the element by id. is incorrect since the (amount and order of) elements that are returned by this method may be changed between the get and submit.

Returns:
Hashmap of all elements where they is the element id (as String) and the value the element.

getElementsFBOMap

java.util.Map<java.lang.String,Element> getElementsFBOMap()
Return the elements as Hash map. This is used for spring binding. For example: binds the element by id. is incorrect since the (amount and order of) elements that are returned by this method may be changed between the get and submit.

Returns:
Hashmap of all elements where they is the element id (as String) and the value the element.

getModelElementsFBOMap

java.util.Map<java.lang.String,PageModelElement> getModelElementsFBOMap()
Return the elements as Hash map. This is used for spring binding. For example: binds the element by id. is incorrect since the (amount and order of) elements that are returned by this method may be changed between the get and submit.

Returns:
Hashmap of all elements where they is the element id (as String) and the value the element.

getRelatedLinks

RelatedLink[] getRelatedLinks()
Return related links for this ElementHolder.

Returns:
related links for this ElementHolder.

getRelatedLink

RelatedLink getRelatedLink(java.lang.String code)
Return RelatedLink for a particular code.

Parameters:
code -
Returns:
RelatedLink for code.

addRelatedLink

void addRelatedLink(RelatedLink relatedLink)
Add related link to this ElementHolder

Parameters:
relatedLink - link being added to this ElementHolder
Since:
9.12.0

getWebsite

Website getWebsite()
Return website this ElementHolder is on.

Returns:
website.

createRichTextElements

void createRichTextElements()
Make sure between every content element is a richText element for wysiwyg editting


getLastElement

Element getLastElement()
Returns the last element that is currently assigned to the ElementHolder object, or null if no element is assigned to the ElementHolder.

Returns:
the last element that is currently assigned to the ElementHolder object, or null if no element is assigned to the ElementHolder

insertLastElementAtCursor

void insertLastElementAtCursor()
Move the new ( last ) element to the cursor position



Copyright © 2007-2011 GX Software BV. All Rights Reserved.