Package org.opencms.editors.codemirror
Class 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 org.opencms.workplace.editors.CmsSimpleEditor
Provides helper methods for the usage of the CodeMirror editor that can be used for syntax highlighting of text based files.
-
-
Field Summary
Fields Modifier and Type Field Description 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.-
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_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_ACTION_VALUE_FOR_CHANGED_INDEX, 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
-
Fields inherited from class org.opencms.workplace.tools.CmsToolDialog
PARAM_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW
-
Fields inherited from class org.opencms.workplace.CmsWorkplace
DEBUG, DEFAULT_DATE_STRING, 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, INPUT_DEFAULT, INPUT_NONE, JSP_WORKPLACE_URI, PARAM_DIRECTPUBLISH, PARAM_MODELFILE, PARAM_NEWRESOURCETYPE, PARAM_PUBLISHSIBLINGS, PARAM_RELATEDRESOURCES, PARAM_RESOURCELIST, PARAM_SUBRESOURCES, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, PARAM_WP_START, PARAM_WP_VIEW, 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_MODELDIALOG, VFS_PATH_MODULES, VFS_PATH_NEWRESOURCEDIALOG, VFS_PATH_RESOURCES, VFS_PATH_SITES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE, VIEW_ADMIN, VIEW_DIRECT_EDIT, VIEW_EXPLORER, VIEW_GALLERY, VIEW_LIST, VIEW_WORKPLACE
-
-
Constructor Summary
Constructors Constructor Description CmsCodeMirror(org.opencms.jsp.CmsJspActionElement jsp)
Public constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getEditorLanguage()
Returns the editor language to use according to the current users workplace settings.java.lang.String
getEditorResourceUri()
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()
void
setParamCloseFunction(java.lang.String closeFunction)
Sets the close function parameter.-
Methods inherited from class org.opencms.workplace.editors.CmsSimpleEditor
actionClear, actionExit, actionSave, decodeContentParameter, initContent, initWorkplaceRequestValues
-
Methods inherited from class 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
-
Methods inherited from class org.opencms.workplace.editors.CmsEditorBase
checkResourcePermissions, checkRole, initTimeWarp
-
Methods inherited from class org.opencms.workplace.CmsDialog
actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockHeaderBox, 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, openLaunchpad, openWorkplaceLink, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, setParamResource, setParamTitle
-
Methods inherited from class 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
-
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, canEditPermissionsForRoles, checkLock, fillParamValues, fillParamValues, generateCssStyle, generatePageEndExtended, generatePageEndSimple, generatePageStartExtended, generatePageStartSimple, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStartSiteRoot, getStartSiteRoot, getStaticResourceUri, getStaticResourceUri, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, getWorkplaceExplorerLink, getWorkplaceExplorerLink, getWorkplaceSettings, htmlEnd, initSettings, initUserSettings, initWorkplaceMembers, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, substituteSiteTitleStatic, switchToCurrentProject, switchToTempProject, updateUserPreferences
-
-
-
-
Field Detail
-
HIGHLIGHT_TYPE_CSS
public static final java.lang.String HIGHLIGHT_TYPE_CSS
Syntax highlight type name: CSS.- See Also:
- Constant Field Values
-
HIGHLIGHT_TYPE_HTML
public static final java.lang.String HIGHLIGHT_TYPE_HTML
Syntax highlight type name: HTML.- See Also:
- Constant Field Values
-
HIGHLIGHT_TYPE_JAVASCRIPT
public static final java.lang.String HIGHLIGHT_TYPE_JAVASCRIPT
Syntax highlight type name: JavaScript.- See Also:
- Constant Field Values
-
HIGHLIGHT_TYPE_JSP
public static final java.lang.String HIGHLIGHT_TYPE_JSP
Syntax highlight type name: JSP.- See Also:
- Constant Field Values
-
HIGHLIGHT_TYPE_XML
public static final java.lang.String HIGHLIGHT_TYPE_XML
Syntax highlight type name: XML.- See Also:
- Constant Field Values
-
PARAM_CLOSEFUNCTION
public static final java.lang.String PARAM_CLOSEFUNCTION
Request parameter name for the close function parameter.- See Also:
- Constant Field Values
-
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.- See Also:
- Constant Field Values
-
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.
-
-
Constructor Detail
-
CmsCodeMirror
public CmsCodeMirror(org.opencms.jsp.CmsJspActionElement jsp)
Public constructor.- Parameters:
jsp
- an initialized JSP action element
-
-
Method Detail
-
getEditorLanguage
public java.lang.String getEditorLanguage()
Returns the editor language to use according to the current users workplace settings.- Returns:
- the editor language to use
-
getEditorResourceUri
public java.lang.String getEditorResourceUri()
- Overrides:
getEditorResourceUri
in classorg.opencms.workplace.editors.CmsSimpleEditor
- See Also:
CmsSimpleEditor.getEditorResourceUri()
-
getHighlightMode
public java.lang.String getHighlightMode()
Returns the syntax highlighting type for the currently edited resource.- Returns:
- the syntax highlighting type
-
getParamCloseFunction
public java.lang.String getParamCloseFunction()
Returns the close function parameter.- Returns:
- the close function parameter
-
setParamCloseFunction
public void setParamCloseFunction(java.lang.String closeFunction)
Sets the close function parameter.- Parameters:
closeFunction
- the close function parameter
-
initMessages
protected void initMessages()
- Overrides:
initMessages
in classorg.opencms.workplace.editors.CmsEditor
- See Also:
CmsEditor.initMessages()
-
-