| Info | Value |
|---|---|
| Component Type | org.primefaces.extensions.component.CodeMirror |
| Handler Class | org.primefaces.extensions.component.codemirror.CodeMirrorHandler |
| Renderer Type | org.primefaces.extensions.component.CodeMirrorRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
async | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When set to true, ajax requests are not queued. Default value: false. |
binding | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| An EL expression referring to a server side UIComponent instance in a backing bean. |
completeMethod | false | jakarta.el.ValueExpression
(must evaluate to javax.el.MethodExpression)
| Method providing suggestions. |
converter | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.convert.Converter)
| An EL expression or a literal text that defines a converter for the component. When it's an EL expression, it's resolved to a converter instance. In case it's a static text, it must refer to a converter id. |
electricChars | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Configures whether the editor should re-indent the current line when a character is typed that might change its proper indentation (only works if the mode supports indentation). Default is true. |
escape | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if the content of the component should be escaped or not. |
escapeSuggestions | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if the suggestions should be escaped or not. |
extraKeys | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Can be used to specify extra keybindings for the editor. When given, should be an object with property names like Ctrl-A, Home, and Ctrl-Alt-Left. |
firstLineNumber | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| At which number to start counting lines. Default is 1. |
fixedGutter | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When enabled (off by default), this will make the gutter stay visible when the document is scrolled horizontally. |
global | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Global ajax requests are listened by ajaxStatus component, setting global to false will not trigger ajaxStatus. Default value: true. |
gutter | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Can be used to force a 'gutter' (empty space on the left of the editor) to be shown even when no line numbers are active. This is useful for setting markers. |
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a naming container. |
indentUnit | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| How many spaces a block (whatever that means in the edited language) should be indented. The default is 2. |
inputmode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| HTML5 inputmode attribute for hinting at the type of data this control has for touch devices to display appropriate virtual keyboard. |
keyMap | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Configures the keymap to use. The default is "default", which is the only keymap defined in codemirror.js itself. Extra keymaps are found in the keymap directory. |
label | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| A display name for this component. |
lineNumbers | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Whether to show line numbers to the left of the editor. |
lineWrapping | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Whether CodeMirror should scroll or wrap for long lines. Defaults to false (scroll). |
matchBrackets | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Determines whether brackets are matched whenever the cursor is moved next to a bracket. |
mode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The mode to use. When not given, this will default to the first mode that was loaded. It may be a string, which either simply names the mode or is a MIME type associated with the mode. Alternatively, it may be an object containing configuration options for the mode, with a name property that names the mode (for example {name: "javascript", json: true}). |
onblur | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when input element loses focus. |
onchange | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when input element loses focus and its value has been modified since gaining focus. |
onclick | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when input element is clicked. |
oncomplete | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript handler to execute when ajax request is completed. |
oncontextmenu | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a context menu is triggered. |
oncopy | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when the user cuts the content of an element. |
oncut | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when the user copies the content of an element. |
ondblclick | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when input element is double-clicked. |
ondrag | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an element is dragged. |
ondragend | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute at the end of a drag operation. |
ondragenter | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an element has been dragged to a valid drop target. |
ondragleave | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an element leaves a valid drop target. |
ondragover | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an element is being dragged over a valid drop target. |
ondragstart | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute at the start of a drag operation. |
ondrop | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when dragged element is being dropped. |
onerror | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript handler to execute when ajax request fails. |
onfocus | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when input element receives focus. |
oninput | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an element gets user input. |
oninvalid | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an element is invalid. |
onkeydown | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a key is pressed down over input element. |
onkeypress | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a key is pressed and released over input element. |
onkeyup | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a key is released over input element. |
onmousedown | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer input element is pressed down over input element. |
onmousemove | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer input element is moved within input element. |
onmouseout | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer input element is moved away from input element. |
onmouseover | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer input element is moved onto input element. |
onmouseup | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer input element is released over input element. |
onpaste | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when the user pastes some content in an element. |
onreset | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when the Reset button in a form is clicked. |
onscroll | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an element's scrollbar is being scrolled. |
onsearch | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when the user writes something in a search field. |
onselect | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when text within input element is selected by user. |
onstart | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript handler to execute before ajax request is begins. |
onsuccess | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript handler to execute when ajax request succeeds. |
onwheel | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when the mouse wheel rolls up or down over an element. |
pollInterval | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Indicates how quickly CodeMirror should poll its input textarea for changes. Most input is captured by events, but some things, like IME input on some browsers, doesn't generate events that allow CodeMirror to properly detect it. Thus, it polls. Default is 100 milliseconds. |
process | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Component(s) to process partially instead of whole view. |
readonly | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| This disables editing of the editor content by the user. If the special value "nocursor" is given (instead of simply true), focusing of the editor is also disallowed. |
rendered | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Boolean value to specify the rendering of the component, when set to false component will not be rendered. |
required | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Marks component as required. |
requiredMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when required field validation fails. |
smartIndent | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Whether to use the context-sensitive indentation that the mode provides (or just indent the same as the line before). Defaults to true. |
tabindex | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The tab index to assign to the editor. If not given, no tab index will be assigned. |
tabSize | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| The width of a tab character. Defaults to 4. |
theme | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The theme to style the editor with. |
undoDepth | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| The maximum number of undo levels that the editor stores. Defaults to 40. |
validator | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.validator.Validator)
| A method expression referring to a method validationg the input. |
value | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Value of the component. |
valueChangeListener | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.event.ValueChangeListener)
| A method binding expression referring to a method for handling a valuchangeevent. |
widgetVar | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
workDelay | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Highlighting is done by a pseudo background-thread that will work for workTime milliseconds, and then use timeout to sleep for workDelay milliseconds. The defaults are 200 and 300, you can change these options to make the highlighting more or less aggressive. |
workTime | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Highlighting is done by a pseudo background-thread that will work for workTime milliseconds, and then use timeout to sleep for workDelay milliseconds. The defaults are 200 and 300, you can change these options to make the highlighting more or less aggressive. |
Output generated by Vdldoc View Declaration Language Documentation Generator.