Class HtmlOutputText

All Implemented Interfaces:
EventListener, PartialStateHolder, StateHolder, TransientStateHolder, ValueHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder

public class HtmlOutputText extends UIOutput

Renders the component value as text, optionally wrapping in a span element if I18N attributes, CSS styles or style classes are specified.

By default, the rendererType property must be set to "javax.faces.Text". This value can be changed by calling the setRendererType() method.

  • Field Details

    • COMPONENT_TYPE

      public static final String COMPONENT_TYPE

      The standard component type for this component.

      See Also:
  • Constructor Details

    • HtmlOutputText

      public HtmlOutputText()
  • Method Details

    • getDir

      public String getDir()

      Return the value of the dir property.

      Contents: Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). These attributes are case sensitive when rendering to XHTML, so care must be taken to have the correct case.

    • setDir

      public void setDir(String dir)

      Set the value of the dir property.

    • isEscape

      public boolean isEscape()

      Return the value of the escape property.

      Contents: Flag indicating that characters that are sensitive in HTML and XML markup must be escaped. This flag is set to "true" by default.

    • setEscape

      public void setEscape(boolean escape)

      Set the value of the escape property.

    • getLang

      public String getLang()

      Return the value of the lang property.

      Contents: Code describing the language used in the generated markup for this component.

    • setLang

      public void setLang(String lang)

      Set the value of the lang property.

    • getRole

      public String getRole()

      Return the value of the role property.

      Contents:

      Per the WAI-ARIA spec and its relationship to HTML5 (Section title ARIA Role Attriubute), every HTML element may have a "role" attribute whose value must be passed through unmodified on the element on which it is declared in the final rendered markup. The attribute, if specified, must have a value that is a string literal that is, or an EL Expression that evaluates to, a set of space-separated tokens representing the various WAI-ARIA roles that the element belongs to.

      It is the page author's responsibility to ensure that the user agent is capable of correctly interpreting the value of this attribute.

    • setRole

      public void setRole(String role)

      Set the value of the role property.

    • getStyle

      public String getStyle()

      Return the value of the style property.

      Contents: CSS style(s) to be applied when this component is rendered.

    • setStyle

      public void setStyle(String style)

      Set the value of the style property.

    • getStyleClass

      public String getStyleClass()

      Return the value of the styleClass property.

      Contents: 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.

    • setStyleClass

      public void setStyleClass(String styleClass)

      Set the value of the styleClass property.

    • getTitle

      public String getTitle()

      Return the value of the title property.

      Contents: Advisory title information about markup elements generated for this component.

    • setTitle

      public void setTitle(String title)

      Set the value of the title property.