javax.faces.component.html: public class: HtmlMessages

javax.faces.component.html
public class: HtmlMessages [javadoc | source]

java.lang.Object
   javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
         javax.faces.component.UIMessages
            javax.faces.component.html.HtmlMessages

All Implemented Interfaces:
PartialStateHolder, ComponentSystemEventListener, SystemEventListenerHolder

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

Nested Class Summary:
protected enum class	HtmlMessages.PropertyKeys

Field Summary
public static final String	COMPONENT_TYPE	The standard component type for this component.

Fields inherited from javax.faces.component.UIMessages:
COMPONENT_TYPE, COMPONENT_FAMILY

Fields inherited from javax.faces.component.UIComponent:
CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, BEANINFO_KEY, FACETS_KEY, VIEW_LOCATION_KEY, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, attributesThatAreSet, stateHelper, compositeParent, bindings, initialState, listenersByEventClass

Constructor:
public HtmlMessages() { super(); setRendererType("javax.faces.Messages"); }

Method from javax.faces.component.html.HtmlMessages Summary:
getDir, getErrorClass, getErrorStyle, getFatalClass, getFatalStyle, getInfoClass, getInfoStyle, getLang, getLayout, getStyle, getStyleClass, getTitle, getWarnClass, getWarnStyle, isTooltip, setDir, setErrorClass, setErrorStyle, setFatalClass, setFatalStyle, setInfoClass, setInfoStyle, setLang, setLayout, setStyle, setStyleClass, setTitle, setTooltip, setWarnClass, setWarnStyle

Methods from javax.faces.component.UIMessages:
getFamily, getFor, isGlobalOnly, isRedisplay, isShowDetail, isShowSummary, setFor, setGlobalOnly, setRedisplay, setShowDetail, setShowSummary

Methods from javax.faces.component.UIComponentBase:
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getDescriptorMap, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, 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

Methods from javax.faces.component.UIComponentBase:

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getDescriptorMap, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, 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

Methods from javax.faces.component.UIComponent:
addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getFamily, getId, getListenersForEventClass, getNamingContainer, getParent, getRenderer, getRendererType, getRendersChildren, getResourceBundleMap, getStateHelper, getStateHelper, getValueBinding, getValueExpression, initialStateMarked, invokeOnComponent, isCompositeComponent, isInView, isRendered, isVisitable, markInitialState, popComponentFromEL, processDecodes, processEvent, processRestoreState, processSaveState, processUpdates, processValidators, pushComponentToEL, queueEvent, removeFacesListener, setId, setInView, setParent, setRendered, setRendererType, setValueBinding, setValueExpression, subscribeToEvent, unsubscribeFromEvent, visitTree

Methods from javax.faces.component.UIComponent:

addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getFamily, getId, getListenersForEventClass, getNamingContainer, getParent, getRenderer, getRendererType, getRendersChildren, getResourceBundleMap, getStateHelper, getStateHelper, getValueBinding, getValueExpression, initialStateMarked, invokeOnComponent, isCompositeComponent, isInView, isRendered, isVisitable, markInitialState, popComponentFromEL, processDecodes, processEvent, processRestoreState, processSaveState, processUpdates, processValidators, pushComponentToEL, queueEvent, removeFacesListener, setId, setInView, setParent, setRendered, setRendererType, setValueBinding, setValueExpression, subscribeToEvent, unsubscribeFromEvent, visitTree

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.faces.component.html.HtmlMessages Detail:
public String getDir() { return (java.lang.String) getStateHelper().eval(PropertyKeys.dir); } 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).
public String getErrorClass() { return (java.lang.String) getStateHelper().eval(PropertyKeys.errorClass); } Return the value of the `errorClass` property. Contents: CSS style class to apply to any message with a severity class of "ERROR".
public String getErrorStyle() { return (java.lang.String) getStateHelper().eval(PropertyKeys.errorStyle); } Return the value of the `errorStyle` property. Contents: CSS style(s) to apply to any message with a severity class of "ERROR".
public String getFatalClass() { return (java.lang.String) getStateHelper().eval(PropertyKeys.fatalClass); } Return the value of the `fatalClass` property. Contents: CSS style class to apply to any message with a severity class of "FATAL".
public String getFatalStyle() { return (java.lang.String) getStateHelper().eval(PropertyKeys.fatalStyle); } Return the value of the `fatalStyle` property. Contents: CSS style(s) to apply to any message with a severity class of "FATAL".
public String getInfoClass() { return (java.lang.String) getStateHelper().eval(PropertyKeys.infoClass); } Return the value of the `infoClass` property. Contents: CSS style class to apply to any message with a severity class of "INFO".
public String getInfoStyle() { return (java.lang.String) getStateHelper().eval(PropertyKeys.infoStyle); } Return the value of the `infoStyle` property. Contents: CSS style(s) to apply to any message with a severity class of "INFO".
public String getLang() { return (java.lang.String) getStateHelper().eval(PropertyKeys.lang); } Return the value of the `lang` property. Contents: Code describing the language used in the generated markup for this component.
public String getLayout() { return (java.lang.String) getStateHelper().eval(PropertyKeys.layout, "list"); } Return the value of the `layout` property. Contents: The type of layout markup to use when rendering error messages. Valid values are "table" (an HTML table) and "list" (an HTML list). If not specified, the default value is "list".
public String getStyle() { return (java.lang.String) getStateHelper().eval(PropertyKeys.style); } Return the value of the `style` property. Contents: CSS style(s) to be applied when this component is rendered.
public String getStyleClass() { return (java.lang.String) getStateHelper().eval(PropertyKeys.styleClass); } 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.
public String getTitle() { return (java.lang.String) getStateHelper().eval(PropertyKeys.title); } Return the value of the `title` property. Contents: Advisory title information about markup elements generated for this component.
public String getWarnClass() { return (java.lang.String) getStateHelper().eval(PropertyKeys.warnClass); } Return the value of the `warnClass` property. Contents: CSS style class to apply to any message with a severity class of "WARN".
public String getWarnStyle() { return (java.lang.String) getStateHelper().eval(PropertyKeys.warnStyle); } Return the value of the `warnStyle` property. Contents: CSS style(s) to apply to any message with a severity class of "WARN".
public boolean isTooltip() { return (java.lang.Boolean) getStateHelper().eval(PropertyKeys.tooltip, false); } Return the value of the `tooltip` property. Contents: Flag indicating whether the detail portion of the message should be displayed as a tooltip.
public void setDir(String dir) { getStateHelper().put(PropertyKeys.dir, dir); handleAttribute("dir", dir); } Set the value of the `dir` property.
public void setErrorClass(String errorClass) { getStateHelper().put(PropertyKeys.errorClass, errorClass); } Set the value of the `errorClass` property.
public void setErrorStyle(String errorStyle) { getStateHelper().put(PropertyKeys.errorStyle, errorStyle); } Set the value of the `errorStyle` property.
public void setFatalClass(String fatalClass) { getStateHelper().put(PropertyKeys.fatalClass, fatalClass); } Set the value of the `fatalClass` property.
public void setFatalStyle(String fatalStyle) { getStateHelper().put(PropertyKeys.fatalStyle, fatalStyle); } Set the value of the `fatalStyle` property.
public void setInfoClass(String infoClass) { getStateHelper().put(PropertyKeys.infoClass, infoClass); } Set the value of the `infoClass` property.
public void setInfoStyle(String infoStyle) { getStateHelper().put(PropertyKeys.infoStyle, infoStyle); } Set the value of the `infoStyle` property.
public void setLang(String lang) { getStateHelper().put(PropertyKeys.lang, lang); handleAttribute("lang", lang); } Set the value of the `lang` property.
public void setLayout(String layout) { getStateHelper().put(PropertyKeys.layout, layout); } Set the value of the `layout` property.
public void setStyle(String style) { getStateHelper().put(PropertyKeys.style, style); handleAttribute("style", style); } Set the value of the `style` property.
public void setStyleClass(String styleClass) { getStateHelper().put(PropertyKeys.styleClass, styleClass); } Set the value of the `styleClass` property.
public void setTitle(String title) { getStateHelper().put(PropertyKeys.title, title); handleAttribute("title", title); } Set the value of the `title` property.
public void setTooltip(boolean tooltip) { getStateHelper().put(PropertyKeys.tooltip, tooltip); } Set the value of the `tooltip` property.
public void setWarnClass(String warnClass) { getStateHelper().put(PropertyKeys.warnClass, warnClass); } Set the value of the `warnClass` property.
public void setWarnStyle(String warnStyle) { getStateHelper().put(PropertyKeys.warnStyle, warnStyle); } Set the value of the `warnStyle` property.

Method from javax.faces.component.html.HtmlMessages Detail:

 public String getDir() {
        return (java.lang.String) getStateHelper().eval(PropertyKeys.dir);
}

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).

 public String getErrorClass() {
        return (java.lang.String) getStateHelper().eval(PropertyKeys.errorClass);
}

Return the value of the errorClass property.

Contents: CSS style class to apply to any message with a severity class of "ERROR".

 public String getErrorStyle() {
        return (java.lang.String) getStateHelper().eval(PropertyKeys.errorStyle);
}

Return the value of the errorStyle property.

Contents: CSS style(s) to apply to any message with a severity class of "ERROR".

 public String getFatalClass() {
        return (java.lang.String) getStateHelper().eval(PropertyKeys.fatalClass);
}

Return the value of the fatalClass property.

Contents: CSS style class to apply to any message with a severity class of "FATAL".

 public String getFatalStyle() {
        return (java.lang.String) getStateHelper().eval(PropertyKeys.fatalStyle);
}

Return the value of the fatalStyle property.

Contents: CSS style(s) to apply to any message with a severity class of "FATAL".

 public String getInfoClass() {
        return (java.lang.String) getStateHelper().eval(PropertyKeys.infoClass);
}

Return the value of the infoClass property.

Contents: CSS style class to apply to any message with a severity class of "INFO".

 public String getInfoStyle() {
        return (java.lang.String) getStateHelper().eval(PropertyKeys.infoStyle);
}

Return the value of the infoStyle property.

Contents: CSS style(s) to apply to any message with a severity class of "INFO".

 public String getLang() {
        return (java.lang.String) getStateHelper().eval(PropertyKeys.lang);
}

Return the value of the lang property.

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

 public String getLayout() {
        return (java.lang.String) getStateHelper().eval(PropertyKeys.layout, "list");
}

Return the value of the layout property.

Contents: The type of layout markup to use when rendering error messages. Valid values are "table" (an HTML table) and "list" (an HTML list). If not specified, the default value is "list".

 public String getStyle() {
        return (java.lang.String) getStateHelper().eval(PropertyKeys.style);
}

Return the value of the style property.

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

 public String getStyleClass() {
        return (java.lang.String) getStateHelper().eval(PropertyKeys.styleClass);
}

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.

 public String getTitle() {
        return (java.lang.String) getStateHelper().eval(PropertyKeys.title);
}

Return the value of the title property.

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

 public String getWarnClass() {
        return (java.lang.String) getStateHelper().eval(PropertyKeys.warnClass);
}

Return the value of the warnClass property.

Contents: CSS style class to apply to any message with a severity class of "WARN".

 public String getWarnStyle() {
        return (java.lang.String) getStateHelper().eval(PropertyKeys.warnStyle);
}

Return the value of the warnStyle property.

Contents: CSS style(s) to apply to any message with a severity class of "WARN".

 public boolean isTooltip() {
        return (java.lang.Boolean) getStateHelper().eval(PropertyKeys.tooltip, false);
}

Return the value of the tooltip property.

Contents: Flag indicating whether the detail portion of the message should be displayed as a tooltip.

 public  void setDir(String dir) {
        getStateHelper().put(PropertyKeys.dir, dir);
        handleAttribute("dir", dir);
}

Set the value of the dir property.

 public  void setErrorClass(String errorClass) {
        getStateHelper().put(PropertyKeys.errorClass, errorClass);
}

Set the value of the errorClass property.

 public  void setErrorStyle(String errorStyle) {
        getStateHelper().put(PropertyKeys.errorStyle, errorStyle);
}

Set the value of the errorStyle property.

 public  void setFatalClass(String fatalClass) {
        getStateHelper().put(PropertyKeys.fatalClass, fatalClass);
}

Set the value of the fatalClass property.

 public  void setFatalStyle(String fatalStyle) {
        getStateHelper().put(PropertyKeys.fatalStyle, fatalStyle);
}

Set the value of the fatalStyle property.

 public  void setInfoClass(String infoClass) {
        getStateHelper().put(PropertyKeys.infoClass, infoClass);
}

Set the value of the infoClass property.

 public  void setInfoStyle(String infoStyle) {
        getStateHelper().put(PropertyKeys.infoStyle, infoStyle);
}

Set the value of the infoStyle property.

 public  void setLang(String lang) {
        getStateHelper().put(PropertyKeys.lang, lang);
        handleAttribute("lang", lang);
}

Set the value of the lang property.

 public  void setLayout(String layout) {
        getStateHelper().put(PropertyKeys.layout, layout);
}

Set the value of the layout property.

 public  void setStyle(String style) {
        getStateHelper().put(PropertyKeys.style, style);
        handleAttribute("style", style);
}

Set the value of the style property.

 public  void setStyleClass(String styleClass) {
        getStateHelper().put(PropertyKeys.styleClass, styleClass);
}

Set the value of the styleClass property.

 public  void setTitle(String title) {
        getStateHelper().put(PropertyKeys.title, title);
        handleAttribute("title", title);
}

Set the value of the title property.

 public  void setTooltip(boolean tooltip) {
        getStateHelper().put(PropertyKeys.tooltip, tooltip);
}

Set the value of the tooltip property.

 public  void setWarnClass(String warnClass) {
        getStateHelper().put(PropertyKeys.warnClass, warnClass);
}

Set the value of the warnClass property.

 public  void setWarnStyle(String warnStyle) {
        getStateHelper().put(PropertyKeys.warnStyle, warnStyle);
}

Set the value of the warnStyle property.