inputRichText (Liferay Faces Portal View Description Language Documentation (VDLDoc))

Description:

InputRichText is a UIInput component that renders a field for editing rich text.

Since:

2.0.0

Example usage of this component can be found at:

http://www.liferayfaces.org/web/guest/portal-showcase/-/portal-tag/portal/inputrichtext/general

Component Information
Info	Value
Component Type	`com.liferay.faces.portal.component.inputrichtext.InputRichText`
Handler Class	None
Renderer Type	`com.liferay.faces.portal.component.inputrichtext.InputRichTextRenderer`
Description	None

Attributes
Name	Required	Type	Description
`binding`	`false`	`javax.el.ValueExpression` (must evaluate to `javax.faces.component.UIComponent`)	An EL expression that binds the Java reference to this component in the component tree to a bean property.
`configParams`	`false`	`javax.el.ValueExpression` (must evaluate to `java.util.Map<String,String>`)	Optional map of configuration parameters. For example usage, see the Wiki portlet editor_config.jsp source code.
`contentsLanguageId`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The locale (language id) of the rich text content.
`converter`	`false`	`javax.el.ValueExpression` (must evaluate to `javax.faces.convert.Converter`)	The class name of the converter instance that is to be used by this component.
`converterMessage`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	This message or the result of the specified expression, will be used as the text of the converter message instead of any message that comes from the registered converter for this component.
`editorKey`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Liferay Portal property key name (typically found in portal.properties or portal-ext.properties). Valid property key values are "ckeditor", "ckeditor_bbcode", and "ckeditor_creole". The default key name is "editor.wysiwyg.default" which has a value of "ckeditor".
`fileBrowserParams`	`false`	`javax.el.ValueExpression` (must evaluate to `java.util.Map<String,String>`)	Optional map of file browser parameters. For example usage, see the Wiki portlet editor_config.jsp source code.
`id`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A unique identifier for this component.
`immediate`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	When this flag is true, this component's value must be converted and validated (immediately) during the Apply Request Values phase, instead of (later) during the PROCESS_VALIDATIONS phase.
`label`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A localized label for this component that is typically only rendered in a FacesMessage when validation fails.
`maxPlainTextChars`	`false`	`javax.el.ValueExpression` (must evaluate to `int`)	The maximum number of plain text characters, meaning characters that do not include HTML tags such as `<strong>`, `<em>`, and `<a href="...">`. The default value is `Integer.MAX_VALUE`.
`minPlainTextChars`	`false`	`javax.el.ValueExpression` (must evaluate to `int`)	The minimum number of plain text characters, meaning characters that do not include HTML tags such as `<strong>`, `<em>`, and `<a href="...">`. The default value is `0`.
`onblur`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute after this component loses focus.
`onchange`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute after this component's value has changed, and then it loses focus.
`onfocus`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when this component gets focus.
`rendered`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	When this flag is true, this component will be rendered to there response. When false, it will not be rendered to the response. The default value is `true`.
`required`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	When this flag is true, and a value has not been specified for this component, then the PROCESS_VALIDATIONS phase will fail and a FacesMessage will be added to the FacesContext for this component.
`requiredMessage`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	This message or the result of the specified expression, will be used as the text of the validation error message instead of any message that comes from the resulting validation error for this component when required="true" and no value is selected by the user.
`resizable`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	When true, the will be resizable by the end-user when dragging on the bottom-right resize handle. The default value is `true`.
`skipEditorLoading`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	When true, the resources necessary for loading the CKEditor will not be added to the `<head>...</head>` section of the portal page. The default value is `false`.
`style`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying the css style of the element.
`styleClass`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	List of CSS class names (separated by spaces) that are to be rendered within the class attribute.
`toolbarSet`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The name of the set of toolbars that are to be displayed above the rich text input area. Valid values include: bbcode creole editInPlace email liferay liferayArticle phone simple tablet The default value depends on the value of the editorKey attribute. If editorKey's property evaluates to "ckeditor" then the default value is "liferay". If editorKey's property evaluates to "ckeditor_bbcode" then the default value is "bbcode". If editorKey's property evaluates to "ckeditor_creole" then the default value is "creole".
`validator`	`false`	`javax.el.MethodExpression` (signature must match `void validate(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)`)	A method that is executed in the PROCESS_VALIDATIONS phase of the lifecycle. The method must be `public`, return `void`, and take three arguments of `FacesContext`, `UIComponent`, and `Object`.
`validatorMessage`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	This message or the result of the specified expression, will be used as the text of the validation error message instead of any message that comes from the resulting validation error for this component.
`value`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Object`)	The value of this component, which is typically bound via EL to a model bean property.
`valueChangeListener`	`false`	`javax.el.MethodExpression` (signature must match `void valueChange(javax.faces.event.ValueChangeEvent)`)	A method that is executed when the value of this component changes. The method must be `public`, return `void`, and take no arguments or one argument of `ValueChangeEvent`.

portal

Tag inputRichText