org.opencms.workplace.editors
Class CmsXmlContentEditor

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

All Implemented Interfaces:

I_CmsWidgetDialog

public class CmsXmlContentEditor

extends CmsEditor

implements I_CmsWidgetDialog

Creates the editor for XML content definitions.

Since:

6.0.0

Version:

$Revision: 1.62 $

Author:

Alexander Kandzior, Andreas Zahner

Field Summary

static int	ACTION_CHECK Action for checking content before executing the direct edit action.
static int	ACTION_ELEMENT_ADD Action for optional element creation.
static int	ACTION_ELEMENT_REMOVE Action for optional element removal.
static int	ACTION_NEW Action for new file creation.
static String	EDITOR_ACTION_CHECK Indicates that the content should be checked before executing the direct edit action.
static String	EDITOR_ACTION_ELEMENT_ADD Indicates an optional element should be created.
static String	EDITOR_ACTION_ELEMENT_REMOVE Indicates an optional element should be removed.
static String	EDITOR_ACTION_NEW Indicates a new file should be created.
static String	PARAM_ELEMENTINDEX Parameter name for the request parameter "elementindex".
static String	PARAM_ELEMENTNAME Parameter name for the request parameter "elementname".

Fields inherited from class org.opencms.workplace.editors.CmsEditor

ACTION_CHANGE_BODY, ACTION_EXIT, ACTION_PREVIEW, ACTION_SAVE, ACTION_SAVEACTION, ACTION_SAVEEXIT, ACTION_SHOW, ACTION_SHOW_ERRORMESSAGE, EDITOR_CHANGE_ELEMENT, EDITOR_CLEANUP, EDITOR_EXIT, EDITOR_PREVIEW, EDITOR_SAVE, EDITOR_SAVEACTION, EDITOR_SAVEEXIT, EDITOR_SHOW, EDITOR_SHOW_ERRORMESSAGE, FILE_DIALOG_EDITOR_CONFIRM, PARAM_BACKLINK, PARAM_CONTENT, PARAM_DIRECTEDIT, PARAM_EDITASTEXT, PARAM_EDITORMODE, PARAM_ELEMENTLANGUAGE, PARAM_LOADDEFAULT, PARAM_MODIFIED, PARAM_OLDELEMENTLANGUAGE, PARAM_TEMPFILE, PATH_EDITORS

Fields inherited from class org.opencms.workplace.CmsDialog

ACTION_CANCEL, ACTION_CLOSEPOPUP, ACTION_CLOSEPOPUP_SAVE, ACTION_CONFIRMED, ACTION_DEFAULT, 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_OK, DIALOG_SET, DIALOG_WAIT, PARAM_ACTION, PARAM_CLOSELINK, PARAM_DIALOGTYPE, PARAM_ERRORSTACK, PARAM_FILE, PARAM_FRAMENAME, PARAM_ISPOPUP, PARAM_LOCK, PARAM_MESSAGE, PARAM_REDIRECT, PARAM_RESOURCE, PARAM_TARGET, PARAM_THREAD, PARAM_THREAD_HASNEXT, PARAM_TITLE, REPORT_BEGIN, REPORT_END, REPORT_UPDATE

Fields inherited from class org.opencms.workplace.tools.CmsToolDialog

PARAM_PATH, PARAM_ROOT, PARAM_STYLE

Fields inherited from class org.opencms.workplace.CmsWorkplace

DEBUG, DEFAULT_LANGUAGE, DEFAULT_LOCALE, DIALOG_PATH_COMMON, FILE_DIALOG_CLOSE, FILE_DIALOG_SCREEN_CONFIRM, FILE_DIALOG_SCREEN_ERROR, FILE_DIALOG_SCREEN_ERRORPAGE, FILE_DIALOG_SCREEN_WAIT, FILE_EXPLORER_FILELIST, FILE_REPORT_OUTPUT, HTML_END, HTML_START, PATH_DIALOGS, PATH_WORKPLACE, REQUEST_ATTRIBUTE_MULTIPART, REQUEST_ATTRIBUTE_RELOADTREE, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, TEMP_FILE_PREFIX, VFS_DIR_DEFAULTBODIES, VFS_DIR_TEMPLATES, VFS_PATH_GALLERIES, VFS_PATH_LOCALES, VFS_PATH_MODULES, VFS_PATH_RESOURCES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE

Constructor Summary

CmsXmlContentEditor(CmsJspActionElement jsp)
Public constructor.

Method Summary

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	actionDirectEdit() Performs a configurable action performed by the editor.
void	actionExit() Performs the exit editor action.
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(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.
String	buildAddElement(String elementName, int insertAfter, boolean enabled) Returns the html for a button to add an optional element.
String	buildRemoveElement(String elementName, int index, boolean enabled) Returns the html for a button to remove an optional element.
String	buildSelectElementLanguage(String attributes) Builds the html String for the element language selector.
int	getButtonStyle() Returns the style setting to use when generating buttons for this widget dialog.
String	getEditorResourceUri() Returns the URI to the editor resource folder where button images and javascripts are located.
Locale	getElementLocale() Returns the current element locale.
String	getParamElementIndex() Returns the index of the element to add or remove.
String	getParamElementName() Returns the name of the element to add or remove.
String	getParamNewLink() Returns the "new link" parameter.
String	getXmlEditorForm() Generates the HTML form for the XML content editor.
String	getXmlEditorHtmlEnd() Generates the HTML for the end of the html editor form page.
String	getXmlEditorIncludes() Generates the javascript includes for the used widgets in the editor form.
String	getXmlEditorInitCalls() Generates the javascript initialization calls for the used widgets in the editor form.
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, 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(Locale locale) Sets the editor values for the locale with the parameters from the request.
void	setParamElementIndex(String elementIndex) Sets the index of the element to add or remove.
void	setParamElementName(String elementName) Sets the name of the element to add or remove.
void	setParamNewLink(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.

Methods inherited from class org.opencms.workplace.editors.CmsEditor

actionClose, buildSelectElementLanguage, button, buttonActionCancel, buttonActionDirectEdit, checkLock, commitTempFile, createTempFile, decodeContent, decodeParamValue, deleteTempFile, encodeContent, getEditorDisplayOptions, getFileEncoding, getFileEncoding, getOpenCmsContext, getParamBacklink, getParamContent, getParamDirectedit, getParamEditastext, getParamEditormode, getParamElementlanguage, getParamLoaddefault, getParamModified, getParamOldelementlanguage, getParamTempfile, getPicsUri, setFileEncoding, setParamBacklink, setParamContent, setParamDirectedit, setParamEditastext, setParamEditormode, setParamElementlanguage, setParamLoaddefault, setParamModified, setParamOldelementlanguage, setParamTempfile, showErrorPage, showErrorPage

Methods inherited from class org.opencms.workplace.CmsDialog

actionCloseDialog, appendDelimiter, checkResourcePermissions, checkResourcePermissions, dialog, dialogBlock, dialogBlockEnd, dialogBlockStart, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, dialogButtonsHtml, dialogButtonsOk, dialogButtonsOk, dialogButtonsOkCancel, dialogButtonsOkCancel, dialogButtonsOkCancelAdvanced, dialogButtonsSetOkCancel, dialogContent, dialogContentEnd, dialogContentStart, dialogEnd, dialogHead, dialogHorizontalSpacer, dialogRow, dialogRowEnd, dialogRowStart, dialogScriptSubmit, dialogSeparator, dialogSpacer, dialogStart, dialogStart, dialogSubheadline, dialogWhiteBox, dialogWhiteBoxEnd, dialogWhiteBoxStart, getAction, getAdministrationBackLink, getCancelAction, getDialogRealUri, getDialogUri, getParamAction, getParamCloseLink, getParamDialogtype, getParamFramename, getParamIsPopup, getParamMessage, getParamRedirect, getParamResource, getParamTitle, getState, htmlStart, htmlStart, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, pageHtml, pageHtml, setAction, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamRedirect, setParamResource, setParamTitle

Methods inherited from class org.opencms.workplace.tools.CmsToolDialog

dialogTitle, getAdminTool, getCurrentToolPath, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamPath, setParamRoot, setParamStyle

Methods inherited from class org.opencms.workplace.CmsWorkplace

addMessages, allParamsAsHidden, allParamsAsRequest, allParamValues, bodyEnd, bodyStart, bodyStart, buildSelect, buildSelect, button, button, buttonBar, buttonBar, buttonBarHorizontalLine, buttonBarLabel, buttonBarLabel, buttonBarLine, buttonBarLineSpacer, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, calendarIncludes, calendarIncludes, calendarInit, calendarInit, checkLock, fillParamValues, getBroadcastMessageString, getCalendarDate, getCalendarJavaDateFormat, getCalendarLocalizedTime, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStyleUri, getStyleUri, getStyleUri, htmlEnd, initMessages, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, key, key, key, nullToEmpty, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, setForwarded, shortKey, switchToCurrentProject, switchToTempProject

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencms.widgets.I_CmsWidgetDialog

button, buttonBarSpacer, calendarIncludes, calendarInit, dialogHorizontalSpacer, getCalendarDate, getCalendarLocalizedTime, getLocale, getMessages

Field Detail

ACTION_CHECK

public static final int ACTION_CHECK

Action for checking content before executing the direct edit action.

See Also:

Constant Field Values

ACTION_ELEMENT_ADD

public static final int ACTION_ELEMENT_ADD

Action for optional element creation.

See Also:

Constant Field Values

ACTION_ELEMENT_REMOVE

public static final int ACTION_ELEMENT_REMOVE

Action for optional element removal.

See Also:

Constant Field Values

ACTION_NEW

public static final int ACTION_NEW

Action for new file creation.

See Also:

Constant Field Values

EDITOR_ACTION_CHECK

public static final String EDITOR_ACTION_CHECK

Indicates that the content should be checked before executing the direct edit action.

See Also:

Constant Field Values

EDITOR_ACTION_ELEMENT_ADD

public static final String EDITOR_ACTION_ELEMENT_ADD

Indicates an optional element should be created.

See Also:

Constant Field Values

EDITOR_ACTION_ELEMENT_REMOVE

public static final String EDITOR_ACTION_ELEMENT_REMOVE

Indicates an optional element should be removed.

See Also:

Constant Field Values

EDITOR_ACTION_NEW

public static final String EDITOR_ACTION_NEW

Indicates a new file should be created.

See Also:

Constant Field Values

PARAM_ELEMENTINDEX

public static final String PARAM_ELEMENTINDEX

Parameter name for the request parameter "elementindex".

See Also:

Constant Field Values

PARAM_ELEMENTNAME

public static final String PARAM_ELEMENTNAME

Parameter name for the request parameter "elementname".

See Also:

Constant Field Values

Constructor Detail

CmsXmlContentEditor

public CmsXmlContentEditor(CmsJspActionElement jsp)

Public constructor.

Parameters:

jsp - an initialized JSP action element

Method Detail

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.

Specified by:

actionClear in class CmsEditor

Parameters:

forceUnlock - if true, the resource will be unlocked anyway

actionDirectEdit

public void actionDirectEdit()
                      throws IOException,
                             JspException

Performs a configurable action performed by the editor.

The default action is: save resource, clear temporary files and publish the resource directly.

Throws:

IOException - if a redirection fails

JspException - if including a JSP fails

actionExit

public void actionExit()
                throws IOException,
                       JspException

Performs the exit editor action.

Specified by:

actionExit in class CmsEditor

Throws:

JspException - if including an element fails

IOException - if a redirection fails

See Also:

CmsEditor.actionExit()

actionNew

public void actionNew()
               throws JspException

Creates a new XML content item for editing.

Throws:

JspException - in case something goes wrong

actionPreview

public void actionPreview()
                   throws IOException,
                          JspException

Performs the preview xml content action in a new browser window.

Throws:

IOException - if redirect fails

JspException - if inclusion of error page fails

actionSave

public void actionSave()
                throws JspException

Performs the save content action.

Specified by:

actionSave in class CmsEditor

Throws:

JspException - if including an element fails

See Also:

CmsEditor.actionSave()

actionSave

public void actionSave(Locale locale)
                throws JspException

Performs the save content action.

This is also used when changing the element language.

Parameters:

locale - the locale to save the content

Throws:

JspException - if including the error page fails

actionToggleElement

public void actionToggleElement()
                         throws JspException

Adds an optional element to the xml content or removes an optional element from the xml content.

Depends on the given action value.

Throws:

JspException - if including the error page fails

buildAddElement

public String buildAddElement(String elementName,
                              int insertAfter,
                              boolean enabled)

Returns the html for a button to add an optional element.

Parameters:

elementName - name of the element

insertAfter - the index of the element after which the new element should be created

enabled - if true, the button to add an element is shown, otherwise a spacer is returned

Returns:

the html for a button to add an optional element

buildRemoveElement

public String buildRemoveElement(String elementName,
                                 int index,
                                 boolean enabled)

Returns the html for a button to remove an optional element.

Parameters:

elementName - name of the element

index - the element index of the element to remove

enabled - if true, the button to remove an element is shown, otherwise a spacer is returned

Returns:

the html for a button to remove an optional element

buildSelectElementLanguage

public String buildSelectElementLanguage(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.

Parameters:

attributes - optional attributes for the <select> tag

Returns:

the html for the element language selectbox

getButtonStyle

public int getButtonStyle()

Description copied from interface: I_CmsWidgetDialog

Returns the style setting to use when generating buttons for this widget dialog.

Specified by:

getButtonStyle in interface I_CmsWidgetDialog

Returns:

the style setting to use when generating buttons for this widget dialog

See Also:

I_CmsWidgetDialog.getButtonStyle()

getEditorResourceUri

public String getEditorResourceUri()

Description copied from class: CmsEditor

Returns the URI to the editor resource folder where button images and javascripts are located.

Specified by:

getEditorResourceUri in class CmsEditor

Returns:

the URI to the editor resource folder

See Also:

CmsEditor.getEditorResourceUri()

getElementLocale

public Locale getElementLocale()

Returns the current element locale.

Returns:

the current element locale

getParamElementIndex

public String getParamElementIndex()

Returns the index of the element to add or remove.

Returns:

the index of the element to add or remove

getParamElementName

public String getParamElementName()

Returns the name of the element to add or remove.

Returns:

the name of the element to add or remove

getParamNewLink

public String getParamNewLink()

Returns the "new link" parameter.

Returns:

the "new link" parameter

getXmlEditorForm

public String getXmlEditorForm()

Generates the HTML form for the XML content editor.

Returns:

the HTML that generates the form for the XML editor

getXmlEditorHtmlEnd

public String getXmlEditorHtmlEnd()
                           throws JspException

Generates the HTML for the end of the html editor form page.

Returns:

the HTML for the end of the html editor form page

Throws:

JspException - if including the error page fails

getXmlEditorIncludes

public String getXmlEditorIncludes()
                            throws JspException

Generates the javascript includes for the used widgets in the editor form.

Returns:

the javascript includes for the used widgets

Throws:

JspException - if including the error page fails

getXmlEditorInitCalls

public String getXmlEditorInitCalls()
                             throws JspException

Generates the javascript initialization calls for the used widgets in the editor form.

Returns:

the javascript initialization calls for the used widgets

Throws:

JspException - if including the error page fails

getXmlEditorInitMethods

public String getXmlEditorInitMethods()
                               throws JspException

Generates the JavaScript initialization methods for the used widgets.

Returns:

the JavaScript initialization methods for the used widgets

Throws:

JspException - if an error occurs during JavaScript generation

hasValidationErrors

public boolean hasValidationErrors()

Returns true if the edited content contains validation errors, otherwise false.

Returns:

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.

Returns:

true if the preview is enabled, otherwise false

setEditorValues

public void setEditorValues(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.

Parameters:

locale - the locale of the content to save

Throws:

CmsXmlException - if something goes wrong

setParamElementIndex

public void setParamElementIndex(String elementIndex)

Sets the index of the element to add or remove.

Parameters:

elementIndex - the index of the element to add or remove

setParamElementName

public void setParamElementName(String elementName)

Sets the name of the element to add or remove.

Parameters:

elementName - the name of the element to add or remove

setParamNewLink

public void setParamNewLink(String paramNewLink)

Sets the "new link" parameter.

Parameters:

paramNewLink - the "new link" parameter to set

showElementLanguageSelector

public boolean showElementLanguageSelector()

Determines if the element language selector is shown dependent on the available Locales.

Returns:

true, if more than one Locale is available, otherwise false

useNewStyle

public boolean useNewStyle()

Description copied from interface: I_CmsWidgetDialog

Tests if we are working with the new administration dialog style.

This param is not intended for external use.

Specified by:

useNewStyle in interface I_CmsWidgetDialog

Overrides:

useNewStyle in class CmsToolDialog

Returns:

true if using the new style

See Also:

CmsToolDialog.useNewStyle()

initContent

protected void initContent()

Initializes the editor content when opening the editor for the first time.

Not necessary for the xmlcontent editor.

Specified by:

initContent in class CmsEditor

initElementLanguage

protected void initElementLanguage()

Initializes the element language for the first call of the editor.

initWorkplaceRequestValues

protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings,
                                          HttpServletRequest request)

Description copied from class: CmsWorkplace

Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.

Overrides:

initWorkplaceRequestValues in class CmsDialog

See Also:

CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)