org.opencms.ade.contenteditor.client

类 CmsContentEditor

java.lang.Object

com.alkacon.acacia.client.EditorBase

org.opencms.ade.contenteditor.client.CmsContentEditor

所有已实现的接口:

com.alkacon.acacia.client.I_InlineHtmlUpdateHandler

public final class CmsContentEditor
extends com.alkacon.acacia.client.EditorBase

The content editor.

字段概要

字段

限定符和类型	字段和说明
protected com.google.gwt.user.client.Command	m_onClose The on close call back.
protected CmsToolbar	m_toolbar The edit tool-bar.

从类继承的字段 com.alkacon.acacia.client.EditorBase

GUI_CHOICE_ADD_CHOICE_1, GUI_VIEW_ADD_1, GUI_VIEW_CLOSE_0, GUI_VIEW_DELETE_1, GUI_VIEW_EDIT_1, GUI_VIEW_MOVE_1, GUI_VIEW_MOVE_DOWN_0, GUI_VIEW_MOVE_UP_0, m_entityId, m_vie

方法概要

方法

限定符和类型	方法和说明
static void	addEntityChangeListener(I_CmsEntityChangeListener changeListener, java.lang.String changeScope) Adds an entity change listener.
protected void	clearEditor()
void	closeEditor() Closes the editor.
protected CmsEditorContext	getContext() Gets the editor context.
protected java.lang.String	getContextUri()
protected I_CmsCoreServiceAsync	getCoreService() Returns the core RPC service.
static com.alkacon.vie.client.Entity	getEntity() Returns the currently edited entity.
protected java.lang.String	getEntityId() Gets the entity id.
protected java.lang.String	getHtmlContextInfo()
static CmsContentEditor	getInstance() Returns the in-line editor instance.
I_CmsContentServiceAsync	getService()
static boolean	hasEditable(com.google.gwt.dom.client.Element element) Returns if the given element or it's descendants are inline editable.
static boolean	isEditable(com.google.gwt.dom.client.Element element) Checks whether the given element is annotated for inline editing.
void	loadDefinition(java.lang.String entityId, I_CmsSimpleCallback<CmsContentDefinition> callback) Loads the content definition for the given entity and executes the callback on success.
void	loadDefinition(java.lang.String entityId, java.lang.String newLink, CmsUUID modelFileId, I_CmsSimpleCallback<CmsContentDefinition> callback) Loads the content definition for the given entity and executes the callback on success.
void	loadNewDefinition(java.lang.String entityId, I_CmsSimpleCallback<CmsContentDefinition> callback) Loads the content definition for the given entity and executes the callback on success.
void	openFormEditor(CmsEditorContext context, java.lang.String locale, java.lang.String elementId, java.lang.String newLink, CmsUUID modelFileId, com.google.gwt.user.client.Command onClose) Opens the content editor dialog.
void	openInlineEditor(CmsEditorContext context, CmsUUID elementId, java.lang.String locale, com.alkacon.acacia.client.I_InlineFormParent panel, com.google.gwt.user.client.Command onClose) Renders the in-line editor for the given element.
void	openStandAloneFormEditor(CmsEditorContext context) Opens the form based editor.
void	registerClonedEntity(java.lang.String sourceEntityId, java.lang.String targetEntityId) Registers a deep copy of the source entity with the given target entity id.
void	registerContentDefinition(com.alkacon.acacia.shared.ContentDefinition definition)
static void	replaceResourceIds(com.google.gwt.dom.client.Element element, java.lang.String oldId, java.lang.String newId) Replaces the id's within about attributes of the given element and all it's children.
void	saveAndDeleteEntities(java.util.List<com.alkacon.acacia.shared.Entity> entities, java.util.List<java.lang.String> deletedEntites, boolean clearOnSuccess, com.google.gwt.user.client.Command callback) Saves the given entities.
void	saveAndDeleteEntities(java.util.Set<java.lang.String> entities, java.util.Set<java.lang.String> deletedEntites, boolean clearOnSuccess, com.google.gwt.user.client.Command callback) Saves the given entities.
static boolean	setEditable(com.google.gwt.dom.client.Element element, boolean editable) Sets all annotated child elements editable.
void	setShowEditorHelp(boolean show) Sets the show editor help flag to the user session.
void	unregistereEntity(java.lang.String entityId) Removes the given entity from the entity VIE store.

从类继承的方法 com.alkacon.acacia.client.EditorBase

addEntityChangeHandler, addOverlayClickHandler, addValidationChangeHandler, destroyForm, getCurrentEntity, getMessageForKey, getValidationHandler, getWidgetService, hasDictionary, initEditOverlay, loadContentDefinition, markForInlineFocus, onRpcError, reinitWidgets, removeEditOverlays, renderEntityForm, renderEntityForm, renderInlineEntity, rerenderForm, saveEntities, saveEntities, saveEntity, saveEntity, saveEntity, setDictionary, shouldFocusOnInlineEdit, updateHtml, updateOverlayPosition

从类继承的方法 java.lang.Object

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

字段详细资料

m_onClose

protected com.google.gwt.user.client.Command m_onClose

The on close call back.

m_toolbar

protected CmsToolbar m_toolbar

The edit tool-bar.

方法详细资料

addEntityChangeListener

public static void addEntityChangeListener(I_CmsEntityChangeListener changeListener,
                           java.lang.String changeScope)

Adds an entity change listener.

参数:

changeListener - the change listener

changeScope - the change scope

getEntity

public static com.alkacon.vie.client.Entity getEntity()

Returns the currently edited entity.

返回:

the currently edited entity

getInstance

public static CmsContentEditor getInstance()

Returns the in-line editor instance.

返回:

the in-line editor instance

hasEditable

public static boolean hasEditable(com.google.gwt.dom.client.Element element)

Returns if the given element or it's descendants are inline editable.

参数:

element - the element

返回:

true if the element has editable descendants

isEditable

public static boolean isEditable(com.google.gwt.dom.client.Element element)

Checks whether the given element is annotated for inline editing.

参数:

element - the element to check

返回:

true if the given element is annotated for inline editing

replaceResourceIds

public static void replaceResourceIds(com.google.gwt.dom.client.Element element,
                      java.lang.String oldId,
                      java.lang.String newId)

Replaces the id's within about attributes of the given element and all it's children.

参数:

element - the element

oldId - the old id

newId - the new id

setEditable

public static boolean setEditable(com.google.gwt.dom.client.Element element,
                  boolean editable)

Sets all annotated child elements editable.

参数:

element - the element

editable - true to enable editing

返回:

true if the element had editable elements

closeEditor

public void closeEditor()

Closes the editor.

May be used from outside the editor module.

getService

public I_CmsContentServiceAsync getService()

覆盖:

getService 在类中 com.alkacon.acacia.client.EditorBase

另请参阅:

EditorBase.getService()

loadDefinition

public void loadDefinition(java.lang.String entityId,
                  I_CmsSimpleCallback<CmsContentDefinition> callback)

Loads the content definition for the given entity and executes the callback on success.

参数:

entityId - the entity id

callback - the callback

loadDefinition

public void loadDefinition(java.lang.String entityId,
                  java.lang.String newLink,
                  CmsUUID modelFileId,
                  I_CmsSimpleCallback<CmsContentDefinition> callback)

Loads the content definition for the given entity and executes the callback on success.

参数:

entityId - the entity id

newLink - the new link

modelFileId - the model file id

callback - the callback

loadNewDefinition

public void loadNewDefinition(java.lang.String entityId,
                     I_CmsSimpleCallback<CmsContentDefinition> callback)

Loads the content definition for the given entity and executes the callback on success.

参数:

entityId - the entity id

callback - the callback

openFormEditor

public void openFormEditor(CmsEditorContext context,
                  java.lang.String locale,
                  java.lang.String elementId,
                  java.lang.String newLink,
                  CmsUUID modelFileId,
                  com.google.gwt.user.client.Command onClose)

Opens the content editor dialog.

参数:

context - the editor context

locale - the content locale

elementId - the element id

newLink - the new link

modelFileId - the model file id

onClose - the command executed on dialog close

openInlineEditor

public void openInlineEditor(CmsEditorContext context,
                    CmsUUID elementId,
                    java.lang.String locale,
                    com.alkacon.acacia.client.I_InlineFormParent panel,
                    com.google.gwt.user.client.Command onClose)

Renders the in-line editor for the given element.

参数:

context - the editor context

elementId - the element id

locale - the content locale

panel - the element panel

onClose - the command to execute on close

openStandAloneFormEditor

public void openStandAloneFormEditor(CmsEditorContext context)

Opens the form based editor. Used within the stand alone contenteditor.jsp.

参数:

context - the editor context

registerClonedEntity

public void registerClonedEntity(java.lang.String sourceEntityId,
                        java.lang.String targetEntityId)

Registers a deep copy of the source entity with the given target entity id.

参数:

sourceEntityId - the source entity id

targetEntityId - the target entity id

registerContentDefinition

public void registerContentDefinition(com.alkacon.acacia.shared.ContentDefinition definition)

覆盖:

registerContentDefinition 在类中 com.alkacon.acacia.client.EditorBase

另请参阅:

EditorBase.registerContentDefinition(com.alkacon.acacia.shared.ContentDefinition)

saveAndDeleteEntities

public void saveAndDeleteEntities(java.util.List<com.alkacon.acacia.shared.Entity> entities,
                         java.util.List<java.lang.String> deletedEntites,
                         boolean clearOnSuccess,
                         com.google.gwt.user.client.Command callback)

Saves the given entities.

参数:

entities - the entities to save

deletedEntites - the deleted entity id's

clearOnSuccess - true to clear the VIE instance on success

callback - the call back command

saveAndDeleteEntities

public void saveAndDeleteEntities(java.util.Set<java.lang.String> entities,
                         java.util.Set<java.lang.String> deletedEntites,
                         boolean clearOnSuccess,
                         com.google.gwt.user.client.Command callback)

Saves the given entities.

参数:

entities - the entities to save

deletedEntites - the deleted entity id's

clearOnSuccess - true to clear the VIE instance on success

callback - the call back command

setShowEditorHelp

public void setShowEditorHelp(boolean show)

Sets the show editor help flag to the user session.

参数:

show - the show editor help flag

unregistereEntity

public void unregistereEntity(java.lang.String entityId)

Removes the given entity from the entity VIE store.

参数:

entityId - the entity id

clearEditor

protected void clearEditor()

覆盖:

clearEditor 在类中 com.alkacon.acacia.client.EditorBase

另请参阅:

EditorBase.clearEditor()

getContext

protected CmsEditorContext getContext()

Gets the editor context.

返回:

the editor context

getContextUri

protected java.lang.String getContextUri()

覆盖:

getContextUri 在类中 com.alkacon.acacia.client.EditorBase

另请参阅:

EditorBase.getContextUri()

getCoreService

protected I_CmsCoreServiceAsync getCoreService()

Returns the core RPC service.

返回:

the core service

getEntityId

protected java.lang.String getEntityId()

Gets the entity id.

返回:

the entity id

getHtmlContextInfo

protected java.lang.String getHtmlContextInfo()

覆盖:

getHtmlContextInfo 在类中 com.alkacon.acacia.client.EditorBase

另请参阅:

EditorBase.getHtmlContextInfo()