Project Documentation

Summary

Tag name: <tr:outputFormatted>
UIComponent class: org.apache.myfaces.trinidad.component.core.output.CoreOutputFormatted
Component type: org.apache.myfaces.trinidad.CoreOutputFormatted

The outputFormatted bean accepts a string in its "value" attribute containing a very limited set of HTML markup and outputs formatted results. It is not intended as anything near to a generic HTML output engine, and will never be such a bean. Developers needing full HTML output should use <f:verbatim> or <tr:outputText> with escape="false".

What this bean does provide is a limited ability to use a single source for translated or user-provided formatted text without further parsing or filtering or dangerous constructs (e.g., Javascript), and with some hope of successful output to non-HTML displays. It also supports more attributes than an unescaped outputText tag - for example, it supports styleClass.

This component supports the following HTML markup:

  • <br>
  • <hr>
  • <li>, <ol>, <ul>
  • <p>
  • <b>
  • <i>
  • <tt>
  • <big>
  • <small>
  • <pre>
  • <span>
  • <a>
and the following entities:
  • &lt;
  • &gt;
  • &amp;
  • &reg;
  • &copy;
  • &nbsp;
  • &quot;

Elements or entities other than these will be ignored. In addition, the CSS attributes ("class" and "style") and "href" are supported - all others are ignored.

No guarantee is made that the input HTML will be output without modification. For example, paragraph and list-item elements will always be closed even if left open in the input text. Other HTML markup may be replaced with output more appropriate to the current look-and-feel or user agent.

Note: The escaping rules are different in a .jspx file than they are in a .jsp file. See the example below.

Code Example(s)

In a .jspx:

tr:outputFormatted
 styleUsage="instruction"
 value="<b>simple outputFormatted</b>"/>

In a .jsp:

<tr:outputFormatted
  styleUsage="instruction"
  value="<b>simple outputFormatted</b>"/>

Supported Client Events for Client Behaviors

  • click (default)
  • dblclick
  • keydown
  • keypress
  • keyup
  • mousedown
  • mousemove
  • mouseout
  • mouseover
  • mouseup

Events

Type Phases Description
org.apache.myfaces.trinidad.event.AttributeChangeEventInvoke Application,
Apply Request Values
Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change event might include the width of a column that supported client-side resizing.

Attributes

Name Type Supports EL? Description
attributeChangeListenerjavax.el.MethodExpressionOnly EL a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
bindingorg.apache.myfaces.trinidad.component.core.output.CoreOutputFormattedOnly EL an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean.
converterjavax.faces.convert.ConverterYes a converter object
idStringNo the identifier for the component. The identifier must follow a subset of the syntax allowed in HTML:
  • Must not be a zero-length String.
  • First character must be an ASCII letter (A-Za-z) or an underscore ('_').
  • Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').
inlineStyleStringYes the CSS styles to use for this component.
onclickStringYes an onclick Javascript handler.
ondblclickStringYes an ondblclick Javascript handler.
onkeydownStringYes an onkeydown Javascript handler.
onkeypressStringYes an onkeypress Javascript handler.
onkeyupStringYes an onkeyup Javascript handler.
onmousedownStringYes an onmousedown Javascript handler.
onmousemoveStringYes an onmousemove Javascript handler.
onmouseoutStringYes an onmouseout Javascript handler.
onmouseoverStringYes an onmouseover Javascript handler.
onmouseupStringYes an onmouseup Javascript handler.
partialTriggersString[]Yes the IDs of the components that should trigger a partial update.

This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.

Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"

Identifiers must account for NamingContainers. You can use a single colon to start the search from the root, or use multiple colons to move up through the NamingContainer. For example, "::" will pop out of this component's naming container (it pops out of itself if it is a naming container), ":::" will pop out of two naming containers, etc. The search for the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the component with id = commandButton1 after popping out of two naming containers relative to this component. To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".

renderedbooleanYes Default Value: true

whether the component is rendered. When set to false, no output will be delivered for this component (the component will not in any way be rendered, and cannot be made visible on the client). If you want to change a component's rendered attribute from false to true using PPR, set the partialTrigger attribute of its parent component so the parent refreshes and in turn will render this component.
shortDescStringYes The short description of the component. This text is commonly used by user agents to display tooltip help text.
styleClassStringYes a CSS style class to use for this component.
styleUsageStringYes Valid Values: pageStamp, instruction, inContextBranding

the style usage, intended to make it easier to put the correct style on the text. Set this attribute when the outputFormatted is for instruction text, page stamp text, or inContextBranding text. The valid values are "instruction" , "pageStamp", and "inContextBranding". If styleUsage and styleClass attributes are both set, the styleClass attribute takes precedence.
valueObjectYes the value of the component. If the EL binding for the "value" points to a bean property with a getter but no setter, and this is an editable component, the component will be rendered in read-only mode.