Package org.opencms.gwt.client
Class CmsEditableData
java.lang.Object
org.opencms.gwt.client.CmsEditableData
- All Implemented Interfaces:
I_CmsEditableData
Bean holding data needed to open the xml content editor.
- Since:
- 8.0.1
-
Constructor Summary
ConstructorDescriptionDefault constructor.CmsEditableData
(I_CmsEditableData source) Copy constructor. -
Method Summary
Modifier and TypeMethodDescriptionGets the collector context id.Returns the edit id.Gets the element id.Returns the element language.Returns the element name.org.opencms.gwt.shared.I_CmsEditableDataExtensions
Gets the extended attributes.Returns the main language to copy in case the element language node does not exist yet.Returns the new link url.Returns the new link url.Returns the no edit reason.Gets the (fully qualified) name of the post-create handler class to use.Returns the site path.org.opencms.util.CmsUUID
Returns the structure id.boolean
Returns whether an edit handler is available for the resource type.boolean
Returns true if there is an actual resource behind the editable element.boolean
Returns if the given resource is unreleased or expired.void
setContextId
(String id) Sets the collector context id.void
Sets the edit id.void
setElementLanguage
(String elementLanguage) Sets the element language.void
setElementName
(String elementName) Sets the element name.void
setHasEditHandler
(boolean hasEditHandler) Sets the hasEditHandler.void
setHasResource
(boolean hasResource) Sets the 'has resource' property.void
setMainLanguage
(String mainLanguage) Sets the main language to copy in case the element language node does not exist yet.void
setNewLink
(String newLink) Sets the new link.void
setNewTitle
(String newTitle) Sets the new title.void
setNoEditReason
(String noEditReason) Sets the no edit reason.void
setSitePath
(String sitePath) Sets the site path.void
setStructureId
(org.opencms.util.CmsUUID structureId) Sets the structure id.void
setUnreleaseOrExpired
(boolean unreleaseOrExpired) Sets the unreleased or expired flag.
-
Constructor Details
-
CmsEditableData
public CmsEditableData()Default constructor. -
CmsEditableData
Copy constructor.- Parameters:
source
- the source to copy
-
-
Method Details
-
getContextId
Description copied from interface:I_CmsEditableData
Gets the collector context id.- Specified by:
getContextId
in interfaceI_CmsEditableData
- Returns:
- the collector context id
- See Also:
-
getEditId
Description copied from interface:I_CmsEditableData
Returns the edit id.- Specified by:
getEditId
in interfaceI_CmsEditableData
- Returns:
- the edit id
- See Also:
-
getElementId
Description copied from interface:I_CmsEditableData
Gets the element id.- Specified by:
getElementId
in interfaceI_CmsEditableData
- Returns:
- the element id
- See Also:
-
getElementLanguage
Description copied from interface:I_CmsEditableData
Returns the element language.- Specified by:
getElementLanguage
in interfaceI_CmsEditableData
- Returns:
- the element language
- See Also:
-
getElementName
Description copied from interface:I_CmsEditableData
Returns the element name.- Specified by:
getElementName
in interfaceI_CmsEditableData
- Returns:
- the element name
- See Also:
-
getExtensions
Description copied from interface:I_CmsEditableData
Gets the extended attributes.- Specified by:
getExtensions
in interfaceI_CmsEditableData
- Returns:
- the extended attributes
- See Also:
-
getMainLanguage
Returns the main language to copy in case the element language node does not exist yet.- Returns:
- the main language to copy in case the element language node does not exist yet
-
getNewLink
Description copied from interface:I_CmsEditableData
Returns the new link url.- Specified by:
getNewLink
in interfaceI_CmsEditableData
- Returns:
- the new link url
- See Also:
-
getNewTitle
Description copied from interface:I_CmsEditableData
Returns the new link url.- Specified by:
getNewTitle
in interfaceI_CmsEditableData
- Returns:
- the new link url
- See Also:
-
getNoEditReason
Description copied from interface:I_CmsEditableData
Returns the no edit reason.- Specified by:
getNoEditReason
in interfaceI_CmsEditableData
- Returns:
- the no edit reason
- See Also:
-
getPostCreateHandler
Description copied from interface:I_CmsEditableData
Gets the (fully qualified) name of the post-create handler class to use.- Specified by:
getPostCreateHandler
in interfaceI_CmsEditableData
- Returns:
- the post-create handler class name
- See Also:
-
getSitePath
Description copied from interface:I_CmsEditableData
Returns the site path.- Specified by:
getSitePath
in interfaceI_CmsEditableData
- Returns:
- the site path
- See Also:
-
getStructureId
Description copied from interface:I_CmsEditableData
Returns the structure id.- Specified by:
getStructureId
in interfaceI_CmsEditableData
- Returns:
- the structure id
- See Also:
-
hasEditHandler
Description copied from interface:I_CmsEditableData
Returns whether an edit handler is available for the resource type.- Specified by:
hasEditHandler
in interfaceI_CmsEditableData
- Returns:
true
if an edit handler is available for the resource type- See Also:
-
hasResource
Description copied from interface:I_CmsEditableData
Returns true if there is an actual resource behind the editable element.- Specified by:
hasResource
in interfaceI_CmsEditableData
- Returns:
- true if the editable element represents an actual resource
- See Also:
-
isUnreleasedOrExpired
Description copied from interface:I_CmsEditableData
Returns if the given resource is unreleased or expired.- Specified by:
isUnreleasedOrExpired
in interfaceI_CmsEditableData
- Returns:
true
if the given resource is unreleased or expired- See Also:
-
setContextId
Sets the collector context id.- Parameters:
id
- the collector context id
-
setEditId
Sets the edit id.- Parameters:
editId
- the edit id to set
-
setElementLanguage
Sets the element language.- Parameters:
elementLanguage
- the element language to set
-
setElementName
Sets the element name.- Parameters:
elementName
- the element name to set
-
setHasEditHandler
Sets the hasEditHandler.- Parameters:
hasEditHandler
- the hasEditHandler to set
-
setHasResource
Sets the 'has resource' property.- Parameters:
hasResource
- the value for the 'has resource' property
-
setMainLanguage
Sets the main language to copy in case the element language node does not exist yet.- Parameters:
mainLanguage
- the main language to copy in case the element language node does not exist yet
-
setNewLink
Sets the new link.- Parameters:
newLink
- the new link to set
-
setNewTitle
Sets the new title.- Parameters:
newTitle
- the new title to set
-
setNoEditReason
Sets the no edit reason.- Parameters:
noEditReason
- the no edit reason to set
-
setSitePath
Description copied from interface:I_CmsEditableData
Sets the site path.- Specified by:
setSitePath
in interfaceI_CmsEditableData
- Parameters:
sitePath
- the site path- See Also:
-
setStructureId
Sets the structure id.- Parameters:
structureId
- the structure id to set
-
setUnreleaseOrExpired
Sets the unreleased or expired flag.- Parameters:
unreleaseOrExpired
- the unreleased or expired flag
-