org.opencms.workplace.editors
Class CmsMSDHtmlEditor
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.CmsDefaultPageEditor
org.opencms.workplace.editors.CmsSimplePageEditor
org.opencms.workplace.editors.CmsMSDHtmlEditor
- public class CmsMSDHtmlEditor
- extends CmsSimplePageEditor
Creates the output for editing a CmsDefaultPage with the MS DHTML control editor.
The following editor uses this class:
- /editors/msdhtml/editor.jsp
- Since:
- 6.0.0
- Version:
- $Revision: 1.17 $
- Author:
- Andreas Zahner
Fields inherited from class org.opencms.workplace.editors.CmsEditor |
ACTION_CHANGE_BODY, ACTION_DELETELOCALE, ACTION_EXIT, ACTION_PREVIEW, ACTION_SAVE, ACTION_SAVEACTION, ACTION_SAVEEXIT, ACTION_SHOW, ACTION_SHOW_ERRORMESSAGE, EDITOR_CHANGE_ELEMENT, EDITOR_CLEANUP, EDITOR_CLOSEBROWSER, EDITOR_DELETELOCALE, EDITOR_EXIT, EDITOR_PREVIEW, EDITOR_SAVE, EDITOR_SAVEACTION, EDITOR_SAVEEXIT, EDITOR_SHOW, EDITOR_SHOW_ERRORMESSAGE, EMPTY_LOCALE, 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.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, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, 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_COMMONS, VFS_PATH_EDITORS, VFS_PATH_GALLERIES, VFS_PATH_LOCALES, VFS_PATH_MODULES, VFS_PATH_RESOURCES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE |
Method Summary |
java.lang.String |
buildSelectViews(java.lang.String attributes)
Builds the html String for the editor views available in the editor screens. |
void |
escapeParams()
Escapes the content and title parameters to display them in the editor form. |
java.lang.String |
getEditorResourceUri()
Returns the URI to the editor resource folder where button images and javascripts are located. |
protected java.lang.String |
prepareContent(boolean save)
Manipulates the content String for the different editor views and the save operation. |
Methods inherited from class org.opencms.workplace.editors.CmsDefaultPageEditor |
actionChangeBodyElement, actionCleanupBodyElement, actionClear, actionDeleteElementLocale, actionDirectEdit, actionExit, actionPreview, actionSave, buildSelectElementLanguage, buildSelectElementName, buildSelectFonts, getElementList, getElementLocale, getParamElementname, getParamOldelementname, getUriStyleSheet, getUriTemplate, initBodyElementLanguage, initBodyElementName, initContent, performSaveContent, setParamElementname, setParamOldelementname |
Methods inherited from class org.opencms.workplace.editors.CmsEditor |
actionClose, buildSelectElementLanguage, button, buttonActionCancel, buttonActionDirectEdit, checkLock, commitTempFile, createTempFile, decodeContent, decodeParamValue, deleteLocaleButton, 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, dialogToggleStart, dialogWhiteBox, dialogWhiteBoxEnd, dialogWhiteBoxStart, getAction, getAdministrationBackLink, getCancelAction, getDialogRealUri, getDialogUri, getOnlineHelpUriCustom, getParamAction, getParamCloseLink, getParamDialogtype, getParamFramename, getParamIsPopup, getParamMessage, getParamRedirect, getParamResource, getParamTitle, getState, htmlStart, htmlStart, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamRedirect, setParamResource, setParamTitle |
Methods inherited from class org.opencms.workplace.tools.CmsToolDialog |
dialogTitle, getAdminTool, getCurrentToolPath, getParamBase, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, setParamPath, setParamRoot, setParamStyle, useNewStyle |
Methods inherited from class 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, fillParamValues, fillParamValues, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStyleUri, getStyleUri, getStyleUri, htmlEnd, initMessages, initSettings, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, switchToCurrentProject, switchToTempProject |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
EDITOR_TYPE
public static final java.lang.String EDITOR_TYPE
- Constant for the editor type, must be the same as the editors subfolder name in the VFS.
- See Also:
- Constant Field Values
SELECTBOX_EDITORVIEWKEYS
public static final java.lang.String[] SELECTBOX_EDITORVIEWKEYS
- Option localization keys for editor view select boxes.
SELECTBOX_EDITORVIEWS
public static final java.lang.String[] SELECTBOX_EDITORVIEWS
- Option values for editor view select boxes.
SELECTBOX_EDITORVIEWS_ALLOWED
public static final int[] SELECTBOX_EDITORVIEWS_ALLOWED
- values for editor view select boxes.
CmsMSDHtmlEditor
public CmsMSDHtmlEditor(CmsJspActionElement jsp)
- Public constructor.
- Parameters:
jsp
- an initialized JSP action element
buildSelectViews
public final java.lang.String buildSelectViews(java.lang.String attributes)
- Builds the html String for the editor views available in the editor screens.
- Parameters:
attributes
- optional attributes for the <select> tag
- Returns:
- the html for the editorview selectbox
escapeParams
public void escapeParams()
- Description copied from class:
CmsDefaultPageEditor
- Escapes the content and title parameters to display them in the editor form.
This method has to be called on the JSP right before the form display html is created.
*
- Overrides:
escapeParams
in class CmsDefaultPageEditor
- See Also:
CmsDefaultPageEditor.escapeParams()
getEditorResourceUri
public final java.lang.String getEditorResourceUri()
- Description copied from class:
CmsEditor
- Returns the URI to the editor resource folder where button images and javascripts are located.
- Overrides:
getEditorResourceUri
in class CmsSimplePageEditor
- See Also:
CmsEditor.getEditorResourceUri()
prepareContent
protected java.lang.String prepareContent(boolean save)
- Manipulates the content String for the different editor views and the save operation.
- Overrides:
prepareContent
in class CmsSimplePageEditor
- Parameters:
save
- if set to true, the content parameter is not updated
- Returns:
- the prepared content String