Class HtmlOutputText
- java.lang.Object
-
- javax.faces.component.UIComponent
-
- javax.faces.component.UIComponentBase
-
- javax.faces.component.UIOutput
-
- javax.faces.component.html.HtmlOutputText
-
- All Implemented Interfaces:
java.util.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.If you are using h:outputText (or an equivalent inline EL expression) within a script or style block the value is NOT escaped by default.
By default, the
rendererType
property must be set to "javax.faces.Text
". This value can be changed by calling thesetRendererType()
method.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static class
HtmlOutputText.PropertyKeys
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
COMPONENT_TYPE
The standard component type for this component.-
Fields inherited from class javax.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY
-
Fields inherited from class javax.faces.component.UIOutput
COMPONENT_FAMILY
-
-
Constructor Summary
Constructors Constructor Description HtmlOutputText()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDir()
Return the value of thedir
property.java.lang.String
getLang()
Return the value of thelang
property.java.lang.String
getRole()
Return the value of therole
property.java.lang.String
getStyle()
Return the value of thestyle
property.java.lang.String
getStyleClass()
Return the value of thestyleClass
property.java.lang.String
getTitle()
Return the value of thetitle
property.boolean
isEscape()
Return the value of theescape
property.void
setDir(java.lang.String dir)
Set the value of thedir
property.void
setEscape(boolean escape)
Set the value of theescape
property.void
setLang(java.lang.String lang)
Set the value of thelang
property.void
setRole(java.lang.String role)
Set the value of therole
property.void
setStyle(java.lang.String style)
Set the value of thestyle
property.void
setStyleClass(java.lang.String styleClass)
Set the value of thestyleClass
property.void
setTitle(java.lang.String title)
Set the value of thetitle
property.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree
-
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent
-
Methods inherited from class javax.faces.component.UIOutput
clearInitialState, getConverter, getFamily, getLocalValue, getValue, markInitialState, resetValue, restoreState, saveState, setConverter, setValue
-
-
-
-
Field Detail
-
COMPONENT_TYPE
public static final java.lang.String COMPONENT_TYPE
The standard component type for this component.
- See Also:
- Constant Field Values
-
-
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
-
-