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