Overview     Library     Tag     Help  
  FRAMES     NO FRAMES  

rich
Tag editor

The <rich:editor> component is used for creating a WYSIWYG editor on a page.

@author Lukas Fryc

Tag Information
Component type org.richfaces.Editor
Tag Name rich:editor
Renderer Type org.richfaces.EditorRenderer
Handler Class None

Attributes
Name Required Type Description
binding false javax.faces.component.UIComponent The value binding expression used to wire up this component to a component property of a JavaBean class
config false javax.faces.component.UIComponent Detailed configuration of editor in JSON format
converter false javax.faces.convert.Converter Converter instance registered with this component.
converterMessage false java.lang.String A ValueExpression enabled attribute that, if present, will be used as the text of the converter message, replacing any message that comes from the converter.
height false java.lang.String The hieght of the editor
id false 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 false boolean Flag indicating that this component's value must be converted and validated immediately (that is, during Apply Request Values phase), rather than waiting until Process Validations phase.
lang false java.lang.String Code describing the language used in the generated markup for this component.
onblur false java.lang.String The client-side script method to be called when the editor loses focus
onchange false java.lang.String The client-side script method to be called on blur event when editor content has been changed after previous focus
ondirty false java.lang.String The client-side script method to be called immediately after the editor content has been changed
onfocus false java.lang.String The client-side script method to be called when the editor receives focus
oninit false java.lang.String The client-side script method to be called once the editor is initialized and ready to be handle user interaction
readonly false boolean Used to switch the editor into a read-only mode.
rendered false boolean Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true.
required false boolean Flag indicating that the user is required to provide a submitted value for this input component.
requiredMessage false java.lang.String A ValueExpression enabled attribute that, if present, will be used as the text of the validation message for the "required" facility, if the "required" facility is used.
skin false java.lang.String

Set the skin of the richfaces editor. Bundled skins include: richfaces, kama, v2, office2003

Default is richfaces
style false java.lang.String CSS style(s) to be applied when this component is rendered.
styleClass false java.lang.String Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.
title false java.lang.String Advisory title information about markup elements generated for this component.
toolbar false java.lang.String

Used to change the configuration of the toolbar's button set. There are two configurations available: basic (default), full (enables all of the features).

It is also possible to define a custom toolbar using the CKEditor toolbar configuration in a config facet

Default is basic

validator false javax.faces.el.MethodBinding 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 false java.lang.String A ValueExpression enabled attribute that, if present, will be used as the text of the validator message, replacing any message that comes from the validator.
value false java.lang.Object The current value of this component.
valueChangeListener false javax.faces.el.MethodBinding

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 false java.lang.String The width of the editor

  Overview     Library     Tag     Help  
  FRAMES     NO FRAMES  
Output Generated by Tag Library Documentation Generator.