org.opencms.gwt.shared.property
Class CmsPropertiesBean

java.lang.Object
  org.opencms.gwt.shared.property.CmsPropertiesBean

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable

public class CmsPropertiesBean
extends java.lang.Object
implements com.google.gwt.user.client.rpc.IsSerializable

A bean containing the information needed to edit the properties of a resource.

Since:

8.0.0

Constructor Summary

CmsPropertiesBean()
Creates a new instance.

Method Summary

java.util.List<java.lang.String>	getAllProperties() Returns a list of all property names.
java.util.Map<java.lang.String,CmsClientProperty>	getInheritedProperties() Returns a map of the inherited properties.
java.util.Map<java.lang.String,CmsClientProperty>	getOwnProperties() Gets a map of the resource's own properties.
CmsListInfoBean	getPageInfo() Gets the list info bean for the resource.
java.util.Map<java.lang.String,CmsXmlContentProperty>	getPropertyDefinitions() Gets a map of the configured properties.
java.lang.String	getSitePath() Gets the site path of the resource.
CmsUUID	getStructureId() Gets the structure id of the resource.
java.util.Map<java.lang.String,CmsClientTemplateBean>	getTemplates() Gets a map of the available templates.
boolean	isContainerPage() Returns the if the resource is a container page.
boolean	isFolder() Returns the if the resource is a folder.
boolean	isReadOnly() If true, the properties can't be modified.
void	setAllProperties(java.util.List<java.lang.String> allProperties) Sets the list of property names.
void	setContainerPage(boolean isContainerPage) Sets if the resource is a container page.
void	setFolder(boolean isFolder) Sets if the resource is a folder.
void	setInheritedProperties(java.util.Map<java.lang.String,CmsClientProperty> inheritedProperties) Sets the inherited properties.
void	setOwnProperties(java.util.Map<java.lang.String,CmsClientProperty> ownProperties) Sets the resource's own properties.
void	setPageInfo(CmsListInfoBean pageInfo) Sets the page info.
void	setPropertyDefinitions(java.util.Map<java.lang.String,CmsXmlContentProperty> propertyDefinitions) Sets the property configuration.
void	setReadOnly(boolean isReadOnly) Sets "readonly mode".
void	setSitePath(java.lang.String sitePath) Sets the site path.
void	setStructureId(CmsUUID structureId) Sets the structure id.
void	setTemplates(java.util.Map<java.lang.String,CmsClientTemplateBean> templates) Sets the available templates.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CmsPropertiesBean

public CmsPropertiesBean()

Creates a new instance.

Method Detail

getAllProperties

public java.util.List<java.lang.String> getAllProperties()

Returns a list of all property names.

Returns:

a list of all property names

getInheritedProperties

public java.util.Map<java.lang.String,CmsClientProperty> getInheritedProperties()

Returns a map of the inherited properties.

Returns:

a map of inherited properties

getOwnProperties

public java.util.Map<java.lang.String,CmsClientProperty> getOwnProperties()

Gets a map of the resource's own properties.

Returns:

the resource's own properties

getPageInfo

public CmsListInfoBean getPageInfo()

Gets the list info bean for the resource.

Returns:

a list info bean

getPropertyDefinitions

public java.util.Map<java.lang.String,CmsXmlContentProperty> getPropertyDefinitions()

Gets a map of the configured properties.

Returns:

the configured properties as a map

getSitePath

public java.lang.String getSitePath()

Gets the site path of the resource.

Returns:

the site path of the resource

getStructureId

public CmsUUID getStructureId()

Gets the structure id of the resource.

Returns:

the structure id of the resource

getTemplates

public java.util.Map<java.lang.String,CmsClientTemplateBean> getTemplates()

Gets a map of the available templates.

Returns:

the available templates

isContainerPage

public boolean isContainerPage()

Returns the if the resource is a container page.

Returns:

the if the resource is a container page

isFolder

public boolean isFolder()

Returns the if the resource is a folder.

Returns:

the if the resource is a folder

isReadOnly

public boolean isReadOnly()

If true, the properties can't be modified.

Returns:

true if the properties can't be modified

setAllProperties

public void setAllProperties(java.util.List<java.lang.String> allProperties)

Sets the list of property names.

Parameters:

allProperties - the list of property names

setContainerPage

public void setContainerPage(boolean isContainerPage)

Sets if the resource is a container page.

Parameters:

isContainerPage - true if the resource is a container page

setFolder

public void setFolder(boolean isFolder)

Sets if the resource is a folder.

Parameters:

isFolder - true if the resource is a folder

setInheritedProperties

public void setInheritedProperties(java.util.Map<java.lang.String,CmsClientProperty> inheritedProperties)

Sets the inherited properties.

Parameters:

inheritedProperties - the inherited properties

setOwnProperties

public void setOwnProperties(java.util.Map<java.lang.String,CmsClientProperty> ownProperties)

Sets the resource's own properties.

Parameters:

ownProperties - the resource's own properties

setPageInfo

public void setPageInfo(CmsListInfoBean pageInfo)

Sets the page info.

Parameters:

pageInfo - the page info

setPropertyDefinitions

public void setPropertyDefinitions(java.util.Map<java.lang.String,CmsXmlContentProperty> propertyDefinitions)

Sets the property configuration.

Parameters:

propertyDefinitions - the property configuration

setReadOnly

public void setReadOnly(boolean isReadOnly)

Sets "readonly mode".

Parameters:

isReadOnly - true if "readonly mode" should be enabled

setSitePath

public void setSitePath(java.lang.String sitePath)

Sets the site path.

Parameters:

sitePath -

setStructureId

public void setStructureId(CmsUUID structureId)

Sets the structure id.

Parameters:

structureId - the structure id

setTemplates

public void setTemplates(java.util.Map<java.lang.String,CmsClientTemplateBean> templates)

Sets the available templates.

Parameters:

templates - the available templates