Package org.opencms.jsp.util

Class CmsJspStandardContextBean.CmsContainerElementWrapper

java.lang.Object

org.opencms.xml.containerpage.CmsContainerElementBean

org.opencms.jsp.util.CmsJspStandardContextBean.CmsContainerElementWrapper

All Implemented Interfaces:

Cloneable

Enclosing class:

CmsJspStandardContextBean

public class CmsJspStandardContextBean.CmsContainerElementWrapper
extends CmsContainerElementBean

Container element wrapper to add some API methods.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CmsContainerElementWrapper(Supplier<CmsContainerElementBean> elementProvider)	Constructor.

Method Summary

Modifier and Type	Method	Description
CmsContainerElementBean	clone()
String	editorHash()	Returns the ADE client editor has value.
boolean	equals(Object obj)
CmsUUID	getFormatterId()	Returns the structure id of the formatter of this element.
String	getFormatterKey()	Returns the formatter key, if possible, otherwise the formatter configuration id, or null if nothing at all can be found.
CmsUUID	getId()	Returns the structure id of the resource of this element.
Map<String,String>	getIndividualSettings()	Returns the settings of this element.
CmsInheritanceInfo	getInheritanceInfo()	Returns the inheritance info.
String	getInstanceId()	Returns the element instance id.
CmsJspStandardContextBean.CmsContainerElementWrapper	getParent()	Returns the parent element if present.
CmsResource	getResource()	Returns the resource of this element.
String	getResourceTypeName()	Returns the resource type name of the element resource.
Map<String,CmsJspElementSettingValueWrapper>	getSetting()	Returns a lazy initialized setting map.
Map<String,String>	getSettings()	Returns the element settings including default values for settings not set.
String	getSitePath()	Returns the site path of the resource of this element.
int	hashCode()
void	initResource(CmsObject cms)	Initializes the resource and the site path of this element.
void	initSettings(CmsObject cms, CmsADEConfigData config, I_CmsFormatterBean formatterBean, Locale locale, javax.servlet.ServletRequest request, Map<String,String> settingPresets)	Initializes the element settings.
boolean	isCreateNew()	Returns if a new element should be created replacing the given one on first edit of a container-page.
boolean	isGroupContainer(CmsObject cms)	Tests whether this element refers to a group container.
boolean	isHistoryContent()	Checks if the element is used for displaying a historical content (usually from the history dialog).
boolean	isInheritedContainer(CmsObject cms)	Returns whether this element refers to an inherited container element.
boolean	isInMemoryOnly()	Returns if the represented resource is in memory only and not persisted in the VFS.
boolean	isReleasedAndNotExpired()	Returns if the element resource is released and not expired.
boolean	isTemporaryContent()	Returns if the element resource contains temporary file content.
void	setFormatterId(CmsUUID formatterId)	Sets the formatter id.
void	setHistoryFile(CmsFile file)	Sets a historical file.
void	setInheritanceInfo(CmsInheritanceInfo inheritanceInfo)	Sets the inheritance info for this element.
void	setTemporaryFile(CmsFile elementFile)	Sets the element resource as a temporary file.
String	toString()

Methods inherited from class org.opencms.xml.containerpage.CmsContainerElementBean

addFormatterSetting, cloneWithFormatter, cloneWithSettings, createElementForResourceType, ensureNewInstanceId, getTypeName, isCopyModel, isDoNotCache, isModelGroup, isModelGroupAlwaysReplace, setDoNotCache, updateIndividualSettings

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CmsContainerElementWrapper

protected CmsContainerElementWrapper(Supplier<CmsContainerElementBean> elementProvider)

Constructor.

Parameters:

element - the element to wrap

Method Details

clone

public CmsContainerElementBean clone()

Overrides:

clone in class CmsContainerElementBean

See Also:

• CmsContainerElementBean.clone()

editorHash

public String editorHash()

Description copied from class: CmsContainerElementBean

Returns the ADE client editor has value.

Overrides:

editorHash in class CmsContainerElementBean

Returns:

the ADE client editor has value

See Also:

• CmsContainerElementBean.editorHash()

equals

public boolean equals(Object obj)

Overrides:

equals in class CmsContainerElementBean

See Also:

• CmsContainerElementBean.equals(java.lang.Object)

getFormatterId

public CmsUUID getFormatterId()

Description copied from class: CmsContainerElementBean

Returns the structure id of the formatter of this element.

Overrides:

getFormatterId in class CmsContainerElementBean

Returns:

the structure id of the formatter of this element

See Also:

• CmsContainerElementBean.getFormatterId()

getFormatterKey

public String getFormatterKey()

Returns the formatter key, if possible, otherwise the formatter configuration id, or null if nothing at all can be found.

Returns:

the formatter key

getId

public CmsUUID getId()

Description copied from class: CmsContainerElementBean

Returns the structure id of the resource of this element.

Overrides:

getId in class CmsContainerElementBean

Returns:

the structure id of the resource of this element

See Also:

• CmsContainerElementBean.getId()

getIndividualSettings

public Map<String,String> getIndividualSettings()

Description copied from class: CmsContainerElementBean

Returns the settings of this element.

Overrides:

getIndividualSettings in class CmsContainerElementBean

Returns:

the settings of this element

See Also:

• CmsContainerElementBean.getIndividualSettings()

getInheritanceInfo

public CmsInheritanceInfo getInheritanceInfo()

Description copied from class: CmsContainerElementBean

Returns the inheritance info.

Overrides:

getInheritanceInfo in class CmsContainerElementBean

Returns:

the inheritance info or null if not available

See Also:

• CmsContainerElementBean.getInheritanceInfo()

getInstanceId

public String getInstanceId()

Description copied from class: CmsContainerElementBean

Returns the element instance id.

Overrides:

getInstanceId in class CmsContainerElementBean

Returns:

the element instance id

See Also:

• CmsContainerElementBean.getInstanceId()

getParent

public CmsJspStandardContextBean.CmsContainerElementWrapper getParent()

Returns the parent element if present.

Returns:

the parent element or null if not available

getResource

public CmsResource getResource()

Description copied from class: CmsContainerElementBean

Returns the resource of this element.

It is required to call CmsContainerElementBean.initResource(CmsObject) before this method can be used.

Overrides:

getResource in class CmsContainerElementBean

Returns:

the resource of this element

See Also:

• CmsContainerElementBean.getResource()

getResourceTypeName

public String getResourceTypeName()

Returns the resource type name of the element resource.

Returns:

the resource type name

getSetting

public Map<String,CmsJspElementSettingValueWrapper> getSetting()

Returns a lazy initialized setting map.

The values returned in the map are instances of A_CmsJspValueWrapper.

Returns:

the wrapped settings

getSettings

public Map<String,String> getSettings()

Description copied from class: CmsContainerElementBean

Returns the element settings including default values for settings not set.

Will return null if the element bean has not been initialized with CmsContainerElementBean.initResource(org.opencms.file.CmsObject).

Overrides:

getSettings in class CmsContainerElementBean

Returns:

the element settings

See Also:

• CmsContainerElementBean.getSettings()

getSitePath

public String getSitePath()

Description copied from class: CmsContainerElementBean

Returns the site path of the resource of this element.

It is required to call CmsContainerElementBean.initResource(CmsObject) before this method can be used.

Overrides:

getSitePath in class CmsContainerElementBean

Returns:

the site path of the resource of this element

See Also:

• CmsContainerElementBean.getSitePath()

hashCode

public int hashCode()

Overrides:

hashCode in class CmsContainerElementBean

See Also:

• CmsContainerElementBean.hashCode()

initResource

public void initResource(CmsObject cms)
                  throws CmsException

Description copied from class: CmsContainerElementBean

Initializes the resource and the site path of this element.

Overrides:

initResource in class CmsContainerElementBean

Parameters:

cms - the CMS context

Throws:

CmsException - if something goes wrong reading the element resource

See Also:

• CmsContainerElementBean.initResource(org.opencms.file.CmsObject)

initSettings

public void initSettings(CmsObject cms,
 CmsADEConfigData config,
 I_CmsFormatterBean formatterBean,
 Locale locale,
 javax.servlet.ServletRequest request,
 Map<String,String> settingPresets)

Description copied from class: CmsContainerElementBean

Initializes the element settings.

Overrides:

initSettings in class CmsContainerElementBean

Parameters:

cms - the CMS context

formatterBean - the formatter configuration bean

locale - the content locale

request - the current request, if available

settingPresets - the presets for container element settings

See Also:

• CmsContainerElementBean.initSettings(org.opencms.file.CmsObject, org.opencms.ade.configuration.CmsADEConfigData, org.opencms.xml.containerpage.I_CmsFormatterBean, java.util.Locale, javax.servlet.ServletRequest, java.util.Map)

isCreateNew

public boolean isCreateNew()

Description copied from class: CmsContainerElementBean

Returns if a new element should be created replacing the given one on first edit of a container-page.

Overrides:

isCreateNew in class CmsContainerElementBean

Returns:

true if a new element should be created replacing the given one on first edit of a container-page

See Also:

• CmsContainerElementBean.isCreateNew()

isGroupContainer

public boolean isGroupContainer(CmsObject cms)
                         throws CmsException

Description copied from class: CmsContainerElementBean

Tests whether this element refers to a group container.

Overrides:

isGroupContainer in class CmsContainerElementBean

Parameters:

cms - the CmsObject used for VFS operations

Returns:

true if the container element refers to a group container

Throws:

CmsException - if something goes wrong

See Also:

• CmsContainerElementBean.isGroupContainer(org.opencms.file.CmsObject)

isHistoryContent

public boolean isHistoryContent()

Description copied from class: CmsContainerElementBean

Checks if the element is used for displaying a historical content (usually from the history dialog).

Overrides:

isHistoryContent in class CmsContainerElementBean

Returns:

true if the element is used for displaying a historical content

See Also:

• CmsContainerElementBean.isHistoryContent()

isInheritedContainer

public boolean isInheritedContainer(CmsObject cms)
                             throws CmsException

Description copied from class: CmsContainerElementBean

Returns whether this element refers to an inherited container element.

Overrides:

isInheritedContainer in class CmsContainerElementBean

Parameters:

cms - the CmsObject used for VFS operations

Returns:

true if the container element refers to an inherited container

Throws:

CmsException - if something goes wrong

See Also:

• CmsContainerElementBean.isInheritedContainer(org.opencms.file.CmsObject)

isInMemoryOnly

public boolean isInMemoryOnly()

Description copied from class: CmsContainerElementBean

Returns if the represented resource is in memory only and not persisted in the VFS.

Overrides:

isInMemoryOnly in class CmsContainerElementBean

Returns:

true if the represented resource is in memory only and not persisted in the VFS

See Also:

• CmsContainerElementBean.isInMemoryOnly()

isReleasedAndNotExpired

public boolean isReleasedAndNotExpired()

Description copied from class: CmsContainerElementBean

Returns if the element resource is released and not expired.

Overrides:

isReleasedAndNotExpired in class CmsContainerElementBean

Returns:

true if the element resource is released and not expired

See Also:

• CmsContainerElementBean.isReleasedAndNotExpired()

isTemporaryContent

public boolean isTemporaryContent()

Description copied from class: CmsContainerElementBean

Returns if the element resource contains temporary file content.

Overrides:

isTemporaryContent in class CmsContainerElementBean

Returns:

true if the element resource contains temporary file content

See Also:

• CmsContainerElementBean.isTemporaryContent()

setFormatterId

public void setFormatterId(CmsUUID formatterId)

Description copied from class: CmsContainerElementBean

Sets the formatter id.

Overrides:

setFormatterId in class CmsContainerElementBean

Parameters:

formatterId - the formatter id

See Also:

• CmsContainerElementBean.setFormatterId(org.opencms.util.CmsUUID)

setHistoryFile

public void setHistoryFile(CmsFile file)

Description copied from class: CmsContainerElementBean

Sets a historical file.

Overrides:

setHistoryFile in class CmsContainerElementBean

Parameters:

file - the historical file

See Also:

• CmsContainerElementBean.setHistoryFile(org.opencms.file.CmsFile)

setInheritanceInfo

public void setInheritanceInfo(CmsInheritanceInfo inheritanceInfo)

Description copied from class: CmsContainerElementBean

Sets the inheritance info for this element.

Overrides:

setInheritanceInfo in class CmsContainerElementBean

Parameters:

inheritanceInfo - the inheritance info

See Also:

• CmsContainerElementBean.setInheritanceInfo(org.opencms.ade.containerpage.shared.CmsInheritanceInfo)

setTemporaryFile

public void setTemporaryFile(CmsFile elementFile)

Description copied from class: CmsContainerElementBean

Sets the element resource as a temporary file.

Overrides:

setTemporaryFile in class CmsContainerElementBean

Parameters:

elementFile - the temporary file

See Also:

• CmsContainerElementBean.setTemporaryFile(org.opencms.file.CmsFile)

toString

public String toString()

Overrides:

toString in class CmsContainerElementBean

See Also:

• CmsContainerElementBean.toString()