| Info | Value |
|---|---|
| Component Type | org.primefaces.extensions.component.SunEditor |
| 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. |
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)
| Defines the number of columns in the text area.Default is 0. |
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. |
extender | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The extender to use for the editor. |
height | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Height of the editor.Default is auto. |
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. |
inputmode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Specifies the type of data expected in the input, aiding virtual keyboards. |
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. |
locale | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Locale for the editor. Can be a string or java.util.Locale instance. |
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: 'classic', 'inline', etc.Default is classic. |
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. |
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. |
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. |
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. |
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)
| Defines the number of rows in the text area.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. |
strictMode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Whether to use strict mode.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. |
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. |
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. |
width | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Width of the editor.Default is 100%. |
Output generated by Vdldoc View Declaration Language Documentation Generator.