org.opencms.ade.containerpage.shared
Class CmsContainerElement

java.lang.Object
  org.opencms.ade.containerpage.shared.CmsContainerElement

All Implemented Interfaces:

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

Direct Known Subclasses:

CmsContainerElementData, CmsGroupContainer

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

Bean holding basic container element information.

Since:

8.0.0

Field Summary

static java.lang.String	CLASS_CONTAINER_ELEMENT_END_MARKER HTML class used to identify container elements.
static java.lang.String	CLASS_CONTAINER_ELEMENT_START_MARKER HTML class used to identify container elements.
static java.lang.String	CLASS_ELEMENT_ERROR HTML class used to identify error message for elements where rendering failed to render.
static java.lang.String	CLASS_GROUP_CONTAINER_ELEMENT_MARKER HTML class used to identify group container elements.
static java.lang.String	GROUP_CONTAINER_TYPE_NAME The group container resource type name.
static java.lang.String	INHERIT_CONTAINER_TYPE_NAME The resource type name for inherited container references.

Constructor Summary

CmsContainerElement()
Default constructor.

Method Summary

java.lang.String	getClientId() Returns the client id.
CmsInheritanceInfo	getInheritanceInfo() Returns the inheritance info for this element.
java.lang.String	getNoEditReason() Returns the no edit reason.
java.lang.String	getResourceType() Returns the resource type name for elements.
java.lang.String	getSitePath() Returns the site path.
boolean	hasSettings() Returns if the element may have settings.
boolean	hasViewPermission() Returns if the current user has view permissions for the element resource.
boolean	hasWritePermission() Returns if the user has write permission.
boolean	isGroupContainer() Returns if the given element is of the type group container.
boolean	isInheritContainer() Returns if the given element is of the type inherit container.
boolean	isNew() Returns if the element is new and has not been created in the VFS yet.
boolean	isNewEditorDisabled() Returns true if the new editor is disabled for this element.
boolean	isReleasedAndNotExpired() Returns if the given resource is released and not expired.
void	setClientId(java.lang.String clientId) Sets the client id.
void	setHasSettings(boolean hasSettings) Sets if the element may have settings.
void	setInheritanceInfo(CmsInheritanceInfo inheritanceInfo) Sets the inheritance info for this element.
void	setNew(boolean isNew) Sets the 'new' flag.
void	setNewEditorDisabled(boolean disabled) Disables the new editor for this element.
void	setNoEditReason(java.lang.String noEditReason) Sets the no edit reason.
void	setReleasedAndNotExpired(boolean releasedAndNotExpired) Sets if the given resource is released and not expired.
void	setResourceType(java.lang.String resourceType) Sets the element resource type.
void	setSitePath(java.lang.String sitePath) Sets the site path.
void	setViewPermission(boolean viewPermission) Sets if the current user has view permissions for the element resource.
void	setWritePermission(boolean writePermission) Sets the user write permission.

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_CONTAINER_ELEMENT_END_MARKER

public static final java.lang.String CLASS_CONTAINER_ELEMENT_END_MARKER

HTML class used to identify container elements.

See Also:

Constant Field Values

CLASS_CONTAINER_ELEMENT_START_MARKER

public static final java.lang.String CLASS_CONTAINER_ELEMENT_START_MARKER

HTML class used to identify container elements.

See Also:

Constant Field Values

CLASS_ELEMENT_ERROR

public static final java.lang.String CLASS_ELEMENT_ERROR

HTML class used to identify error message for elements where rendering failed to render.

See Also:

Constant Field Values

CLASS_GROUP_CONTAINER_ELEMENT_MARKER

public static final java.lang.String CLASS_GROUP_CONTAINER_ELEMENT_MARKER

HTML class used to identify group container elements.

See Also:

Constant Field Values

GROUP_CONTAINER_TYPE_NAME

public static final java.lang.String GROUP_CONTAINER_TYPE_NAME

The group container resource type name.

See Also:

Constant Field Values

INHERIT_CONTAINER_TYPE_NAME

public static final java.lang.String INHERIT_CONTAINER_TYPE_NAME

The resource type name for inherited container references.

See Also:

Constant Field Values

Constructor Detail

CmsContainerElement

public CmsContainerElement()

Default constructor.

Method Detail

getClientId

public java.lang.String getClientId()

Returns the client id.

Returns:

the client id

getInheritanceInfo

public CmsInheritanceInfo getInheritanceInfo()

Returns the inheritance info for this element.

Returns:

the inheritance info for this element

getNoEditReason

public java.lang.String getNoEditReason()

Returns the no edit reason. If empty editing is allowed.

Returns:

the no edit reason

getResourceType

public java.lang.String getResourceType()

Returns the resource type name for elements.

Returns:

the resource type name

getSitePath

public java.lang.String getSitePath()

Returns the site path.

Returns:

the site path

hasSettings

public boolean hasSettings()

Returns if the element may have settings.

Returns:

true if the element may have settings

hasViewPermission

public boolean hasViewPermission()

Returns if the current user has view permissions for the element resource.

Returns:

true if the current user has view permissions for the element resource

hasWritePermission

public boolean hasWritePermission()

Returns if the user has write permission.

Returns:

true if the user has write permission

isGroupContainer

public boolean isGroupContainer()

Returns if the given element is of the type group container.

Returns:

true if the given element is of the type group container

isInheritContainer

public boolean isInheritContainer()

Returns if the given element is of the type inherit container.

Returns:

true if the given element is of the type inherit container

isNew

public boolean isNew()

Returns if the element is new and has not been created in the VFS yet.

Returns:

true if the element is not created in the VFS yet

isNewEditorDisabled

public boolean isNewEditorDisabled()

Returns true if the new editor is disabled for this element.

Returns:

true if the new editor is disabled for this element

isReleasedAndNotExpired

public boolean isReleasedAndNotExpired()

Returns if the given resource is released and not expired.

Returns:

true if the given resource is released and not expired

setClientId

public void setClientId(java.lang.String clientId)

Sets the client id.

Parameters:

clientId - the client id to set

setHasSettings

public void setHasSettings(boolean hasSettings)

Sets if the element may have settings.

Parameters:

hasSettings - true if the element may have settings

setInheritanceInfo

public void setInheritanceInfo(CmsInheritanceInfo inheritanceInfo)

Sets the inheritance info for this element.

Parameters:

inheritanceInfo - the inheritance info for this element to set

setNew

public void setNew(boolean isNew)

Sets the 'new' flag.

Parameters:

isNew - true on a new element

setNewEditorDisabled

public void setNewEditorDisabled(boolean disabled)

Disables the new editor for this element.

Parameters:

disabled - if true, the new editor will be disabled for this element

setNoEditReason

public void setNoEditReason(java.lang.String noEditReason)

Sets the no edit reason.

Parameters:

noEditReason - the no edit reason to set

setReleasedAndNotExpired

public void setReleasedAndNotExpired(boolean releasedAndNotExpired)

Sets if the given resource is released and not expired.

Parameters:

releasedAndNotExpired - true if the given resource is released and not expired

setResourceType

public void setResourceType(java.lang.String resourceType)

Sets the element resource type.

Parameters:

resourceType - the element resource type

setSitePath

public void setSitePath(java.lang.String sitePath)

Sets the site path.

Parameters:

sitePath - the site path to set

setViewPermission

public void setViewPermission(boolean viewPermission)

Sets if the current user has view permissions for the element resource.

Parameters:

viewPermission - the view permission to set

setWritePermission

public void setWritePermission(boolean writePermission)

Sets the user write permission.

Parameters:

writePermission - the user write permission to set