| Info | Value |
|---|---|
| Component Type | org.primefaces.extensions.component.CodeMirror |
| Handler Class | None |
| Renderer Type | None |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
accesskey | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Access key to transfer focus to the input element. |
allowBlocks | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Whether to allow blocks to be included when secure=true and the HTML is sanitized.Default is true. |
allowFormatting | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Whether to allow formatting to be included when secure=true and the HTML is sanitized.Default is true. |
allowImages | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Whether to allow images to be included when secure=true and the HTML is sanitized.Default is true. |
allowLinks | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Whether to allow links to be included when secure=true and the HTML is sanitized.Default is true. |
allowMedia | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Whether to allow audio/video to be included when secure=true and the HTML is sanitized.Default is true. |
allowStyles | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Whether to allow styles to be included when secure=true and the HTML is sanitized.Default is true. |
allowTables | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Whether to allow tables to be included when secure=true and the HTML is sanitized.Default is true. |
ariaDescribedBy | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Identifies the element(s) that describe the object, enhancing accessibility. |
async | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When set to true, ajax requests are not queued. Default value: false.Default is false. |
binding | false | jakarta.el.ValueExpression
(must evaluate to jakarta.faces.component.UIComponent)
| An EL expression referring to a server side UIComponent instance in a backing bean.Default is generated. |
cols | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Default is 0. |
completeMethod | false | jakarta.el.ValueExpression
(must evaluate to jakarta.el.MethodExpression)
| Method providing suggestions. |
converter | false | jakarta.el.ValueExpression
(must evaluate to jakarta.faces.convert.Converter)
| EL expression resolves to a converter instance or literal converter ID defining a component converter. |
converterMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Custom message to display when conversion fails. |
dir | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Direction indication for text that does not inherit directionality.Default is ltr. |
disabled | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Specifies that an element should be disabled.Default is false. |
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.Default is true. |
escapeSuggestions | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if the suggestions should be escaped or not.Default is true. |
extender | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The extender to use for the editor. |
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.Default is false. |
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 is 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.Default is false. |
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer.Default is generated. |
immediate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When set true, process validations logic is executed at apply request values phase for this component.Default is false. |
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. |
indentWithTabs | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If Set false, indent using spaces instead of tabs.Default is true. |
inputmode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Specifies the type of data expected in the input, aiding virtual keyboards. |
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 localized user presentable name. |
lang | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Specifies the language of the element's content. |
lineNumbers | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Whether to show line numbers to the left of the editor.Default is false. |
lineWrapping | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Whether CodeMirror should scroll or wrap for long lines.Default is false. |
matchBrackets | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Determines whether brackets are matched whenever the cursor is moved next to a bracket.Default is false. |
maxlength | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Defines the maximum number of characters allowed in the input.Default is Integer.MIN_VALUE. |
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)
| Fires when an element loses focus. |
onchange | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Fires when the value of an element has been changed. |
onclick | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Fires when a mouse click on the element. |
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)
| Script to execute when the context menu is triggered. |
oncopy | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when content is copied from the element. |
oncut | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when content is cut from the element. |
ondblclick | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Fires when a mouse double-click on the element. |
ondrag | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when an element is dragged. |
ondragend | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute at the end of a drag operation. |
ondragenter | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when a dragged element enters a valid drop target. |
ondragleave | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when a dragged element leaves a valid drop target. |
ondragover | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when a dragged element is over a valid drop target. |
ondragstart | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute at the start of a drag operation. |
ondrop | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when a dragged element is 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)
| Fires when an element gets focus. |
oninput | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when the element receives user input. |
oninvalid | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when the element's value is invalid. |
onkeydown | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Fires when a user is pressing a key. |
onkeypress | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Fires when a user presses a key. |
onkeyup | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Fires when a user releases a key. |
onmousedown | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Fires when a mouse button is pressed down on an element. |
onmousemove | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Fires when the mouse pointer is moving while it is over an element. |
onmouseout | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Fires when the mouse pointer moves out of an element. |
onmouseover | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Fires when the mouse pointer moves onto an element. |
onmouseup | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Fires when a mouse button is released over an element. |
onpaste | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when content is pasted into the element. |
onreset | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when the form is reset. |
onscroll | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when the element is scrolled. |
onsearch | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when a search is performed. |
onselect | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when text is selected. |
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)
| Script to execute when the mouse wheel is used. |
placeholder | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Specifies a short hint describing the expected value of the input. |
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 millis. |
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)
| Specifies that an input field is read-only.Default is false. |
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.Default is true. |
required | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Marks component as required.Default is false. |
requiredMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Custom message to display when the required validation fails. |
role | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines the role of the element for accessibility purposes. |
rows | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Default is 0. |
secure | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Secure the component with the HTML Sanitizer library on the classpath.Default is true. |
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).Default is true. |
style | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Specifies an inline CSS style for an element. |
styleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Specifies one or more CSS class names for an element. |
tabindex | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Specifies the tab order of an element. |
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. |
title | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Specifies extra information about an element (displayed as a tooltip). |
toolbar | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The toolbar to use for the editor. |
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 jakarta.faces.validator.Validator)
| A method expression referring to a method validating the input. |
validatorMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Custom message to display when validation fails. |
value | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Value of the component. |
valueChangeListener | false | jakarta.el.ValueExpression
(must evaluate to jakarta.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. 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. 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.