Package org.opencms.gwt.client

Class CmsEditableDataJSO

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

org.opencms.gwt.client.CmsEditableDataJSO

All Implemented Interfaces:

I_CmsEditableData

public final class CmsEditableDataJSO
extends com.google.gwt.core.client.JavaScriptObject
implements I_CmsEditableData

Javascript overlay object holding data needed to edit a content collector list element.

Since:

8.0.0

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CmsEditableDataJSO()	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	canFavorite()	Returns true if the element can be favorited.
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.util.CmsUUID	getElementView()	Gets the element view.
org.opencms.gwt.shared.I_CmsEditableDataExtensions	getExtensions()	Gets the extended attributes.
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	hasDelete()	Returns if the delete button should be present.
boolean	hasEdit()	Returns if the edit button should be present.
boolean	hasEditHandler()	Returns whether an edit handler is available for the resource type.
boolean	hasNew()	Returns if the new button should be present.
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.
static CmsEditableDataJSO	parseEditableData(String jsonText)	Parses the given JSON text and returns the editable data object.
void	setSitePath(String sitePath)	Sets the site path.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CmsEditableDataJSO

protected CmsEditableDataJSO()

Constructor.

Method Details

parseEditableData

public static CmsEditableDataJSO parseEditableData(String jsonText)

Parses the given JSON text and returns the editable data object.

Parameters:

jsonText - the JSON text to parse

Returns:

the data object

canFavorite

public boolean canFavorite()

Returns true if the element can be favorited.

Returns:

true if the element can be favorited

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()

getElementView

public org.opencms.util.CmsUUID getElementView()

Gets the element view.

Returns:

the element view

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()

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()

hasDelete

public boolean hasDelete()

Returns if the delete button should be present.

Returns:

true if the delete button should be present

hasEdit

public boolean hasEdit()

Returns if the edit button should be present.

Returns:

true if the edit button should be present

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()

hasNew

public boolean hasNew()

Returns if the new button should be present.

Returns:

true if the new button should be present

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()

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)