ICEfaces Component Suite
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
    FCKConfig.ToolbarSets["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. Copy the fck_editorarea.css from the FCKeditor distribution to your app and customize it(e.g.) css/fck_editorarea.css

  2. Create a config file under the webapp, overriding the "FCKConfig.EditorAreaCSS" property(e.g.) js/config.js
    FCKConfig.EditorAreaCSS = 'http://'+ window.location.host +'/'+window.location.pathname.split("/")[1]+'/css/fck_editorarea.css' ;

  3. Set the "customConfigPath" attribute to reference the custom config.js.(e.g.)
    <ice:inputRichText customConfigPath="js/config.js"/>


Tag Information
Tag Classcom.icesoft.faces.component.inputrichtext.InputRichTextTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
bindingfalsefalsejava.lang.String The value binding expression linking this component to a property in a backing bean
converterfalsefalsejava.lang.String Converter instance registered with this component.
customConfigPathfalsefalsejava.lang.String This attribute defines the path of the custom config file, the path is relative to the web app.
disabledfalsefalsejava.lang.String Disable the component
forfalsefalsejava.lang.String The for attribute references the id of the inputRichText which toolbarOnly attribute is set to "true".
heightfalsefalsejava.lang.String height.
idfalsefalsejava.lang.String The component identifier for this component. This value must be unique within the closest parent component that is a naming container.
immediatefalsefalsejava.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.
languagefalsefalsejava.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-uk)
  • 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)

renderedfalsefalsejava.lang.String Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.
requiredfalsefalsejava.lang.String Flag indicating that the user is required to provide a submitted value for this input component.
saveOnSubmitfalsefalsejava.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.
skinfalsefalsejava.lang.String

The following skins can be set to the component.

  • default
  • office2003
  • silver

stylefalsefalsejava.lang.String CSS style(s) to be applied when this component is rendered.
styleClassfalsefalsejava.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
toolbarfalsefalsejava.lang.String There are two valid values for this field and its case sensitive.
  • Default
  • Basic
validatorfalsefalsejava.lang.String MethodBinding 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.
valuefalsefalsejava.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.

valueChangeListenerfalsefalsejava.lang.StringNo Description
widthfalsefalsejava.lang.String Width.

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.