CmsXmlContentEditor

java.lang.Object
- org.opencms.workplace.CmsWorkplace
- - org.opencms.workplace.tools.CmsToolDialog
  - - org.opencms.workplace.CmsDialog
    - - org.opencms.workplace.editors.CmsEditorBase
      - org.opencms.workplace.editors.CmsEditor
        
        org.opencms.workplace.editors.CmsXmlContentEditor

所有已实现的接口:

I_CmsWidgetDialog
```
public class CmsXmlContentEditor
extends CmsEditor
implements I_CmsWidgetDialog
```
Creates the editor for XML content definitions.

从以下版本开始:

6.0.0

字段概要

字段
限定符和类型	字段和说明
`static int`	`ACTION_CHECK` Action for checking content before executing the direct edit action.
`static int`	`ACTION_CONFIRMCORRECTION` Action for confirming the XML content structure correction.
`static int`	`ACTION_COPYLOCALE` Value for the action: copy the current locale.
`static int`	`ACTION_CORRECTIONCONFIRMED` Action for correction of the XML content structure confirmed.
`static int`	`ACTION_ELEMENT_ADD` Action for optional element creation.
`static int`	`ACTION_ELEMENT_MOVE_DOWN` Action for element move down operation.
`static int`	`ACTION_ELEMENT_MOVE_UP` Action for element move up operation.
`static int`	`ACTION_ELEMENT_REMOVE` Action for optional element removal.
`static int`	`ACTION_NEW` Action for new file creation.
`static int`	`ACTION_SUBCHOICES` Action that sub choices should be determined.
`static java.lang.String`	`ATTRIBUTE_EDITCONTEXT` Request context attribute for the page from which the editor was opened.
`static java.lang.String`	`EDITOR_ACTION_CHECK` Indicates that the content should be checked before executing the direct edit action.
`static java.lang.String`	`EDITOR_ACTION_CONFIRMCORRECTION` Indicates that the correction of the XML content structure should be confirmed.
`static java.lang.String`	`EDITOR_ACTION_ELEMENT_ADD` Indicates an optional element should be created.
`static java.lang.String`	`EDITOR_ACTION_ELEMENT_MOVE_DOWN` Indicates an element should be moved down.
`static java.lang.String`	`EDITOR_ACTION_ELEMENT_MOVE_UP` Indicates an element should be moved up.
`static java.lang.String`	`EDITOR_ACTION_ELEMENT_REMOVE` Indicates an optional element should be removed.
`static java.lang.String`	`EDITOR_ACTION_NEW` Indicates a new file should be created.
`static java.lang.String`	`EDITOR_ACTION_SUBCHOICES` Indicates that sub choices should be determined.
`static java.lang.String`	`EDITOR_COPYLOCALE` Indicates that the contents of the current locale should be copied to other locales.
`static java.lang.String`	`EDITOR_CORRECTIONCONFIRMED` Indicates that the correction of the XML content structure was confirmed by the user.
`static java.lang.String`	`PARAM_CHOICEELEMENT` Parameter name for the request parameter "choiceelement".
`static java.lang.String`	`PARAM_CHOICETYPE` Parameter name for the request parameter "choicetype".
`static java.lang.String`	`PARAM_EDITCONTEXT` Parameter name for the request parameter "editcontext".
`static java.lang.String`	`PARAM_ELEMENTINDEX` Parameter name for the request parameter "elementindex".
`static java.lang.String`	`PARAM_ELEMENTNAME` Parameter name for the request parameter "elementname".
`static java.lang.String`	`PARAM_NEWLINK` Parameter name for the request parameter "newlink".

从类继承的字段 org.opencms.workplace.CmsDialog
ACTION_CANCEL, ACTION_CLOSEPOPUP, ACTION_CLOSEPOPUP_SAVE, ACTION_CONFIRMED, ACTION_CONTINUE, ACTION_DEFAULT, ACTION_LOCKS_CONFIRMED, ACTION_OK, ACTION_REPORT_BEGIN, ACTION_REPORT_END, ACTION_REPORT_UPDATE, ACTION_SET, ACTION_WAIT, ATTRIBUTE_THROWABLE, BUTTON_ADVANCED, BUTTON_BACK, BUTTON_CANCEL, BUTTON_CLOSE, BUTTON_CONTINUE, BUTTON_DETAILS, BUTTON_DISCARD, BUTTON_EDIT, BUTTON_OK, BUTTON_OK_NO_SUBMIT, BUTTON_SET, DIALOG_BACK, DIALOG_CANCEL, DIALOG_CONFIRMED, DIALOG_CONTINUE, DIALOG_INITIAL, DIALOG_LOCKS_CONFIRMED, DIALOG_OK, DIALOG_SET, DIALOG_WAIT, PARAM_ACTION, PARAM_CLOSELINK, PARAM_DIALOGTYPE, PARAM_ERRORSTACK, PARAM_FILE, PARAM_FRAMENAME, PARAM_ISPOPUP, PARAM_LOCK, PARAM_MESSAGE, PARAM_ORIGINALPARAMS, PARAM_PREACTIONDONE, PARAM_REDIRECT, PARAM_RESOURCE, PARAM_TARGET, PARAM_THREAD, PARAM_THREAD_HASNEXT, PARAM_TITLE, REPORT_BEGIN, REPORT_END, REPORT_UPDATE

从类继承的字段 org.opencms.workplace.tools.CmsToolDialog
PARAM_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW

构造器概要

构造器
构造器和说明

CmsXmlContentEditor(CmsJspActionElement jsp)
Public constructor.

构造器
构造器和说明
`CmsXmlContentEditor(CmsJspActionElement jsp)` Public constructor.

方法概要

方法
限定符和类型	方法和说明
`void`	`actionChangeElementLanguage()` Performs the change element language action of the editor.
`void`	`actionClear(boolean forceUnlock)` Deletes the temporary file and unlocks the edited resource when in direct edit mode.
`void`	`actionCopyElementLocale()` Performs the copy locale action.
`void`	`actionDeleteElementLocale()` Performs the delete locale action.
`void`	`actionDirectEdit()` Performs a configurable action performed by the editor.
`void`	`actionExit()` Performs the exit editor action.
`void`	`actionMoveElement()` Moves an element in the xml content either up or down.
`void`	`actionNew()` Creates a new XML content item for editing.
`void`	`actionPreview()` Performs the preview XML content action in a new browser window.
`void`	`actionSave()` Performs the save content action.
`void`	`actionSave(java.util.Locale locale)` Performs the save content action.
`void`	`actionToggleElement()` Adds an optional element to the XML content or removes an optional element from the XML content.
`JSONArray`	`buildElementChoices(java.lang.String elementName, boolean choiceType, boolean checkChoice)` Returns the JSON array with information about the choices of a given element.
`java.lang.String`	`buildSelectElementLanguage(java.lang.String attributes)` Builds the HTML String for the element language selector.
`java.lang.String`	`buildSubChoices()` Returns the available sub choices for a nested choice element.
`protected void`	`commitTempFile()` Writes the content of a temporary file back to the original file.
`protected java.util.Locale`	`ensureLocale(java.util.Locale locale)` Makes sure the requested locale node is present in the content document by either copying an existing locale node or creating an empty one.
`int`	`getButtonStyle()` Returns the style setting to use when generating buttons for this widget dialog.
`java.lang.String`	`getEditorResourceUri()` Returns the URI to the editor resource folder where button images and javascripts are located.
`java.util.Locale`	`getElementLocale()` Returns the current element locale.
`java.util.Set<java.lang.String>`	`getHelpMessageIds()` Returns a set of help messages ids that are already included on the widget dialog.
`java.lang.String`	`getParamChoiceElement()` Returns the name of the choice element to add.
`java.lang.String`	`getParamChoiceType()` Returns the flag if the element to add is a choice type.
`java.lang.String`	`getParamEditContext()` Gets the editor context path (usually either a container page path or null).
`java.lang.String`	`getParamElementIndex()` Returns the index of the element to add or remove.
`java.lang.String`	`getParamElementName()` Returns the name of the element to add or remove.
`java.lang.String`	`getParamModelFile()` Returns the parameter that specifies the model file name.
`java.lang.String`	`getParamNewLink()` Returns the "new link" parameter.
`java.lang.String`	`getUserAgent()` Returns the "user-agent" of the current request, or `null` in case no request is available.
`CmsXmlContentWidgetVisitor`	`getWidgetCollector()` Returns the different xml editor widgets used in the form to display.
`java.lang.String`	`getXmlEditorForm()` Generates the HTML form for the XML content editor.
`java.lang.String`	`getXmlEditorHtmlEnd()` Generates the HTML for the end of the HTML editor form page.
`java.lang.String`	`getXmlEditorIncludes()` Generates the JavaScript includes for the used widgets in the editor form.
`java.lang.String`	`getXmlEditorInitCalls()` Generates the JavaScript initialization calls for the used widgets in the editor form.
`java.lang.String`	`getXmlEditorInitMethods()` Generates the JavaScript initialization methods for the used widgets.
`boolean`	`hasValidationErrors()` Returns true if the edited content contains validation errors, otherwise false.
`protected void`	`initContent()` Initializes the editor content when opening the editor for the first time.
`protected void`	`initElementLanguage()` Initializes the element language for the first call of the editor.
`protected void`	`initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)` Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
`boolean`	`isPreviewEnabled()` Returns true if the preview is available for the edited xml content.
`void`	`setEditorValues(java.util.Locale locale)` Sets the editor values for the locale with the parameters from the request.
`void`	`setParamChoiceElement(java.lang.String choiceElement)` Sets the name of the choice element to add.
`void`	`setParamChoiceType(java.lang.String paramChoiceType)` Sets the flag if the element to add is a choice type.
`void`	`setParamEditContext(java.lang.String editContext)` Sets the edit context URI.
`void`	`setParamElementIndex(java.lang.String elementIndex)` Sets the index of the element to add or remove.
`void`	`setParamElementName(java.lang.String elementName)` Sets the name of the element to add or remove.
`void`	`setParamModelFile(java.lang.String paramMasterFile)` Sets the parameter that specifies the model file name.
`void`	`setParamNewLink(java.lang.String paramNewLink)` Sets the "new link" parameter.
`boolean`	`showElementLanguageSelector()` Determines if the element language selector is shown dependent on the available Locales.
`boolean`	`useNewStyle()` Tests if we are working with the new administration dialog style.

从类继承的方法 org.opencms.workplace.editors.CmsEditor
actionClose, buildSelectElementLanguage, button, buttonActionCancel, buttonActionDirectEdit, checkLock, clearEditorSessionInfo, createTempFile, decodeContent, decodeParamValue, deleteLocaleButton, deleteTempFile, encodeContent, getCloneCms, getEditorDisplayOptions, getEditorSessionInfo, getFileEncoding, getFileEncoding, getOpenCmsContext, getParamBacklink, getParamContent, getParamDirectedit, getParamEditastext, getParamEditormode, getParamElementlanguage, getParamLoaddefault, getParamModified, getParamOldelementlanguage, getParamTempfile, getPicsUri, initMessages, initSessionInfo, setFileEncoding, setParamBacklink, setParamContent, setParamDirectedit, setParamEditastext, setParamEditormode, setParamElementlanguage, setParamLoaddefault, setParamModified, setParamOldelementlanguage, setParamTempfile, showErrorPage, showErrorPage

从类继承的方法 org.opencms.workplace.editors.CmsEditorBase
initTimeWarp

从类继承的方法 org.opencms.workplace.CmsDialog
actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockDialog, buildLockDialog, buildLockHeaderBox, checkResourcePermissions, checkResourcePermissions, computeCurrentFolder, dialog, dialogBlock, dialogBlockEnd, dialogBlockStart, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, dialogButtonsHtml, dialogButtonsOk, dialogButtonsOk, dialogButtonsOkCancel, dialogButtonsOkCancel, dialogButtonsOkCancelAdvanced, dialogButtonsSetOkCancel, dialogContent, dialogContentEnd, dialogContentStart, dialogEnd, dialogHead, dialogHorizontalSpacer, dialogLockButtons, dialogRow, dialogRowEnd, dialogRowStart, dialogScriptSubmit, dialogSeparator, dialogSpacer, dialogStart, dialogStart, dialogSubheadline, dialogToggleStart, dialogWhiteBox, dialogWhiteBoxEnd, dialogWhiteBoxStart, getAction, getAdministrationBackLink, getCancelAction, getDialogRealUri, getDialogUri, getOnlineHelpUriCustom, getParamAction, getParamCloseLink, getParamDialogtype, getParamFramename, getParamIsPopup, getParamMessage, getParamOriginalParams, getParamPreActionDone, getParamRedirect, getParamResource, getParamTitle, getState, hasCorrectLockstate, hasSiblings, htmlStart, htmlStart, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, isPreEditor, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, setParamResource, setParamTitle

从类继承的方法 org.opencms.workplace.tools.CmsToolDialog
computeUpLevelLink, dialogTitle, getAdminTool, getCurrentToolPath, getParamBase, getParamForce, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, setParamForce, setParamPath, setParamRoot, setParamStyle

从类继承的方法 org.opencms.workplace.CmsWorkplace
addMessages, addMessages, allParamsAsHidden, allParamsAsRequest, allParamValues, bodyEnd, bodyStart, bodyStart, buildSelect, buildSelect, button, button, buttonBar, buttonBar, buttonBarHorizontalLine, buttonBarLabel, buttonBarLabel, buttonBarLine, buttonBarLineSpacer, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, checkLock, checkRole, fillParamValues, fillParamValues, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStartSiteRoot, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, htmlEnd, initSettings, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, switchToCurrentProject, switchToTempProject

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.opencms.widgets.I_CmsWidgetDialog
button, buttonBar, buttonBarHorizontalLine, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, dialogHorizontalSpacer, getLocale, getMessages

- 字段详细资料
  - ACTION_CHECK
```
public static final int ACTION_CHECK
```
    Action for checking content before executing the direct edit action.
    
    另请参阅:
    常量字段值
  - ACTION_CONFIRMCORRECTION
```
public static final int ACTION_CONFIRMCORRECTION
```
    Action for confirming the XML content structure correction.
    
    另请参阅:
    常量字段值
  - ACTION_COPYLOCALE
```
public static final int ACTION_COPYLOCALE
```
    Value for the action: copy the current locale.
    
    另请参阅:
    常量字段值
  - ACTION_CORRECTIONCONFIRMED
```
public static final int ACTION_CORRECTIONCONFIRMED
```
    Action for correction of the XML content structure confirmed.
    
    另请参阅:
    常量字段值
  - ACTION_ELEMENT_ADD
```
public static final int ACTION_ELEMENT_ADD
```
    Action for optional element creation.
    
    另请参阅:
    常量字段值
  - ACTION_ELEMENT_MOVE_DOWN
```
public static final int ACTION_ELEMENT_MOVE_DOWN
```
    Action for element move down operation.
    
    另请参阅:
    常量字段值
  - ACTION_ELEMENT_MOVE_UP
```
public static final int ACTION_ELEMENT_MOVE_UP
```
    Action for element move up operation.
    
    另请参阅:
    常量字段值
  - ACTION_ELEMENT_REMOVE
```
public static final int ACTION_ELEMENT_REMOVE
```
    Action for optional element removal.
    
    另请参阅:
    常量字段值
  - ACTION_NEW
```
public static final int ACTION_NEW
```
    Action for new file creation.
    
    另请参阅:
    常量字段值
  - ACTION_SUBCHOICES
```
public static final int ACTION_SUBCHOICES
```
    Action that sub choices should be determined.
    
    另请参阅:
    常量字段值
  - ATTRIBUTE_EDITCONTEXT
```
public static final java.lang.String ATTRIBUTE_EDITCONTEXT
```
    Request context attribute for the page from which the editor was opened.
  - EDITOR_ACTION_CHECK
```
public static final java.lang.String EDITOR_ACTION_CHECK
```
    Indicates that the content should be checked before executing the direct edit action.
    
    另请参阅:
    常量字段值
  - EDITOR_ACTION_CONFIRMCORRECTION
```
public static final java.lang.String EDITOR_ACTION_CONFIRMCORRECTION
```
    Indicates that the correction of the XML content structure should be confirmed.
    
    另请参阅:
    常量字段值
  - EDITOR_ACTION_ELEMENT_ADD
```
public static final java.lang.String EDITOR_ACTION_ELEMENT_ADD
```
    Indicates an optional element should be created.
    
    另请参阅:
    常量字段值
  - EDITOR_ACTION_ELEMENT_MOVE_DOWN
```
public static final java.lang.String EDITOR_ACTION_ELEMENT_MOVE_DOWN
```
    Indicates an element should be moved down.
    
    另请参阅:
    常量字段值
  - EDITOR_ACTION_ELEMENT_MOVE_UP
```
public static final java.lang.String EDITOR_ACTION_ELEMENT_MOVE_UP
```
    Indicates an element should be moved up.
    
    另请参阅:
    常量字段值
  - EDITOR_ACTION_ELEMENT_REMOVE
```
public static final java.lang.String EDITOR_ACTION_ELEMENT_REMOVE
```
    Indicates an optional element should be removed.
    
    另请参阅:
    常量字段值
  - EDITOR_ACTION_NEW
```
public static final java.lang.String EDITOR_ACTION_NEW
```
    Indicates a new file should be created.
    
    另请参阅:
    常量字段值
  - EDITOR_ACTION_SUBCHOICES
```
public static final java.lang.String EDITOR_ACTION_SUBCHOICES
```
    Indicates that sub choices should be determined.
    
    另请参阅:
    常量字段值
  - EDITOR_COPYLOCALE
```
public static final java.lang.String EDITOR_COPYLOCALE
```
    Indicates that the contents of the current locale should be copied to other locales.
    
    另请参阅:
    常量字段值
  - EDITOR_CORRECTIONCONFIRMED
```
public static final java.lang.String EDITOR_CORRECTIONCONFIRMED
```
    Indicates that the correction of the XML content structure was confirmed by the user.
    
    另请参阅:
    常量字段值
  - PARAM_CHOICEELEMENT
```
public static final java.lang.String PARAM_CHOICEELEMENT
```
    Parameter name for the request parameter "choiceelement".
    
    另请参阅:
    常量字段值
  - PARAM_CHOICETYPE
```
public static final java.lang.String PARAM_CHOICETYPE
```
    Parameter name for the request parameter "choicetype".
    
    另请参阅:
    常量字段值
  - PARAM_EDITCONTEXT
```
public static final java.lang.String PARAM_EDITCONTEXT
```
    Parameter name for the request parameter "editcontext".
    
    另请参阅:
    常量字段值
  - PARAM_ELEMENTINDEX
```
public static final java.lang.String PARAM_ELEMENTINDEX
```
    Parameter name for the request parameter "elementindex".
    
    另请参阅:
    常量字段值
  - PARAM_ELEMENTNAME
```
public static final java.lang.String PARAM_ELEMENTNAME
```
    Parameter name for the request parameter "elementname".
    
    另请参阅:
    常量字段值
  - PARAM_NEWLINK
```
public static final java.lang.String PARAM_NEWLINK
```
    Parameter name for the request parameter "newlink".
    
    另请参阅:
    常量字段值
- 构造器详细资料
  - CmsXmlContentEditor
```
public CmsXmlContentEditor(CmsJspActionElement jsp)
```
    Public constructor.
    
    参数:
    jsp - an initialized JSP action element
- 方法详细资料
  - actionChangeElementLanguage
```
public void actionChangeElementLanguage()
```
    Performs the change element language action of the editor.
  - actionClear
```
public void actionClear(boolean forceUnlock)
```
    Deletes the temporary file and unlocks the edited resource when in direct edit mode.
    
    指定者:
    
    actionClear 在类中 CmsEditor
    
    参数:
    forceUnlock - if true, the resource will be unlocked anyway
  - actionCopyElementLocale
```
public void actionCopyElementLocale()
                             throws javax.servlet.jsp.JspException
```
    Performs the copy locale action.
    
    抛出:
    
    javax.servlet.jsp.JspException - if something goes wrong
  - actionDeleteElementLocale
```
public void actionDeleteElementLocale()
                               throws javax.servlet.jsp.JspException
```
    Performs the delete locale action.
    
    抛出:
    
    javax.servlet.jsp.JspException - if something goes wrong
  - actionDirectEdit
```
public void actionDirectEdit()
                      throws java.io.IOException,
                             javax.servlet.jsp.JspException,
                             javax.servlet.ServletException
```
    Performs a configurable action performed by the editor.
    The default action is: save resource, clear temporary files and publish the resource directly.
    
    抛出:
    
    java.io.IOException - if a forward fails
    
    javax.servlet.ServletException - of a forward fails
    
    javax.servlet.jsp.JspException - if including a JSP fails
  - actionExit
```
public void actionExit()
                throws java.io.IOException,
                       javax.servlet.jsp.JspException,
                       javax.servlet.ServletException
```
    Performs the exit editor action.
    
    指定者:
    
    actionExit 在类中 CmsEditor
    
    抛出:
    
    java.io.IOException - if a forward fails
    
    javax.servlet.jsp.JspException - if including an element fails
    
    javax.servlet.ServletException - if a forward fails
    另请参阅:
    CmsEditor.actionExit()
  - actionMoveElement
```
public void actionMoveElement()
                       throws javax.servlet.jsp.JspException
```
    Moves an element in the xml content either up or down.
    Depends on the given action value.
    
    抛出:
    
    javax.servlet.jsp.JspException - if including the error page fails
  - actionNew
```
public void actionNew()
               throws javax.servlet.jsp.JspException
```
    Creates a new XML content item for editing.
    
    抛出:
    
    javax.servlet.jsp.JspException - in case something goes wrong
  - actionPreview
```
public void actionPreview()
                   throws java.io.IOException,
                          javax.servlet.jsp.JspException
```
    Performs the preview XML content action in a new browser window.
    
    抛出:
    
    java.io.IOException - if redirect fails
    
    javax.servlet.jsp.JspException - if inclusion of error page fails
  - actionSave
```
public void actionSave()
                throws javax.servlet.jsp.JspException
```
    Performs the save content action.
    
    指定者:
    
    actionSave 在类中 CmsEditor
    
    抛出:
    
    javax.servlet.jsp.JspException - if including an element fails
    另请参阅:
    CmsEditor.actionSave()
  - actionSave
```
public void actionSave(java.util.Locale locale)
                throws javax.servlet.jsp.JspException
```
    Performs the save content action.
    This is also used when changing the element language.
    
    参数:
    locale - the locale to save the content
    
    抛出:
    
    javax.servlet.jsp.JspException - if including the error page fails
  - actionToggleElement
```
public void actionToggleElement()
                         throws javax.servlet.jsp.JspException
```
    Adds an optional element to the XML content or removes an optional element from the XML content.
    Depends on the given action value.
    
    抛出:
    
    javax.servlet.jsp.JspException - if including the error page fails
  - buildElementChoices
```
public JSONArray buildElementChoices(java.lang.String elementName,
                            boolean choiceType,
                            boolean checkChoice)
```
    Returns the JSON array with information about the choices of a given element.
    The returned array is only filled if the given element has choice options, otherwise an empty array is returned.
    Note: the first array element is an object containing information if the element itself is a choice type, the following elements are the choice option items.
    
    参数:
    elementName - the element name to check (complete xpath)
    choiceType - flag indicating if the given element name represents a choice type or not
    checkChoice - flag indicating if the element name should be checked if it is a choice option and choice type
    
    返回:
    the JSON array with information about the choices of a given element
  - buildSelectElementLanguage
```
public java.lang.String buildSelectElementLanguage(java.lang.String attributes)
```
    Builds the HTML String for the element language selector.
    This method has to use the resource request parameter because the temporary file is not available in the upper button frame.
    
    参数:
    attributes - optional attributes for the <select> tag
    
    返回:
    the HTML for the element language select box
  - buildSubChoices
```
public java.lang.String buildSubChoices()
```
    Returns the available sub choices for a nested choice element.
    
    返回:
    the available sub choices for a nested choice element as JSON array string
  - getButtonStyle
```
public int getButtonStyle()
```
    从接口复制的说明: I_CmsWidgetDialog
    
    Returns the style setting to use when generating buttons for this widget dialog.
    
    指定者:
    
    getButtonStyle 在接口中 I_CmsWidgetDialog
    
    返回:
    the style setting to use when generating buttons for this widget dialog
    另请参阅:
    I_CmsWidgetDialog.getButtonStyle()
  - getEditorResourceUri
```
public java.lang.String getEditorResourceUri()
```
    从类复制的说明: CmsEditor
    
    Returns the URI to the editor resource folder where button images and javascripts are located.
    
    指定者:
    
    getEditorResourceUri 在类中 CmsEditor
    
    返回:
    the URI to the editor resource folder
    另请参阅:
    CmsEditor.getEditorResourceUri()
  - getElementLocale
```
public java.util.Locale getElementLocale()
```
    Returns the current element locale.
    
    返回:
    the current element locale
  - getHelpMessageIds
```
public java.util.Set<java.lang.String> getHelpMessageIds()
```
    从接口复制的说明: I_CmsWidgetDialog
    
    Returns a set of help messages ids that are already included on the widget dialog.
    This is used to prevent the occurence of multiple html div id's with the same value when generating the help texts. For valid html, each id can be used only once.
    
    指定者:
    
    getHelpMessageIds 在接口中 I_CmsWidgetDialog
    
    返回:
    a set of help messages ids that are already included on the widget dialog
    另请参阅:
    I_CmsWidgetDialog.getHelpMessageIds()
  - getParamChoiceElement
```
public java.lang.String getParamChoiceElement()
```
    Returns the name of the choice element to add.
    
    返回:
    the name of the choice element to add
  - getParamChoiceType
```
public java.lang.String getParamChoiceType()
```
    Returns the flag if the element to add is a choice type.
    
    返回:
    the flag if the element to add is a choice type
  - getParamEditContext
```
public java.lang.String getParamEditContext()
```
    Gets the editor context path (usually either a container page path or null).
    
    返回:
    the editor context path
  - getParamElementIndex
```
public java.lang.String getParamElementIndex()
```
    Returns the index of the element to add or remove.
    
    返回:
    the index of the element to add or remove
  - getParamElementName
```
public java.lang.String getParamElementName()
```
    Returns the name of the element to add or remove.
    
    返回:
    the name of the element to add or remove
  - getParamModelFile
```
public java.lang.String getParamModelFile()
```
    Returns the parameter that specifies the model file name.
    
    返回:
    the parameter that specifies the model file name
  - getParamNewLink
```
public java.lang.String getParamNewLink()
```
    Returns the "new link" parameter.
    
    返回:
    the "new link" parameter
  - getUserAgent
```
public java.lang.String getUserAgent()
```
    从接口复制的说明: I_CmsWidgetDialog
    
    Returns the "user-agent" of the current request, or null in case no request is available.
    
    指定者:
    
    getUserAgent 在接口中 I_CmsWidgetDialog
    
    返回:
    the "user-agent" of the current request
    另请参阅:
    I_CmsWidgetDialog.getUserAgent()
  - getWidgetCollector
```
public CmsXmlContentWidgetVisitor getWidgetCollector()
```
    Returns the different xml editor widgets used in the form to display.
    
    返回:
    the different xml editor widgets used in the form to display
  - getXmlEditorForm
```
public java.lang.String getXmlEditorForm()
```
    Generates the HTML form for the XML content editor.
    
    返回:
    the HTML that generates the form for the XML editor
  - getXmlEditorHtmlEnd
```
public java.lang.String getXmlEditorHtmlEnd()
                                     throws javax.servlet.jsp.JspException
```
    Generates the HTML for the end of the HTML editor form page.
    
    返回:
    the HTML for the end of the HTML editor form page
    
    抛出:
    
    javax.servlet.jsp.JspException - if including the error page fails
  - getXmlEditorIncludes
```
public java.lang.String getXmlEditorIncludes()
                                      throws javax.servlet.jsp.JspException
```
    Generates the JavaScript includes for the used widgets in the editor form.
    
    返回:
    the JavaScript includes for the used widgets
    
    抛出:
    
    javax.servlet.jsp.JspException - if including the error page fails
  - getXmlEditorInitCalls
```
public java.lang.String getXmlEditorInitCalls()
                                       throws javax.servlet.jsp.JspException
```
    Generates the JavaScript initialization calls for the used widgets in the editor form.
    
    返回:
    the JavaScript initialization calls for the used widgets
    
    抛出:
    
    javax.servlet.jsp.JspException - if including the error page fails
  - getXmlEditorInitMethods
```
public java.lang.String getXmlEditorInitMethods()
                                         throws javax.servlet.jsp.JspException
```
    Generates the JavaScript initialization methods for the used widgets.
    
    返回:
    the JavaScript initialization methods for the used widgets
    
    抛出:
    
    javax.servlet.jsp.JspException - if an error occurs during JavaScript generation
  - hasValidationErrors
```
public boolean hasValidationErrors()
```
    Returns true if the edited content contains validation errors, otherwise false.
    
    返回:
    true if the edited content contains validation errors, otherwise false
  - isPreviewEnabled
```
public boolean isPreviewEnabled()
```
    Returns true if the preview is available for the edited xml content.
    This method has to use the resource request parameter and read the file from vfs because the temporary file is not available in the upper button frame.
    
    返回:
    true if the preview is enabled, otherwise false
  - setEditorValues
```
public void setEditorValues(java.util.Locale locale)
                     throws CmsXmlException
```
    Sets the editor values for the locale with the parameters from the request.
    Called before saving the xml content, redisplaying the input form, changing the language and adding or removing elements.
    
    参数:
    locale - the locale of the content to save
    
    抛出:
    
    CmsXmlException - if something goes wrong
  - setParamChoiceElement
```
public void setParamChoiceElement(java.lang.String choiceElement)
```
    Sets the name of the choice element to add.
    
    参数:
    choiceElement - the name of the choice element to add
  - setParamChoiceType
```
public void setParamChoiceType(java.lang.String paramChoiceType)
```
    Sets the flag if the element to add is a choice type.
    
    参数:
    paramChoiceType - the flag if the element to add is a choice type
  - setParamEditContext
```
public void setParamEditContext(java.lang.String editContext)
```
    Sets the edit context URI.
    
    参数:
    editContext - the edit context URI.
  - setParamElementIndex
```
public void setParamElementIndex(java.lang.String elementIndex)
```
    Sets the index of the element to add or remove.
    
    参数:
    elementIndex - the index of the element to add or remove
  - setParamElementName
```
public void setParamElementName(java.lang.String elementName)
```
    Sets the name of the element to add or remove.
    
    参数:
    elementName - the name of the element to add or remove
  - setParamModelFile
```
public void setParamModelFile(java.lang.String paramMasterFile)
```
    Sets the parameter that specifies the model file name.
    
    参数:
    paramMasterFile - the parameter that specifies the model file name
  - setParamNewLink
```
public void setParamNewLink(java.lang.String paramNewLink)
```
    Sets the "new link" parameter.
    
    参数:
    paramNewLink - the "new link" parameter to set
  - showElementLanguageSelector
```
public boolean showElementLanguageSelector()
```
    Determines if the element language selector is shown dependent on the available Locales.
    
    返回:
    true, if more than one Locale is available, otherwise false
  - useNewStyle
```
public boolean useNewStyle()
```
    从类复制的说明: CmsToolDialog
    
    Tests if we are working with the new administration dialog style.
    The default is the new style, this parameter is not intended for external use.
    
    指定者:
    
    useNewStyle 在接口中 I_CmsWidgetDialog
    
    覆盖:
    
    useNewStyle 在类中 CmsToolDialog
    
    返回:
    true if using the new style
    另请参阅:
    CmsToolDialog.useNewStyle()
  - commitTempFile
```
protected void commitTempFile()
                       throws CmsException
```
    从类复制的说明: CmsEditor
    
    Writes the content of a temporary file back to the original file.
    
    覆盖:
    
    commitTempFile 在类中 CmsEditor
    
    抛出:
    
    CmsException - if something goes wrong
    另请参阅:
    CmsEditor.commitTempFile()
  - ensureLocale
```
protected java.util.Locale ensureLocale(java.util.Locale locale)
```
    Makes sure the requested locale node is present in the content document by either copying an existing locale node or creating an empty one.
    
    参数:
    locale - the requested locale
    
    返回:
    the locale
  - initContent
```
protected void initContent()
```
    Initializes the editor content when opening the editor for the first time.
    Not necessary for the xmlcontent editor.
    
    指定者:
    
    initContent 在类中 CmsEditor
  - initElementLanguage
```
protected void initElementLanguage()
```
    Initializes the element language for the first call of the editor.
  - initWorkplaceRequestValues
```
protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings,
                              javax.servlet.http.HttpServletRequest request)
```
    从类复制的说明: CmsWorkplace
    
    Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
    
    覆盖:
    
    initWorkplaceRequestValues 在类中 CmsDialog
    
    参数:
    settings - the workplace settings
    request - the current request
    另请参阅:
    CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)

类 CmsXmlContentEditor

字段概要

从类继承的字段 org.opencms.workplace.editors.CmsEditor

从类继承的字段 org.opencms.workplace.CmsDialog

从类继承的字段 org.opencms.workplace.tools.CmsToolDialog

从类继承的字段 org.opencms.workplace.CmsWorkplace

构造器概要

方法概要

从类继承的方法 org.opencms.workplace.editors.CmsEditor

从类继承的方法 org.opencms.workplace.editors.CmsEditorBase

从类继承的方法 org.opencms.workplace.CmsDialog

从类继承的方法 org.opencms.workplace.tools.CmsToolDialog

从类继承的方法 org.opencms.workplace.CmsWorkplace

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

从接口继承的方法 org.opencms.widgets.I_CmsWidgetDialog

字段详细资料

ACTION_CHECK

ACTION_CONFIRMCORRECTION

ACTION_COPYLOCALE

ACTION_CORRECTIONCONFIRMED

ACTION_ELEMENT_ADD

ACTION_ELEMENT_MOVE_DOWN

ACTION_ELEMENT_MOVE_UP

ACTION_ELEMENT_REMOVE

ACTION_NEW

ACTION_SUBCHOICES

ATTRIBUTE_EDITCONTEXT

EDITOR_ACTION_CHECK

EDITOR_ACTION_CONFIRMCORRECTION

EDITOR_ACTION_ELEMENT_ADD

EDITOR_ACTION_ELEMENT_MOVE_DOWN

EDITOR_ACTION_ELEMENT_MOVE_UP

EDITOR_ACTION_ELEMENT_REMOVE

EDITOR_ACTION_NEW

EDITOR_ACTION_SUBCHOICES

EDITOR_COPYLOCALE

EDITOR_CORRECTIONCONFIRMED

PARAM_CHOICEELEMENT

PARAM_CHOICETYPE

PARAM_EDITCONTEXT

PARAM_ELEMENTINDEX

PARAM_ELEMENTNAME

PARAM_NEWLINK

构造器详细资料

CmsXmlContentEditor

方法详细资料

actionChangeElementLanguage

actionClear

actionCopyElementLocale

actionDeleteElementLocale

actionDirectEdit

actionExit

actionMoveElement

actionNew

actionPreview

actionSave

actionSave

actionToggleElement

buildElementChoices

buildSelectElementLanguage

buildSubChoices

getButtonStyle

getEditorResourceUri

getElementLocale

getHelpMessageIds

getParamChoiceElement

getParamChoiceType

getParamEditContext

getParamElementIndex

getParamElementName

getParamModelFile

getParamNewLink

getUserAgent

getWidgetCollector

getXmlEditorForm

getXmlEditorHtmlEnd

getXmlEditorIncludes

getXmlEditorInitCalls

getXmlEditorInitMethods

hasValidationErrors