Class HtmlMessage
- java.lang.Object
-
- javax.faces.component.UIComponent
-
- javax.faces.component.UIComponentBase
-
- javax.faces.component.UIMessage
-
- javax.faces.component.html.HtmlMessage
-
- All Implemented Interfaces:
java.util.EventListener,PartialStateHolder,StateHolder,TransientStateHolder,ComponentSystemEventListener,FacesListener,SystemEventListenerHolder
public class HtmlMessage extends UIMessage
By default, the
rendererTypeproperty must be set to "javax.faces.Message". This value can be changed by calling thesetRendererType()method.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static classHtmlMessage.PropertyKeys
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringCOMPONENT_TYPEThe standard component type for this component.-
Fields inherited from class javax.faces.component.UIMessage
COMPONENT_FAMILY
-
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
-
-
Constructor Summary
Constructors Constructor Description HtmlMessage()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.StringgetDir()Return the value of thedirproperty.java.lang.StringgetErrorClass()Return the value of theerrorClassproperty.java.lang.StringgetErrorStyle()Return the value of theerrorStyleproperty.java.lang.StringgetFatalClass()Return the value of thefatalClassproperty.java.lang.StringgetFatalStyle()Return the value of thefatalStyleproperty.java.lang.StringgetInfoClass()Return the value of theinfoClassproperty.java.lang.StringgetInfoStyle()Return the value of theinfoStyleproperty.java.lang.StringgetLang()Return the value of thelangproperty.java.lang.StringgetRole()Return the value of theroleproperty.java.lang.StringgetStyle()Return the value of thestyleproperty.java.lang.StringgetStyleClass()Return the value of thestyleClassproperty.java.lang.StringgetTitle()Return the value of thetitleproperty.java.lang.StringgetWarnClass()Return the value of thewarnClassproperty.java.lang.StringgetWarnStyle()Return the value of thewarnStyleproperty.booleanisTooltip()Return the value of thetooltipproperty.voidsetDir(java.lang.String dir)Set the value of thedirproperty.voidsetErrorClass(java.lang.String errorClass)Set the value of theerrorClassproperty.voidsetErrorStyle(java.lang.String errorStyle)Set the value of theerrorStyleproperty.voidsetFatalClass(java.lang.String fatalClass)Set the value of thefatalClassproperty.voidsetFatalStyle(java.lang.String fatalStyle)Set the value of thefatalStyleproperty.voidsetInfoClass(java.lang.String infoClass)Set the value of theinfoClassproperty.voidsetInfoStyle(java.lang.String infoStyle)Set the value of theinfoStyleproperty.voidsetLang(java.lang.String lang)Set the value of thelangproperty.voidsetRole(java.lang.String role)Set the value of theroleproperty.voidsetStyle(java.lang.String style)Set the value of thestyleproperty.voidsetStyleClass(java.lang.String styleClass)Set the value of thestyleClassproperty.voidsetTitle(java.lang.String title)Set the value of thetitleproperty.voidsetTooltip(boolean tooltip)Set the value of thetooltipproperty.voidsetWarnClass(java.lang.String warnClass)Set the value of thewarnClassproperty.voidsetWarnStyle(java.lang.String warnStyle)Set the value of thewarnStyleproperty.-
Methods inherited from class javax.faces.component.UIMessage
getFamily, getFor, isRedisplay, isShowDetail, isShowSummary, setFor, setRedisplay, setShowDetail, setShowSummary
-
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, 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, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent
-
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
-
-
-
-
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
dirproperty.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
dirproperty.
-
getErrorClass
public java.lang.String getErrorClass()
Return the value of the
errorClassproperty.Contents: CSS style class to apply to any message with a severity class of "ERROR".
-
setErrorClass
public void setErrorClass(java.lang.String errorClass)
Set the value of the
errorClassproperty.
-
getErrorStyle
public java.lang.String getErrorStyle()
Return the value of the
errorStyleproperty.Contents: CSS style(s) to apply to any message with a severity class of "ERROR".
-
setErrorStyle
public void setErrorStyle(java.lang.String errorStyle)
Set the value of the
errorStyleproperty.
-
getFatalClass
public java.lang.String getFatalClass()
Return the value of the
fatalClassproperty.Contents: CSS style class to apply to any message with a severity class of "FATAL".
-
setFatalClass
public void setFatalClass(java.lang.String fatalClass)
Set the value of the
fatalClassproperty.
-
getFatalStyle
public java.lang.String getFatalStyle()
Return the value of the
fatalStyleproperty.Contents: CSS style(s) to apply to any message with a severity class of "FATAL".
-
setFatalStyle
public void setFatalStyle(java.lang.String fatalStyle)
Set the value of the
fatalStyleproperty.
-
getInfoClass
public java.lang.String getInfoClass()
Return the value of the
infoClassproperty.Contents: CSS style class to apply to any message with a severity class of "INFO".
-
setInfoClass
public void setInfoClass(java.lang.String infoClass)
Set the value of the
infoClassproperty.
-
getInfoStyle
public java.lang.String getInfoStyle()
Return the value of the
infoStyleproperty.Contents: CSS style(s) to apply to any message with a severity class of "INFO".
-
setInfoStyle
public void setInfoStyle(java.lang.String infoStyle)
Set the value of the
infoStyleproperty.
-
getLang
public java.lang.String getLang()
Return the value of the
langproperty.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
langproperty.
-
getRole
public java.lang.String getRole()
Return the value of the
roleproperty.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
roleproperty.
-
getStyle
public java.lang.String getStyle()
Return the value of the
styleproperty.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
styleproperty.
-
getStyleClass
public java.lang.String getStyleClass()
Return the value of the
styleClassproperty.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
styleClassproperty.
-
getTitle
public java.lang.String getTitle()
Return the value of the
titleproperty.Contents: Advisory title information about markup elements generated for this component.
-
setTitle
public void setTitle(java.lang.String title)
Set the value of the
titleproperty.
-
isTooltip
public boolean isTooltip()
Return the value of the
tooltipproperty.Contents: Flag indicating whether the detail portion of the message should be displayed as a tooltip.
-
setTooltip
public void setTooltip(boolean tooltip)
Set the value of the
tooltipproperty.
-
getWarnClass
public java.lang.String getWarnClass()
Return the value of the
warnClassproperty.Contents: CSS style class to apply to any message with a severity class of "WARN".
-
setWarnClass
public void setWarnClass(java.lang.String warnClass)
Set the value of the
warnClassproperty.
-
getWarnStyle
public java.lang.String getWarnStyle()
Return the value of the
warnStyleproperty.Contents: CSS style(s) to apply to any message with a severity class of "WARN".
-
setWarnStyle
public void setWarnStyle(java.lang.String warnStyle)
Set the value of the
warnStyleproperty.
-
-