Summary
Tag name: <t:inputHtml>
UIComponent class: org.apache.myfaces.custom.inputHtml.InputHtml
Tag class: org.apache.myfaces.custom.inputHtml.InputHtmlTag
Component type: org.apache.myfaces.InputHtml
Component family: javax.faces.Input
Renderer type: org.apache.myfaces.InputHtml
Renderer class: org.apache.myfaces.custom.inputHtml.InputHtmlRenderer
HTML Editor using the kupu library.
http://kupu.oscom.org/
An inline HTML based word processor based on the Kupu library.
See http://kupu.oscom.org
Right now, the support is limited to one editor per page
(but you can use tabs to have multiple editors, but only
one rendered at a time).
Unless otherwise specified, all attributes accept static values or EL expressions.
Usage
<t:inputHtml value="String"
style="CSSClass"
fallback="{true|false}"
type="Constant"
allowExternalLinks="{true|false}"
addKupuLogo="{true|false}"
showAllToolBoxes="{true|false}"
allowEditSource="{true|false}"
showPropertiesToolBox="{true|false}"
showLinksToolBox="{true|false}"
showImagesToolBox="{true|false}"
showTablesToolBox="{true|false}"
showDebugToolBox="{true|false}"
showCleanupExpressionsToolBox="{true|false}"/>Attributes
| Name | Type | Supports EL? | Description |
|---|---|---|---|
| accesskey | String | Yes | HTML: Sets the access key for this element. |
| addKupuLogo | boolean | Yes | Show the Kupu Logo in the buttons bar. Default is true. |
| align | String | Yes | HTML: Specifies the horizontal alignment of this element. Deprecated in HTML 4.01. |
| allowEditSource | boolean | Yes | Allows the user to edit the HTML source code. Default is true. |
| allowExternalLinks | boolean | Yes | Allows the user to insert external links. Default is true. |
| alt | String | Yes | HTML: Specifies alternative text that can be used by a browser that can't show this element. |
| autocomplete | String | Yes | Non HTML standard attribute to disable browser's autocomplete function. |
| binding | String | Only EL | Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression. |
| converter | javax.faces.convert.Converter | Yes | The value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface. |
| datafld | String | Yes | Reserved for future use. |
| dataformatas | String | Yes | Reserved for future use. |
| datasrc | String | Yes | Reserved for future use. |
| dir | String | Yes | HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left). |
| disabled | boolean | Yes | HTML: When true, this element cannot receive focus. |
| disabledOnClientSide | boolean | Yes | If true the input is rendered disabled on the client side and a hidden input is used to actualy submit his value back to the server. |
| displayValueOnly | Boolean | Yes | If true, renders only the value of the component, but no input widget. Default is false. |
| displayValueOnlyStyle | String | Yes | Style used when displayValueOnly is true. |
| displayValueOnlyStyleClass | String | Yes | Style class used when displayValueOnly is true. |
| enabledOnUserRole | String | Yes | If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered. |
| fallback | String | Yes | Use a text area instead of the javascript HTML editor. Default is false. Use with caution. |
| forceId | boolean | No | If true, this component will force the use of the specified id when rendering. |
| forceIdIndex | boolean | No | If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.) |
| id | String | Yes | An identifier for this particular component instance within
a component view.
The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. |
| immediate | boolean | Yes | A boolean value that identifies the phase during which value change events should fire. During normal event processing, value change events are fired during the "process validations" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase. |
| lang | String | Yes | HTML: The base language of this document. |
| maxlength | int | Yes | HTML: The maximum number of characters allowed to be entered. |
| onblur | String | Yes | HTML: Specifies a script to be invoked when the element loses focus. |
| onchange | String | Yes | HTML: Specifies a script to be invoked when the element is modified. |
| onclick | String | Yes | HTML: Script to be invoked when the element is clicked. |
| ondblclick | String | Yes | HTML: Script to be invoked when the element is double-clicked. |
| onfocus | String | Yes | HTML: Specifies a script to be invoked when the element receives focus. |
| onkeydown | String | Yes | HTML: Script to be invoked when a key is pressed down over this element. |
| onkeypress | String | Yes | HTML: Script to be invoked when a key is pressed over this element. |
| onkeyup | String | Yes | HTML: Script to be invoked when a key is released over this element. |
| onmousedown | String | Yes | HTML: Script to be invoked when the pointing device is pressed over this element. |
| onmousemove | String | Yes | HTML: Script to be invoked when the pointing device is moved while it is in this element. |
| onmouseout | String | Yes | HTML: Script to be invoked when the pointing device is moves out of this element. |
| onmouseover | String | Yes | HTML: Script to be invoked when the pointing device is moved into this element. |
| onmouseup | String | Yes | HTML: Script to be invoked when the pointing device is released over this element. |
| onselect | String | Yes | HTML: Specifies a script to be invoked when the element is selected. |
| readonly | boolean | Yes | HTML: When true, indicates that this component cannot be modified by the user. The element may receive focus unless it has also been disabled. |
| rendered | boolean | Yes | A boolean value that indicates whether this component should be rendered. Default value: true. |
| required | boolean | Yes | A boolean value that indicates whether an input value is required. If this value is true, and no input value is provided, the error message javax.faces.component.UIInput.REQUIRED is posted. |
| showAllToolBoxes | boolean | Yes | Shortcut to avoid setting all the showXXToolBox to true. Default is false. |
| showCleanupExpressionsToolBox | boolean | Yes | Show the Cleanup Expressions tool box next to the text. Default is false. |
| showDebugToolBox | boolean | Yes | Show the Debug tool box next to the text. Default is false. |
| showImagesToolBox | boolean | Yes | Show the Images tool box next to the text. Default is false. |
| showLinksToolBox | boolean | Yes | Show the Links tool box next to the text. Default is false. |
| showPropertiesToolBox | boolean | Yes | Show the Properties tool box next to the text. Default is false. |
| showTablesToolBox | boolean | Yes | Show the Tables tool box next to the text. Default is false. |
| size | int | Yes | HTML: The initial width of this control, in characters. |
| style | String | Yes | HTML: CSS styling instructions. |
| styleClass | String | Yes | The CSS class for this element. Corresponds to the HTML 'class' attribute. |
| tabindex | String | Yes | HTML: Specifies the position of this element within the tab order of the document. |
| title | String | Yes | HTML: An advisory title for this element. Often used by the user agent as a tooltip. |
| type | String | Yes | The type of the value. It can be either fragment for an HTML fragment (default) or document for a full HTML document, with head, title, body, ... tags. |
| validator | javax.faces.el.MethodBinding | Only EL | A method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value. |
| value | Object | Yes | The initial value of this component. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processed |
| valueChangeListener | javax.faces.el.MethodBinding | Only EL | A method binding EL expression, accepting a ValueChangeEvent parameter and returning void. The specified method is invoked if this component is modified. The phase that this handler is fired in can be controlled via the immediate attribute. |
| visibleOnUserRole | String | Yes | If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped. |