Package org.opencms.gwt.client

Class CmsEditableData

java.lang.Object

org.opencms.gwt.client.CmsEditableData

All Implemented Interfaces:

I_CmsEditableData

public class CmsEditableData
extends 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

Modifier and Type	Method	Description
String	getContextId()	Gets the collector context id.
String	getEditId()	Returns the edit id.
String	getElementId()	Gets the element id.
String	getElementLanguage()	Returns the element language.
String	getElementName()	Returns the element name.
org.opencms.gwt.shared.I_CmsEditableDataExtensions	getExtensions()	Gets the extended attributes.
String	getMainLanguage()	Returns the main language to copy in case the element language node does not exist yet.
String	getNewLink()	Returns the new link url.
String	getNewTitle()	Returns the new link url.
String	getNoEditReason()	Returns the no edit reason.
String	getPostCreateHandler()	Gets the (fully qualified) name of the post-create handler class to use.
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(String id)	Sets the collector context id.
void	setEditId(String editId)	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.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsEditableData

public CmsEditableData()

Default constructor.

CmsEditableData

public CmsEditableData(I_CmsEditableData source)

Copy constructor.

Parameters:

source - the source to copy

Method Details

getContextId

public String getContextId()

Description copied from interface: I_CmsEditableData

Gets the collector context id.

Specified by:

getContextId in interface I_CmsEditableData

Returns:

the collector context id

See Also:

• I_CmsEditableData.getContextId()

getEditId

public String getEditId()

Description copied from interface: I_CmsEditableData

Returns the edit id.

Specified by:

getEditId in interface I_CmsEditableData

Returns:

the edit id

See Also:

• I_CmsEditableData.getEditId()

getElementId

public String getElementId()

Description copied from interface: I_CmsEditableData

Gets the element id.

Specified by:

getElementId in interface I_CmsEditableData

Returns:

the element id

See Also:

• I_CmsEditableData.getElementId()

getElementLanguage

public String getElementLanguage()

Description copied from interface: I_CmsEditableData

Returns the element language.

Specified by:

getElementLanguage in interface I_CmsEditableData

Returns:

the element language

See Also:

• I_CmsEditableData.getElementLanguage()

getElementName

public String getElementName()

Description copied from interface: I_CmsEditableData

Returns the element name.

Specified by:

getElementName in interface I_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 interface I_CmsEditableData

Returns:

the extended attributes

See Also:

• I_CmsEditableData.getExtensions()

getMainLanguage

public 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 String getNewLink()

Description copied from interface: I_CmsEditableData

Returns the new link url.

Specified by:

getNewLink in interface I_CmsEditableData

Returns:

the new link url

See Also:

• I_CmsEditableData.getNewLink()

getNewTitle

public String getNewTitle()

Description copied from interface: I_CmsEditableData

Returns the new link url.

Specified by:

getNewTitle in interface I_CmsEditableData

Returns:

the new link url

See Also:

• I_CmsEditableData.getNewTitle()

getNoEditReason

public String getNoEditReason()

Description copied from interface: I_CmsEditableData

Returns the no edit reason.

Specified by:

getNoEditReason in interface I_CmsEditableData

Returns:

the no edit reason

See Also:

• I_CmsEditableData.getNoEditReason()

getPostCreateHandler

public 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 interface I_CmsEditableData

Returns:

the post-create handler class name

See Also:

• I_CmsEditableData.getPostCreateHandler()

getSitePath

public String getSitePath()

Description copied from interface: I_CmsEditableData

Returns the site path.

Specified by:

getSitePath in interface I_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 interface I_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 interface I_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 interface I_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 interface I_CmsEditableData

Returns:

true if the given resource is unreleased or expired

See Also:

• I_CmsEditableData.isUnreleasedOrExpired()

setContextId

public void setContextId(String id)

Sets the collector context id.

Parameters:

id - the collector context id

setEditId

public void setEditId(String editId)

Sets the edit id.

Parameters:

editId - the edit id to set

setElementLanguage

public void setElementLanguage(String elementLanguage)

Sets the element language.

Parameters:

elementLanguage - the element language to set

setElementName

public void setElementName(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(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(String newLink)

Sets the new link.

Parameters:

newLink - the new link to set

setNewTitle

public void setNewTitle(String newTitle)

Sets the new title.

Parameters:

newTitle - the new title to set

setNoEditReason

public void setNoEditReason(String noEditReason)

Sets the no edit reason.

Parameters:

noEditReason - the no edit reason to set

setSitePath

public void setSitePath(String sitePath)

Description copied from interface: I_CmsEditableData

Sets the site path.

Specified by:

setSitePath in interface I_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