Overview | Library | Tag | Help
| FRAMES NO FRAMES

## ICEfaces-EE ACE Components
Tag richTextEntry

RichTextEntry uses the CKEditor API to provide JSF based rich text editor component.

For more information, see the RichTextEntry Wiki Documentation.

Client Events
Name | Description | Supported classes for argument
save | Fired when the 'Save' button is clicked and the contents of the editor are saved. | javax.faces.event.AjaxBehaviorEvent
blur | Fired any time the editor loses focus. | javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

Tag Information
Tag Class | org.icefaces.ace.component.richtextentry.RichTextEntryTag
TagExtraInfo Class | None
Body Content | JSP
Display Name | None

Attributes
Name | Required | Request-time | Type | Description
autogrow | no | true | `boolean` | Enabling this behaviour will automatically expand and shrink vertically the editor, depending on the amount and size of the content. Customize the maximum and minimum heights, as well as the buffer space, via the attributes 'autogrowMinHeight', 'autogrowMaxHeight', and 'autogrowBufferSpace'. Default = 'false'.
autogrowBufferSpace | no | true | `int` | When the autogrow behaviour is enabled, this is the vertical space between the last line of content in the editing area and the editor's footer, in pixels (when the editing area is taller than the minimum height). Default = '50'.
autogrowMaxHeight | no | true | `int` | When the autogrow behaviour is enabled, the editing area will be no taller than the amount specified by this attribute, in pixels. A value of 0 indicates that there is no set limit. This and the 'autogrowMinHeight' attributes override the regular 'height' attribute. Default = '0'.
autogrowMinHeight | no | true | `int` | When the autogrow behaviour is enabled, the editing area will be no shorter than the amount specified by this attribute, in pixels. This and the 'autogrowMaxHeight' attributes override the regular 'height' attribute. Default = '300'.
binding | no | true | `javax.el.ValueExpression` | Using an EL expression, bind the component reference to a bean property, so that the component may be accessed in the bean.
converter | no | true | `javax.faces.convert.Converter` | Converter is an interface describing a Java class that can perform Object-to-String and String-to-Object conversions between model data objects and a String representation of those objects that is suitable for rendering.
converterMessage | no | true | `java.lang.String` | If present, will be used as the text of the converter message, replacing any message that comes from the converter.
customConfigPath | no | true | `java.lang.String` | This attribute defines the path of the custom config file, the path is relative to the web app.
disabled | no | true | `boolean` | Boolean value to disable the editor functions. Default = 'false'.
height | no | true | `java.lang.String` | The height of the editable area only. It can be expressed in px and em units (percent units (%) are not supported). If no unit is specified, the value is assumed to be in pixels. Default = '200px'.
id | no | true | `java.lang.String` | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.
immediate | no | true | `boolean` | A flag indicating that conversion and validation of this component's value should occur during Apply Request Values phase instead of Process Validations phase. Default = 'false'.
language | no | true | `java.lang.String` | Specifies the language to be used for the user interface. Default = 'en'.
rendered | no | true | `boolean` | Return true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. Default = 'true'.
required | no | true | `boolean` | A flag indicating whether the user required to provide a non-empty submitted value for this component. Default = 'false'.
requiredMessage | no | true | `java.lang.String` | If present, will be used as the text of the validation message for the "required" facility, if the "required" facility is used.
saveOnSubmit | no | true | `boolean` | By default the data of the editor will only be saved when its 'Save' button is clicked. Any other submit request will not save its data. In order to save its data on any submit request like inputText does, this attribute can be set to true. Default = 'false'.
skin | no | true | `java.lang.String` | Specify the pre-defined skin for the editor. Possible values are 'moono', 'moonocolor', 'moonodark', 'moonoblue', 'moonolisa', 'office2013', 'kama', and 'bootstrap' for all browsers, except for IE7 (which uses a previous editor version). Possible values for IE7 are 'v2', 'office2003', and 'kama' ('default' is synonymous of 'moono' for all browsers except for IE7 and 'v2' for IE7). Default = 'default'.
style | no | true | `java.lang.String` | Inline CSS styling for the editor.
styleClass | no | true | `java.lang.String` | The CSS style class of the editor.
toolbar | no | true | `java.lang.String` | Specifies the type of toolbar. There are two valid values for this field (case sensitive): 'Default' and 'Basic'. Default = 'Default'.
validator | no | true | `javax.el.MethodExpression` | MethodExpression representing a validator method that will be called during Process Validations to perform correctness checks on the value of this component. The expression must evaluate to a public method that takes FacesContext, UIComponent, and Object parameters, with a return type of void.
validatorMessage | no | true | `java.lang.String` | If present, will be used as the text of the validator message, replacing any message that comes from the validator.
value | no | true | `java.lang.Object` | The current value of the simple component. The value to be rendered.
valueChangeListener | no | true | `javax.el.MethodExpression` | MethodExpression representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a `ValueChangeEvent` parameter, with a return type of void, or to a public method that takes no arguments with a return type of void. In the latter case, the method has no way of easily knowing what the new value is, but this can be useful in cases where a notification is needed that "this value changed".
width | no | true | `java.lang.String` | The width of the entire editor. It can be expressed in px, em, and % units. If no unit is specified, the value is assumed to be in pixels. Default = '100%'.

Variables
| No Variables Defined.

Overview | Library | Tag | Help
| FRAMES NO FRAMES

Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.