Overview | Library | Tag | Help
| FRAMES NO FRAMES

## ICE Components
Tag inputRichText

The ICEfaces inputRichText component uses the FCKEditor API to provide JSF based rich text component.
The "customConfigPath" attribute can be used to defined the custom config.js where you can customize the FCKeditor including the custom toolbar and the css.

The following steps are involved in creating the custom toolbar:

1. Create a config file under the webapp, defining the custom toolbar(e.g.) js/config.js
   CKEDITOR.editorConfig = function( config )
   {
   config.toolbar = 'MyToolbar';
   config.toolbar_MyToolbar = [['Bold','Italic', 'Underline'], ['Save']];
   };
2. Set the "toolbar" attribute on the inputRichText component to define the custom toolbar name and set the "customConfigPath" attribute to reference the custom config.js.(e.g.)
   <ice:inputRichText toolbar="MyToolbar" customConfigPath="js/config.js"/>

The following steps are involved in defining the custom CSS:

1. create a customize css file(e.g.) css/mysitestyles.css
2. Create a config file under the webapp, overriding the "config.contentsCss" property(e.g.) js/config.js
   CKEDITOR.editorConfig = function( config )
   {
   config.contentsCss = '/css/mysitestyles.css';
   };
3. Set the "customConfigPath" attribute to reference the custom config.js.(e.g.)
   <ice:inputRichText customConfigPath="js/config.js"/>

Tag Information
Tag Class | com.icesoft.faces.component.inputrichtext.InputRichTextTag
TagExtraInfo Class | None
Body Content | JSP
Display Name | None

Attributes
Name | Required | Request-time | Type | Description
binding | false | false | `java.lang.String` | The value binding expression linking this component to a property in a backing bean
converter | false | false | `java.lang.String` | Converter instance registered with this component.
converterMessage | false | 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.
customConfigPath | false | false | `java.lang.String` | This attribute defines the path of the custom config file, the path is relative to the web app.
disabled | false | false | `java.lang.String` | Disable the component
for | false | false | `java.lang.String` | The for attribute references the id of the inputRichText which toolbarOnly attribute is set to "true".
height | false | false | `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.
id | false | 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 | false | `java.lang.String` | 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.
language | false | false | `java.lang.String` | The support of multi-language can use the following 54 languages. (e.g.) To set the French language use language="fr" Afrikaans (af) Arabic (ar) Basque (eu) Bengali/Bangla (bn) Bosnian (bs) Bulgarian (bg) Catalan (ca) Chinese Simplified (zh-cn) Chinese Traditional (zh) Croatian (hr) Czech (cs) Danish (da) Dutch (nl) English (en) English (Australia) (en-au) English (Canadian) (en-ca) English (United Kingdom) (en-gb) Esperanto (eo) Estonian (et) Faroese (fo) Finnish (fi) French (fr) Galician (gl) German (de) Greek (el) Hebrew (he) Hindi (hi) Hungarian (hu) Italian (it) Japanese (ja) Khmer (km) Korean (ko) Latvian (lv) Lithuanian (lt) Malay (ms) Mongolian (mn) Norwegian (no) Norwegian Bokmal (nb) Persian (fa) Polish (pl) Portuguese (Brazil) (pt-br) Portuguese (Portugal) (pt) Romanian (ro) Russian (ru) Serbian (Cyrillic) (sr) Serbian (Latin) (sr-latn) Slovak (sk) Slovenian (sl) Spanish (es) Swedish (sv) Thai (th) Turkish (tr) Ukrainian (uk) Vietnamese (vi)
partialSubmit | false | false | `java.lang.String` | Whether a full or partialSubmit is used by the save button on the toolbar. partialSubmit won't be used when saveOnSubmit=true. Default value is false.
rendered | false | false | `java.lang.String` | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.
required | false | false | `java.lang.String` | Flag indicating that the user is required to provide a submitted value for this input component.
requiredMessage | false | 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.
saveOnSubmit | false | false | `java.lang.String` | By default the data of the inputRichText will only be saved, when its "save" button being 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.
skin | false | false | `java.lang.String` | Specify 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').
style | false | false | `java.lang.String` | CSS style(s) to be applied when this component is rendered.
styleClass | false | 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. The base name for all style classes. Default value is iceInpRchTxt
toolbar | false | false | `java.lang.String` | There are two valid values for this field and its case sensitive. Default Basic
validator | false | false | `java.lang.String` | 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 | 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 | false | `java.lang.String` | The current value of this component. All UIInput derived UIComponents, that are placed within a UIData container, such as a dataTable or panelSeries, should have their value attribute bound to a bean property via a ValueBinding/ValueExpression, since otherwise the UIData container will not keep their successfully validated state, which can cause the component to fail to function properly.
valueChangeListener | false | false | `java.lang.String` | No Description
width | false | false | `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.

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.