org.opencms.gwt.client.CmsEditableDataJSO Maven / Gradle / Ivy
Show all versions of opencms-gwt Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.gwt.client;
import org.opencms.ade.contenteditor.shared.CmsEditorConstants;
import org.opencms.gwt.client.util.CmsEditableDataUtil;
import org.opencms.gwt.shared.CmsGwtConstants;
import org.opencms.gwt.shared.I_CmsEditableDataExtensions;
import org.opencms.util.CmsUUID;
import com.google.gwt.core.client.JavaScriptObject;
/**
* Javascript overlay object holding data needed to edit a content collector list element.
*
* @since 8.0.0
*/
public final class CmsEditableDataJSO extends JavaScriptObject implements I_CmsEditableData {
/**
* Constructor.
*/
protected CmsEditableDataJSO() {
// nothing to do
}
/**
* Parses the given JSON text and returns the editable data object.
*
* @param jsonText the JSON text to parse
*
* @return the data object
*/
public static native CmsEditableDataJSO parseEditableData(String jsonText) /*-{
return JSON.parse(jsonText);
}-*/;
/**
* Returns true if the element can be favorited.
*
* @return true if the element can be favorited
*/
public boolean canFavorite() {
return getBoolean(CmsGwtConstants.ATTR_FAVORITE);
}
/**
* @see org.opencms.gwt.client.I_CmsEditableData#getContextId()
*/
public String getContextId() {
return getString(CmsEditorConstants.ATTR_CONTEXT_ID);
}
/**
* @see org.opencms.gwt.client.I_CmsEditableData#getEditId()
*/
public native String getEditId() /*-{
return this.editId ? this.editId : "";
}-*/;
/**
* @see org.opencms.gwt.client.I_CmsEditableData#getElementId()
*/
public String getElementId() {
return getString(CmsGwtConstants.ATTR_ELEMENT_ID);
}
/**
* @see org.opencms.gwt.client.I_CmsEditableData#getElementLanguage()
*/
public native String getElementLanguage() /*-{
return this.elementlanguage ? this.elementlanguage : "";
}-*/;
/**
* @see org.opencms.gwt.client.I_CmsEditableData#getElementName()
*/
public native String getElementName() /*-{
return this.elementname ? this.elementname : "";
}-*/;
/**
* Gets the element view.
*
* @return the element view
*/
public CmsUUID getElementView() {
String elementViewString = getString(CmsEditorConstants.ATTR_ELEMENT_VIEW);
if (elementViewString == null) {
return null;
}
return new CmsUUID(elementViewString);
}
/**
* @see org.opencms.gwt.client.I_CmsEditableData#getExtensions()
*/
public I_CmsEditableDataExtensions getExtensions() {
if (getStoredExtensions() == null) {
String extensionsJson = getString(CmsGwtConstants.ATTR_EXTENSIONS);
if (extensionsJson == null) {
extensionsJson = "{}";
}
I_CmsEditableDataExtensions extensions = CmsEditableDataUtil.parseExtensions(extensionsJson);
setStoredExtensions(extensions);
}
return getStoredExtensions();
}
/**
* @see org.opencms.gwt.client.I_CmsEditableData#getNewLink()
*/
public native String getNewLink() /*-{
return this.newlink ? this.newlink : "";
}-*/;
/**
* @see org.opencms.gwt.client.I_CmsEditableData#getNewTitle()
*/
public native String getNewTitle() /*-{
return this.newtitle ? this.newtitle : "";
}-*/;
/**
* @see org.opencms.gwt.client.I_CmsEditableData#getNoEditReason()
*/
public native String getNoEditReason() /*-{
if (this.noEditReason)
return this.noEditReason;
else
return null;
}-*/;
/**
* @see org.opencms.gwt.client.I_CmsEditableData#getPostCreateHandler()
*/
public String getPostCreateHandler() {
return getString(CmsEditorConstants.PARAM_POST_CREATE_HANDLER);
}
/**
* @see org.opencms.gwt.client.I_CmsEditableData#getSitePath()
*/
public native String getSitePath() /*-{
return this.sitePath ? this.sitePath : "";
}-*/;
/**
* @see org.opencms.gwt.client.I_CmsEditableData#getStructureId()
*/
public CmsUUID getStructureId() {
return new CmsUUID(nativeGetStructureId());
}
/**
* Returns if the delete button should be present.
*
* @return true if the delete button should be present
*/
public native boolean hasDelete() /*-{
return this.hasDelete;
}-*/;
/**
* Returns if the edit button should be present.
*
* @return true if the edit button should be present
*/
public native boolean hasEdit() /*-{
return this.hasEdit;
}-*/;
/**
* @see org.opencms.gwt.client.I_CmsEditableData#hasEditHandler()
*/
public native boolean hasEditHandler() /*-{
return this.hasEditHandler;
}-*/;
/**
* Returns if the new button should be present.
*
* @return true if the new button should be present
*/
public native boolean hasNew() /*-{
return this.hasNew;
}-*/;
/**
* @see org.opencms.gwt.client.I_CmsEditableData#hasResource()
*/
public native boolean hasResource() /*-{
return this.hasResource;
}-*/;
/**
* @see org.opencms.gwt.client.I_CmsEditableData#isUnreleasedOrExpired()
*/
public native boolean isUnreleasedOrExpired() /*-{
return this.unreleaseOrExpired;
}-*/;
/**
* @see org.opencms.gwt.client.I_CmsEditableData#setSitePath(java.lang.String)
*/
public native void setSitePath(String sitePath) /*-{
this.sitePath = sitePath;
}-*/;
/**
* Reads an attribute of the underlying Javascript object as a string.
*
* @param attribute the name of the attribute
*
* @return the string contained in the given attribute
*/
private native boolean getBoolean(String attribute) /*-{
return this[attribute];
}-*/;
/**
* Gets the cached extensions.
*
* @return the cached extensions
*/
private native I_CmsEditableDataExtensions getStoredExtensions() /*-{
return this._ext;
}-*/;
/**
* Reads an attribute of the underlying Javascript object as a string.
*
* @param attribute the name of the attribute
*
* @return the string contained in the given attribute
*/
private native String getString(String attribute) /*-{
return this[attribute];
}-*/;
/**
* Returns the structure id as string.
*
* @return the structure id as string
*/
private native String nativeGetStructureId() /*-{
return this.structureId ? this.structureId : "";
}-*/;
/**
* Sets the cached extensions.
*
* @param extensions the cached extensions
*/
private native void setStoredExtensions(I_CmsEditableDataExtensions extensions) /*-{
this._ext = extensions;
}-*/;
}