org.opencms.editors.codemirror

类 CmsCodeMirror

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.CmsSimpleEditor

org.opencms.editors.codemirror.CmsCodeMirror

public class CmsCodeMirror
extends CmsSimpleEditor

Provides helper methods for the usage of the CodeMirror editor that can be used for syntax highlighting of text based files.

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	HIGHLIGHT_TYPE_CSS Syntax highlight type name: CSS.
static java.lang.String	HIGHLIGHT_TYPE_HTML Syntax highlight type name: HTML.
static java.lang.String	HIGHLIGHT_TYPE_JAVASCRIPT Syntax highlight type name: JavaScript.
static java.lang.String	HIGHLIGHT_TYPE_JSP Syntax highlight type name: JSP.
static java.lang.String	HIGHLIGHT_TYPE_XML Syntax highlight type name: XML.
protected static java.lang.String[]	HIGHLIGHT_TYPES Possible type suffix names.
protected static java.util.List<java.lang.String>	HIGHLIGHT_TYPES_LIST Possible type suffix names as list.
static java.lang.String	PARAM_CLOSEFUNCTION Request parameter name for the close function parameter.
protected static java.lang.String	SUBPATH_CODEMIRROR Sub path fragment to the editor resources.
protected static java.lang.String	VFS_PATH_EDITOR Path to the editor resources.
protected static java.lang.String	VFS_PATH_EDITOR_DIST Path to the editor distribution resources.

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

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

构造器概要

构造器

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

方法概要

方法

限定符和类型	方法和说明
java.lang.String	getEditorLanguage() Returns the editor language to use according to the current users workplace settings.
java.lang.String	getEditorResourceUri() Returns the URI to the editor resource folder where button images and javascripts are located.
java.lang.String	getHighlightMode() Returns the syntax highlighting type for the currently edited resource.
java.lang.String	getParamCloseFunction() Returns the close function parameter.
protected void	initMessages() Initializes the message object.
void	setParamCloseFunction(java.lang.String closeFunction) Sets the close function parameter.

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

actionClear, actionExit, actionSave, decodeContentParameter, initContent, initWorkplaceRequestValues

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

actionClose, buildSelectElementLanguage, button, buttonActionCancel, buttonActionDirectEdit, checkLock, clearEditorSessionInfo, commitTempFile, createTempFile, decodeContent, decodeParamValue, deleteLocaleButton, deleteTempFile, encodeContent, getCloneCms, getEditorDisplayOptions, getEditorSessionInfo, getFileEncoding, getFileEncoding, getOpenCmsContext, getParamBacklink, getParamContent, getParamDirectedit, getParamEditastext, getParamEditormode, getParamElementlanguage, getParamLoaddefault, getParamModified, getParamOldelementlanguage, getParamTempfile, getPicsUri, 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, 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

字段详细资料

HIGHLIGHT_TYPE_CSS

public static final java.lang.String HIGHLIGHT_TYPE_CSS

Syntax highlight type name: CSS.

另请参阅:

常量字段值

HIGHLIGHT_TYPE_HTML

public static final java.lang.String HIGHLIGHT_TYPE_HTML

Syntax highlight type name: HTML.

另请参阅:

常量字段值

HIGHLIGHT_TYPE_JAVASCRIPT

public static final java.lang.String HIGHLIGHT_TYPE_JAVASCRIPT

Syntax highlight type name: JavaScript.

另请参阅:

常量字段值

HIGHLIGHT_TYPE_JSP

public static final java.lang.String HIGHLIGHT_TYPE_JSP

Syntax highlight type name: JSP.

另请参阅:

常量字段值

HIGHLIGHT_TYPE_XML

public static final java.lang.String HIGHLIGHT_TYPE_XML

Syntax highlight type name: XML.

另请参阅:

常量字段值

PARAM_CLOSEFUNCTION

public static final java.lang.String PARAM_CLOSEFUNCTION

Request parameter name for the close function parameter.

另请参阅:

常量字段值

HIGHLIGHT_TYPES

protected static final java.lang.String[] HIGHLIGHT_TYPES

Possible type suffix names.

HIGHLIGHT_TYPES_LIST

protected static final java.util.List<java.lang.String> HIGHLIGHT_TYPES_LIST

Possible type suffix names as list.

SUBPATH_CODEMIRROR

protected static final java.lang.String SUBPATH_CODEMIRROR

Sub path fragment to the editor resources.

另请参阅:

常量字段值

VFS_PATH_EDITOR

protected static final java.lang.String VFS_PATH_EDITOR

Path to the editor resources.

另请参阅:

常量字段值

VFS_PATH_EDITOR_DIST

protected static final java.lang.String VFS_PATH_EDITOR_DIST

Path to the editor distribution resources.

另请参阅:

常量字段值

构造器详细资料

CmsCodeMirror

public CmsCodeMirror(CmsJspActionElement jsp)

Public constructor.

参数:

jsp - an initialized JSP action element

方法详细资料

getEditorLanguage

public java.lang.String getEditorLanguage()

Returns the editor language to use according to the current users workplace settings.

返回:

the editor language to use

getEditorResourceUri

public java.lang.String getEditorResourceUri()

从类复制的说明: CmsEditor

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

覆盖:

getEditorResourceUri 在类中 CmsSimpleEditor

返回:

the URI to the editor resource folder

另请参阅:

CmsSimpleEditor.getEditorResourceUri()

getHighlightMode

public java.lang.String getHighlightMode()

Returns the syntax highlighting type for the currently edited resource.

返回:

the syntax highlighting type

getParamCloseFunction

public java.lang.String getParamCloseFunction()

Returns the close function parameter.

返回:

the close function parameter

setParamCloseFunction

public void setParamCloseFunction(java.lang.String closeFunction)

Sets the close function parameter.

参数:

closeFunction - the close function parameter

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 在类中 CmsEditor

另请参阅:

CmsEditor.initMessages()