Package javax.faces.component.html

Class HtmlOutputFormat

  • All Implemented Interfaces:
    java.util.EventListener, PartialStateHolder, StateHolder, TransientStateHolder, ValueHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder

    public class HtmlOutputFormat
extends UIOutput

    Represents a component that looks up a localized message in a resource bundle, optionally uses it as a MessageFormat pattern string and substitutes in parameter values from nested UIParameter components, and renders the result. If the "dir" or "lang" attributes are present, render a span element and pass them through as attributes on the span.

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

    • Field Detail

      • COMPONENT_TYPE

        public static final java.lang.String COMPONENT_TYPE

        The standard component type for this component.

        See Also:
        Constant Field Values

    • Constructor Detail

      • HtmlOutputFormat

        public HtmlOutputFormat​()

    • Method Detail

      • getDir

        public java.lang.String getDir​()

        Return the value of the dir property.

        Returns:
        the property value

        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​(java.lang.String dir)

        Set the value of the dir property.

        Parameters:
        dir - the new property value

      • isEscape

        public boolean isEscape​()

        Return the value of the escape property.

        Returns:
        the property value

        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.

        Parameters:
        escape - the new property value

      • getLang

        public java.lang.String getLang​()

        Return the value of the lang property.

        Returns:
        the property value

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

      • setLang

        public void setLang​(java.lang.String lang)

        Set the value of the lang property.

        Parameters:
        lang - the new property value

      • getRole

        public java.lang.String getRole​()

        Return the value of the role property.

        Returns:
        the property value

        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​(java.lang.String role)

        Set the value of the role property.

        Parameters:
        role - the new property value

      • getStyle

        public java.lang.String getStyle​()

        Return the value of the style property.

        Returns:
        the property value

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

      • setStyle

        public void setStyle​(java.lang.String style)

        Set the value of the style property.

        Parameters:
        style - the new property value

      • getStyleClass

        public java.lang.String getStyleClass​()

        Return the value of the styleClass property.

        Returns:
        the property value

        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​(java.lang.String styleClass)

        Set the value of the styleClass property.

        Parameters:
        styleClass - the new property value

      • getTitle

        public java.lang.String getTitle​()

        Return the value of the title property.

        Returns:
        the property value

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

      • setTitle

        public void setTitle​(java.lang.String title)

        Set the value of the title property.

        Parameters:
        title - the new property value