Project Documentation

Summary

Tag name: <t:htmlTag>
UIComponent class: org.apache.myfaces.custom.htmlTag.HtmlTag
Tag class: org.apache.myfaces.custom.htmlTag.HtmlTagTag
Component type: org.apache.myfaces.HtmlTag
Component family: javax.faces.Output
Renderer type: org.apache.myfaces.HtmlTagRenderer
Renderer class: org.apache.myfaces.custom.htmlTag.HtmlTagRenderer

Creates an arbitrary HTML tag which encloses any child components. The value attribute specifies the name of the generated tag. If value is an empty string then no tag will be generated, but the child components will be rendered. This differs from setting rendered=false, which prevents child components from being rendered at all. There is currently no facility for adding attributes to the generated html tag other than those explicitly supported by the attributes on this JSF component. Unless otherwise specified, all attributes accept static values or EL expressions.

Usage

<t:htmlTag [{all standard UIOutput attributes}]>
  <f:param name="AttributeName" value="AttributeValue" />
</t:htmlTag>

Example

<t:htmlTag value="br" />







Attributes

Name Type Supports EL? Description
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.
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.
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.

rendered boolean Yes A boolean value that indicates whether this component should be rendered. Default value: true.
style String Yes HTML: CSS styling instructions.
styleClass String Yes The CSS class for this element. Corresponds to the HTML 'class' attribute.
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
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.