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
NameDescriptionSupported classes for argument
saveFired when the 'Save' button is clicked and the contents of the editor are saved.javax.faces.event.AjaxBehaviorEvent
blurFired 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 Classorg.icefaces.ace.component.richtextentry.RichTextEntryTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
bindingnotruejavax.el.ValueExpressionUsing an EL expression, bind the component reference to a bean property, so that the component may be accessed in the bean.
converternotruejavax.faces.convert.ConverterConverter 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.
converterMessagenotruejava.lang.StringIf present, will be used as the text of the converter message, replacing any message that comes from the converter.
customConfigPathnotruejava.lang.StringThis attribute defines the path of the custom config file, the path is relative to the web app.
disablednotruebooleanBoolean value to disable the editor functions. Default = 'false'.
heightnotruejava.lang.StringThe 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'.
idnotruejava.lang.StringThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.
immediatenotruebooleanA 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'.
languagenotruejava.lang.StringSpecifies the language to be used for the user interface. Default = 'en'.
renderednotruebooleanReturn true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. Default = 'true'.
requirednotruebooleanA flag indicating whether the user required to provide a non-empty submitted value for this component. Default = 'false'.
requiredMessagenotruejava.lang.StringIf present, will be used as the text of the validation message for the "required" facility, if the "required" facility is used.
saveOnSubmitnotruebooleanBy 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'.
skinnotruejava.lang.StringSpecify the pre-defined skin for the editor. This will only set the skin for IE7 browsers (which use a previous editor version). All other browsers will use the 'moono' skin. Possible values for IE7 are 'v2', 'office2003', and 'kama' ('default' is synonymous of 'v2'). Default = 'default'.
stylenotruejava.lang.StringInline CSS styling for the editor.
styleClassnotruejava.lang.StringThe CSS style class of the editor.
toolbarnotruejava.lang.StringSpecifies the type of toolbar. There are two valid values for this field (case sensitive): 'Default' and 'Basic'. Default = 'Default'.
validatornotruejavax.el.MethodExpressionMethodExpression 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.
validatorMessagenotruejava.lang.StringIf present, will be used as the text of the validator message, replacing any message that comes from the validator.
valuenotruejava.lang.ObjectThe current value of the simple component. The value to be rendered.
valueChangeListenernotruejavax.el.MethodExpressionMethodExpression 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".
widthnotruejava.lang.StringThe 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.


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.