org.opencms.workplace.editors

类 CmsEditor

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

直接已知子类:

CmsDefaultPageEditor, CmsEditorFrameset, CmsSimpleEditor, CmsXmlContentEditor

public abstract class CmsEditor
extends CmsEditorBase

Provides basic methods for building the file editors of OpenCms.

The editor classes have to extend this class and implement action methods for common editor actions.

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
static int	ACTION_CHANGE_BODY Value for the action: change the body.
static int	ACTION_DELETELOCALE Value for the action: delete the current locale.
static int	ACTION_EXIT Value for the action: exit.
static int	ACTION_PREVIEW Value for the action: show a preview.
static int	ACTION_SAVE Value for the action: save.
static int	ACTION_SAVEACTION Constant value for the customizable action button.
static int	ACTION_SAVEEXIT Value for the action: save and exit.
static int	ACTION_SHOW Value for the action: show the editor.
static int	ACTION_SHOW_ERRORMESSAGE Value for the action: an error occurred.
static java.lang.String	EDITOR_CHANGE_ELEMENT Value for the action parameter: change the element.
static java.lang.String	EDITOR_CLEANUP Value for the action parameter: cleanup content.
static java.lang.String	EDITOR_CLOSEBROWSER Value for the action parameter: close browser window (accidentally).
static java.lang.String	EDITOR_DELETELOCALE Value for the action parameter: delete the current locale.
static java.lang.String	EDITOR_EXIT Value for the action parameter: exit editor.
static java.lang.String	EDITOR_PREVIEW Value for the action parameter: show a preview.
static java.lang.String	EDITOR_SAVE Value for the action parameter: save content.
static java.lang.String	EDITOR_SAVEACTION Value for the customizable action button.
static java.lang.String	EDITOR_SAVEEXIT Value for the action parameter: save and exit.
static java.lang.String	EDITOR_SHOW Value for the action parameter: show the editor.
static java.lang.String	EDITOR_SHOW_ERRORMESSAGE Value for the action parameter: an error occurred.
static java.lang.String	EMPTY_LOCALE Marker for empty locale in locale selection.
static java.lang.String	PARAM_BACKLINK Parameter name for the request parameter "backlink".
static java.lang.String	PARAM_CONTENT Parameter name for the request parameter "content".
static java.lang.String	PARAM_DIRECTEDIT Parameter name for the request parameter "directedit".
static java.lang.String	PARAM_EDITASTEXT Parameter name for the request parameter "editastext".
static java.lang.String	PARAM_EDITORMODE Parameter name for the request parameter "editormode".
static java.lang.String	PARAM_ELEMENTLANGUAGE Parameter name for the request parameter "element language".
static java.lang.String	PARAM_LOADDEFAULT Parameter name for the request parameter "loaddefault".
static java.lang.String	PARAM_MODIFIED Parameter name for the request parameter "modified".
static java.lang.String	PARAM_OLDELEMENTLANGUAGE Parameter name for the request parameter "old element language".
static java.lang.String	PARAM_TEMPFILE Parameter name for the request parameter "tempfile".
static java.lang.String	PATH_EDITORS Stores the VFS editor path.

从类继承的字段 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

从类继承的字段 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, RES_PATH_FILETYPES, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, 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, VIEW_DIRECT_EDIT, VIEW_WORKPLACE

构造器概要

构造器

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

方法概要

方法

限定符和类型	方法和说明
abstract void	actionClear(boolean forceUnlock) Unlocks the edited resource when in direct edit mode or when the resource was not modified.
protected void	actionClose() Closes the editor and forwards to the workplace or the resource depending on the editor mode.
abstract void	actionExit() Performs the exit editor action.
abstract void	actionSave() Performs the save content action.
java.lang.String	buildSelectElementLanguage(java.lang.String attributes, java.lang.String resourceName, java.util.Locale selectedLocale) Builds the html String for the element language selector.
java.lang.String	button(java.lang.String href, java.lang.String target, java.lang.String image, java.lang.String label, int type, boolean useCustomImage) Generates a button for the OpenCms editor.
java.lang.String	buttonActionCancel() Returns the editor action for a "cancel" button.
java.lang.String	buttonActionDirectEdit(java.lang.String jsFunction, int type) Builds the html to display the special action button for the direct edit mode of the editor.
void	checkLock(java.lang.String resource, CmsLockType type) Checks the lock state of the resource and locks it if the autolock feature is enabled.
protected void	clearEditorSessionInfo() Clears the editor session info bean.
protected void	commitTempFile() Writes the content of a temporary file back to the original file.
protected java.lang.String	createTempFile() Creates a temporary file which is needed while working in an editor with preview option.
protected java.lang.String	decodeContent(java.lang.String content) Decodes the given content the same way the client would do it.
protected java.lang.String	decodeParamValue(java.lang.String paramName, java.lang.String paramValue) Decodes an individual parameter value, ensuring the content is always decoded in UTF-8.
java.lang.String	deleteLocaleButton(java.lang.String href, java.lang.String target, java.lang.String image, java.lang.String label, int type) Generates a button for delete locale.
protected void	deleteTempFile() Deletes a temporary file from the OpenCms VFS, needed when exiting an editor.
protected java.lang.String	encodeContent(java.lang.String content) Encodes the given content so that it can be transfered to the client.
protected CmsObject	getCloneCms() Returns a cloned cms instance that prevents the time range resource filter check.
CmsEditorDisplayOptions	getEditorDisplayOptions() Returns the instantiated editor display option class from the workplace manager.
abstract java.lang.String	getEditorResourceUri() Returns the URI to the editor resource folder where button images and javascripts are located.
protected CmsEditorSessionInfo	getEditorSessionInfo() Returns the editor session info bean.
protected java.lang.String	getFileEncoding() Returns the encoding parameter.
protected java.lang.String	getFileEncoding(CmsObject cms, java.lang.String filename) Helper method to determine the encoding of the given file in the VFS, which must be set using the "content-encoding" property.
java.lang.String	getOpenCmsContext() Returns the OpenCms request context path.
java.lang.String	getParamBacklink() Returns the back link when closing the editor.
java.lang.String	getParamContent() Returns the content of the editor.
java.lang.String	getParamDirectedit() Returns the direct edit flag parameter.
java.lang.String	getParamEditastext() Returns the edit as text parameter.
java.lang.String	getParamEditormode() Returns the editor mode parameter.
java.lang.String	getParamElementlanguage() Returns the current element language.
java.lang.String	getParamLoaddefault() Returns the "loaddefault" parameter to determine if the default editor should be loaded.
java.lang.String	getParamModified() Returns the modified parameter indicating if the resource has been saved.
java.lang.String	getParamOldelementlanguage() Returns the old element language.
java.lang.String	getParamTempfile() Returns the name of the temporary file.
java.lang.String	getPicsUri() Returns the path to the images used by this editor.
protected abstract void	initContent() Initializes the editor content when openening the editor for the first time.
protected void	initMessages() Initializes the message object.
protected void	initSessionInfo() Initializes the editor session info bean.
protected void	setFileEncoding(java.lang.String value) Sets the encoding parameter.
void	setParamBacklink(java.lang.String backLink) Sets the back link when closing the editor.
void	setParamContent(java.lang.String content) Sets the content of the editor.
void	setParamDirectedit(java.lang.String direct) Sets the direct edit flag parameter.
void	setParamEditastext(java.lang.String editAsText) Sets the edit as text parameter.
void	setParamEditormode(java.lang.String mode) Sets the editor mode parameter.
void	setParamElementlanguage(java.lang.String elementLanguage) Sets the current element language.
void	setParamLoaddefault(java.lang.String loadDefault) Sets the "loaddefault" parameter to determine if the default editor should be loaded.
void	setParamModified(java.lang.String modified) Sets the modified parameter indicating if the resource has been saved.
void	setParamOldelementlanguage(java.lang.String oldElementLanguage) Sets the old element language.
void	setParamTempfile(java.lang.String fileName) Sets the name of the temporary file.
protected void	showErrorPage(java.lang.Exception exception) Shows the selected error page in case of an exception.
protected void	showErrorPage(java.lang.Object editor, java.lang.Exception exception) Shows the selected error page in case of an exception.

从类继承的方法 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, initWorkplaceRequestValues, 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, useNewStyle

从类继承的方法 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

字段详细资料

ACTION_CHANGE_BODY

public static final int ACTION_CHANGE_BODY

Value for the action: change the body.

另请参阅:

常量字段值

ACTION_DELETELOCALE

public static final int ACTION_DELETELOCALE

Value for the action: delete the current locale.

另请参阅:

常量字段值

ACTION_EXIT

public static final int ACTION_EXIT

Value for the action: exit.

另请参阅:

常量字段值

ACTION_PREVIEW

public static final int ACTION_PREVIEW

Value for the action: show a preview.

另请参阅:

常量字段值

ACTION_SAVE

public static final int ACTION_SAVE

Value for the action: save.

另请参阅:

常量字段值

ACTION_SAVEACTION

public static final int ACTION_SAVEACTION

Constant value for the customizable action button.

另请参阅:

常量字段值

ACTION_SAVEEXIT

public static final int ACTION_SAVEEXIT

Value for the action: save and exit.

另请参阅:

常量字段值

ACTION_SHOW

public static final int ACTION_SHOW

Value for the action: show the editor.

另请参阅:

常量字段值

ACTION_SHOW_ERRORMESSAGE

public static final int ACTION_SHOW_ERRORMESSAGE

Value for the action: an error occurred.

另请参阅:

常量字段值

EDITOR_CHANGE_ELEMENT

public static final java.lang.String EDITOR_CHANGE_ELEMENT

Value for the action parameter: change the element.

另请参阅:

常量字段值

EDITOR_CLEANUP

public static final java.lang.String EDITOR_CLEANUP

Value for the action parameter: cleanup content.

另请参阅:

常量字段值

EDITOR_CLOSEBROWSER

public static final java.lang.String EDITOR_CLOSEBROWSER

Value for the action parameter: close browser window (accidentally).

另请参阅:

常量字段值

EDITOR_DELETELOCALE

public static final java.lang.String EDITOR_DELETELOCALE

Value for the action parameter: delete the current locale.

另请参阅:

常量字段值

EDITOR_EXIT

public static final java.lang.String EDITOR_EXIT

Value for the action parameter: exit editor.

另请参阅:

常量字段值

EDITOR_PREVIEW

public static final java.lang.String EDITOR_PREVIEW

Value for the action parameter: show a preview.

另请参阅:

常量字段值

EDITOR_SAVE

public static final java.lang.String EDITOR_SAVE

Value for the action parameter: save content.

另请参阅:

常量字段值

EDITOR_SAVEACTION

public static final java.lang.String EDITOR_SAVEACTION

Value for the customizable action button.

另请参阅:

常量字段值

EDITOR_SAVEEXIT

public static final java.lang.String EDITOR_SAVEEXIT

Value for the action parameter: save and exit.

另请参阅:

常量字段值

EDITOR_SHOW

public static final java.lang.String EDITOR_SHOW

Value for the action parameter: show the editor.

另请参阅:

常量字段值

EDITOR_SHOW_ERRORMESSAGE

public static final java.lang.String EDITOR_SHOW_ERRORMESSAGE

Value for the action parameter: an error occurred.

另请参阅:

常量字段值

EMPTY_LOCALE

public static final java.lang.String EMPTY_LOCALE

Marker for empty locale in locale selection.

另请参阅:

常量字段值

PARAM_BACKLINK

public static final java.lang.String PARAM_BACKLINK

Parameter name for the request parameter "backlink".

另请参阅:

常量字段值

PARAM_CONTENT

public static final java.lang.String PARAM_CONTENT

Parameter name for the request parameter "content".

另请参阅:

常量字段值

PARAM_DIRECTEDIT

public static final java.lang.String PARAM_DIRECTEDIT

Parameter name for the request parameter "directedit".

另请参阅:

常量字段值

PARAM_EDITASTEXT

public static final java.lang.String PARAM_EDITASTEXT

Parameter name for the request parameter "editastext".

另请参阅:

常量字段值

PARAM_EDITORMODE

public static final java.lang.String PARAM_EDITORMODE

Parameter name for the request parameter "editormode".

另请参阅:

常量字段值

PARAM_ELEMENTLANGUAGE

public static final java.lang.String PARAM_ELEMENTLANGUAGE

Parameter name for the request parameter "element language".

另请参阅:

常量字段值

PARAM_LOADDEFAULT

public static final java.lang.String PARAM_LOADDEFAULT

Parameter name for the request parameter "loaddefault".

另请参阅:

常量字段值

PARAM_MODIFIED

public static final java.lang.String PARAM_MODIFIED

Parameter name for the request parameter "modified".

另请参阅:

常量字段值

PARAM_OLDELEMENTLANGUAGE

public static final java.lang.String PARAM_OLDELEMENTLANGUAGE

Parameter name for the request parameter "old element language".

另请参阅:

常量字段值

PARAM_TEMPFILE

public static final java.lang.String PARAM_TEMPFILE

Parameter name for the request parameter "tempfile".

另请参阅:

常量字段值

PATH_EDITORS

public static final java.lang.String PATH_EDITORS

Stores the VFS editor path.

另请参阅:

常量字段值

构造器详细资料

CmsEditor

public CmsEditor(CmsJspActionElement jsp)

Public constructor.

参数:

jsp - an initialized JSP action element

方法详细资料

actionClear

public abstract void actionClear(boolean forceUnlock)

Unlocks the edited resource when in direct edit mode or when the resource was not modified.

参数:

forceUnlock - if true, the resource will be unlocked anyway

actionExit

public abstract void actionExit()
                         throws CmsException,
                                java.io.IOException,
                                javax.servlet.ServletException,
                                javax.servlet.jsp.JspException

Performs the exit editor action.

抛出:

CmsException - if something goes wrong

java.io.IOException - if a forward fails

javax.servlet.ServletException - if a forward fails

javax.servlet.jsp.JspException - if including an element fails

actionSave

public abstract void actionSave()
                         throws java.io.IOException,
                                javax.servlet.jsp.JspException

Performs the save content action.

抛出:

java.io.IOException - if a redirection fails

javax.servlet.jsp.JspException - if including an element fails

buildSelectElementLanguage

public java.lang.String buildSelectElementLanguage(java.lang.String attributes,
                                          java.lang.String resourceName,
                                          java.util.Locale selectedLocale)

Builds the html String for the element language selector.

参数:

attributes - optional attributes for the <select> tag

resourceName - the name of the resource to edit

selectedLocale - the currently selected Locale

返回:

the html for the element language selectbox

button

public java.lang.String button(java.lang.String href,
                      java.lang.String target,
                      java.lang.String image,
                      java.lang.String label,
                      int type,
                      boolean useCustomImage)

Generates a button for the OpenCms editor.

参数:

href - the href link for the button, if none is given the button will be disabled

target - the href link target for the button, if none is given the target will be same window

image - the image name for the button, skin path will be automatically added as prefix

label - the label for the text of the button

type - 0: image only (default), 1: image and text, 2: text only

useCustomImage - if true, the button has to be placed in the editors "custom pics" folder

返回:

a button for the OpenCms editor

buttonActionCancel

public java.lang.String buttonActionCancel()

Returns the editor action for a "cancel" button.

This overwrites the cancel method of the CmsDialog class.

Always use this value, do not write anything directly in the html page.

返回:

the default action for a "cancel" button

buttonActionDirectEdit

public java.lang.String buttonActionDirectEdit(java.lang.String jsFunction,
                                      int type)

Builds the html to display the special action button for the direct edit mode of the editor.

参数:

jsFunction - the JavaScript function which will be executed on the mouseup event

type - 0: image only (default), 1: image and text, 2: text only

返回:

the html to display the special action button

checkLock

public void checkLock(java.lang.String resource,
             CmsLockType type)
               throws CmsException

从类复制的说明: CmsWorkplace

Checks the lock state of the resource and locks it if the autolock feature is enabled.

覆盖:

checkLock 在类中 CmsWorkplace

参数:

resource - the resource name which is checked

type - indicates the mode CmsLockType.EXCLUSIVE or CmsLockType.TEMPORARY

抛出:

CmsException - if reading or locking the resource fails

另请参阅:

CmsWorkplace.checkLock(String, CmsLockType)

deleteLocaleButton

public java.lang.String deleteLocaleButton(java.lang.String href,
                                  java.lang.String target,
                                  java.lang.String image,
                                  java.lang.String label,
                                  int type)

Generates a button for delete locale.

参数:

href - the href link for the button, if none is given the button will be disabled

target - the href link target for the button, if none is given the target will be same window

image - the image name for the button, skin path will be automatically added as prefix

label - the label for the text of the button

type - 0: image only (default), 1: image and text, 2: text only

返回:

a button for the OpenCms workplace

getEditorDisplayOptions

public CmsEditorDisplayOptions getEditorDisplayOptions()

Returns the instantiated editor display option class from the workplace manager.

This is a convenience method to be used on editor JSPs.

返回:

the instantiated editor display option class

getEditorResourceUri

public abstract java.lang.String getEditorResourceUri()

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

返回:

the URI to the editor resource folder

getOpenCmsContext

public java.lang.String getOpenCmsContext()

Returns the OpenCms request context path.

This is a convenience method to use in the editor.

返回:

the OpenCms request context path

getParamBacklink

public java.lang.String getParamBacklink()

Returns the back link when closing the editor.

返回:

the back link

getParamContent

public java.lang.String getParamContent()

Returns the content of the editor.

返回:

the content of the editor

getParamDirectedit

public java.lang.String getParamDirectedit()

Returns the direct edit flag parameter.

返回:

the direct edit flag parameter

getParamEditastext

public java.lang.String getParamEditastext()

Returns the edit as text parameter.

返回:

the edit as text parameter

getParamEditormode

public java.lang.String getParamEditormode()

Returns the editor mode parameter.

返回:

the editor mode parameter

getParamElementlanguage

public java.lang.String getParamElementlanguage()

Returns the current element language.

返回:

the current element language

getParamLoaddefault

public java.lang.String getParamLoaddefault()

Returns the "loaddefault" parameter to determine if the default editor should be loaded.

返回:

the "loaddefault" parameter

getParamModified

public java.lang.String getParamModified()

Returns the modified parameter indicating if the resource has been saved.

返回:

the modified parameter indicating if the resource has been saved

getParamOldelementlanguage

public java.lang.String getParamOldelementlanguage()

Returns the old element language.

返回:

the old element language

getParamTempfile

public java.lang.String getParamTempfile()

Returns the name of the temporary file.

返回:

the name of the temporary file

getPicsUri

public java.lang.String getPicsUri()

Returns the path to the images used by this editor.

返回:

the path to the images used by this editor

setParamBacklink

public void setParamBacklink(java.lang.String backLink)

Sets the back link when closing the editor.

参数:

backLink - the back link

setParamContent

public void setParamContent(java.lang.String content)

Sets the content of the editor.

参数:

content - the content of the editor

setParamDirectedit

public void setParamDirectedit(java.lang.String direct)

Sets the direct edit flag parameter.

参数:

direct - the direct edit flag parameter

setParamEditastext

public void setParamEditastext(java.lang.String editAsText)

Sets the edit as text parameter.

参数:

editAsText - "true" if the resource should be handled like a text file

setParamEditormode

public void setParamEditormode(java.lang.String mode)

Sets the editor mode parameter.

参数:

mode - the editor mode parameter

setParamElementlanguage

public void setParamElementlanguage(java.lang.String elementLanguage)

Sets the current element language.

参数:

elementLanguage - the current element language

setParamLoaddefault

public void setParamLoaddefault(java.lang.String loadDefault)

Sets the "loaddefault" parameter to determine if the default editor should be loaded.

参数:

loadDefault - the "loaddefault" parameter

setParamModified

public void setParamModified(java.lang.String modified)

Sets the modified parameter indicating if the resource has been saved.

参数:

modified - the modified parameter indicating if the resource has been saved

setParamOldelementlanguage

public void setParamOldelementlanguage(java.lang.String oldElementLanguage)

Sets the old element language.

参数:

oldElementLanguage - the old element language

setParamTempfile

public void setParamTempfile(java.lang.String fileName)

Sets the name of the temporary file.

参数:

fileName - the name of the temporary file

actionClose

protected void actionClose()
                    throws java.io.IOException,
                           javax.servlet.jsp.JspException,
                           javax.servlet.ServletException

Closes the editor and forwards to the workplace or the resource depending on the editor mode.

抛出:

java.io.IOException - if forwarding fails

javax.servlet.ServletException - if forwarding fails

javax.servlet.jsp.JspException - if including a JSP fails

clearEditorSessionInfo

protected void clearEditorSessionInfo()

Clears the editor session info bean.

commitTempFile

protected void commitTempFile()
                       throws CmsException

Writes the content of a temporary file back to the original file.

抛出:

CmsException - if something goes wrong

createTempFile

protected java.lang.String createTempFile()
                                   throws CmsException

Creates a temporary file which is needed while working in an editor with preview option.

返回:

the file name of the temporary file

抛出:

CmsException - if something goes wrong

decodeContent

protected java.lang.String decodeContent(java.lang.String content)

Decodes the given content the same way the client would do it.

Content is decoded as if it was encoded using the JavaScript "encodeURIComponent()" function.

参数:

content - the content to decode

返回:

the decoded content

decodeParamValue

protected java.lang.String decodeParamValue(java.lang.String paramName,
                                java.lang.String paramValue)

Decodes an individual parameter value, ensuring the content is always decoded in UTF-8.

For editors the content is always encoded using the JavaScript encodeURIComponent() method on the client, which always encodes in UTF-8.

覆盖:

decodeParamValue 在类中 CmsWorkplace

参数:

paramName - the name of the parameter

paramValue - the unencoded value of the parameter

返回:

the encoded value of the parameter

deleteTempFile

protected void deleteTempFile()

Deletes a temporary file from the OpenCms VFS, needed when exiting an editor.

encodeContent

protected java.lang.String encodeContent(java.lang.String content)

Encodes the given content so that it can be transfered to the client.

Content is encoded so that it is compatible with the JavaScript "decodeURIComponent()" function.

参数:

content - the content to encode

返回:

the encoded content

getCloneCms

protected CmsObject getCloneCms()
                         throws CmsException

Returns a cloned cms instance that prevents the time range resource filter check.

Use it always for unmarshalling and file writing.

返回:

a cloned cms instance that prevents the time range resource filter check

抛出:

CmsException - if something goes wrong

getEditorSessionInfo

protected CmsEditorSessionInfo getEditorSessionInfo()

Returns the editor session info bean.

返回:

the editor session info bean

getFileEncoding

protected java.lang.String getFileEncoding()

Returns the encoding parameter.

返回:

the encoding parameter

getFileEncoding

protected java.lang.String getFileEncoding(CmsObject cms,
                               java.lang.String filename)

Helper method to determine the encoding of the given file in the VFS, which must be set using the "content-encoding" property.

参数:

cms - the CmsObject

filename - the name of the file which is to be checked

返回:

the encoding for the file

initContent

protected abstract void initContent()

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

initMessages

protected void initMessages()

从类复制的说明: CmsWorkplace

Initializes the message object.

By default the CmsWorkplaceMessages are initialized.

You SHOULD override this method for setting the bundles you really need, using the CmsWorkplace.addMessages(CmsMessages) or CmsWorkplace.addMessages(String) method.

覆盖:

initMessages 在类中 CmsWorkplace

另请参阅:

CmsWorkplace.initMessages()

initSessionInfo

protected void initSessionInfo()

Initializes the editor session info bean.

setFileEncoding

protected void setFileEncoding(java.lang.String value)

Sets the encoding parameter.

参数:

value - the encoding value to set

showErrorPage

protected void showErrorPage(java.lang.Exception exception)
                      throws javax.servlet.jsp.JspException

Shows the selected error page in case of an exception.

参数:

exception - the current exception

抛出:

javax.servlet.jsp.JspException - if inclusion of the error page fails

showErrorPage

protected void showErrorPage(java.lang.Object editor,
                 java.lang.Exception exception)
                      throws javax.servlet.jsp.JspException

Shows the selected error page in case of an exception.

参数:

editor - initialized instance of the editor class

exception - the current exception

抛出:

javax.servlet.jsp.JspException - if inclusion of the error page fails