javax.faces.component: public class: UIMessages

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

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

All Implemented Interfaces:
PartialStateHolder, ComponentSystemEventListener, SystemEventListenerHolder

Direct Known Subclasses:
HtmlMessages

The renderer for this component is responsible for obtaining the messages from the FacesContext and displaying them to the user.

This component supports the Messages renderer-type.

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:
enum class	UIMessages.PropertyKeys

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

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 UIMessages() { super(); setRendererType("javax.faces.Messages"); } Create a new UIMessages instance with default property values.

Constructor:

 public UIMessages() {
        super();
        setRendererType("javax.faces.Messages");
}

Create a new UIMessages instance with default property values.

Method from javax.faces.component.UIMessages Summary:
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.UIMessages Detail:
public String getFamily() { return (COMPONENT_FAMILY); }
public String getFor() { return (String) getStateHelper().eval(PropertyKeys.forValue); } Return the client identifier of the component for which this component represents associated message(s) (if any).
public boolean isGlobalOnly() { return (Boolean) getStateHelper().eval(PropertyKeys.globalOnly, false); } Return the flag indicating whether only global messages (that is, messages with no associated client identifier) should be rendered. Mutually exclusive with the "for" property which takes precedence. Defaults to false.
public boolean isRedisplay() { return (Boolean) getStateHelper().eval(PropertyKeys.redisplay, true); }
public boolean isShowDetail() { return (Boolean) getStateHelper().eval(PropertyKeys.showDetail, false); } Return the flag indicating whether the `detail` property of the associated message(s) should be displayed. Defaults to false.
public boolean isShowSummary() { return (Boolean) getStateHelper().eval(PropertyKeys.showSummary, true); } Return the flag indicating whether the `summary` property of the associated message(s) should be displayed. Defaults to true.
public void setFor(String newFor) { getStateHelper().put(PropertyKeys.forValue, newFor); } Set the client identifier of the component for which this component represents associated message(s) (if any). This property must be set before the message is displayed.
public void setGlobalOnly(boolean globalOnly) { getStateHelper().put(PropertyKeys.globalOnly, globalOnly); } Set the flag indicating whether only global messages (that is, messages with no associated client identifier) should be rendered.
public void setRedisplay(boolean redisplay) { getStateHelper().put(PropertyKeys.redisplay, redisplay); } Set the flag indicating whether the `detail` property of the associated message(s) should be displayed.
public void setShowDetail(boolean showDetail) { getStateHelper().put(PropertyKeys.showDetail, showDetail); } Set the flag indicating whether the `detail` property of the associated message(s) should be displayed.
public void setShowSummary(boolean showSummary) { getStateHelper().put(PropertyKeys.showSummary, showSummary); } Set the flag indicating whether the `summary` property of the associated message(s) should be displayed.

Method from javax.faces.component.UIMessages Detail:

 public String getFamily() {
        return (COMPONENT_FAMILY);
}

 public String getFor() {
        return (String) getStateHelper().eval(PropertyKeys.forValue);
}

Return the client identifier of the component for which this component represents associated message(s) (if any).

 public boolean isGlobalOnly() {
        return (Boolean) getStateHelper().eval(PropertyKeys.globalOnly, false);
}

Return the flag indicating whether only global messages (that is, messages with no associated client identifier) should be rendered. Mutually exclusive with the "for" property which takes precedence. Defaults to false.

 public boolean isRedisplay() {
        return (Boolean) getStateHelper().eval(PropertyKeys.redisplay, true);
}

 public boolean isShowDetail() {
        return (Boolean) getStateHelper().eval(PropertyKeys.showDetail, false);
}

Return the flag indicating whether the detail property of the associated message(s) should be displayed. Defaults to false.

 public boolean isShowSummary() {
        return (Boolean) getStateHelper().eval(PropertyKeys.showSummary, true);
}

Return the flag indicating whether the summary property of the associated message(s) should be displayed. Defaults to true.

 public  void setFor(String newFor) {
        getStateHelper().put(PropertyKeys.forValue, newFor);
}

Set the client identifier of the component for which this component represents associated message(s) (if any). This property must be set before the message is displayed.

 public  void setGlobalOnly(boolean globalOnly) {
        getStateHelper().put(PropertyKeys.globalOnly, globalOnly);
}

Set the flag indicating whether only global messages (that is, messages with no associated client identifier) should be rendered.

 public  void setRedisplay(boolean redisplay) {
        getStateHelper().put(PropertyKeys.redisplay, redisplay);
}

Set the flag indicating whether the detail property of the associated message(s) should be displayed.

 public  void setShowDetail(boolean showDetail) {
        getStateHelper().put(PropertyKeys.showDetail, showDetail);
}

Set the flag indicating whether the detail property of the associated message(s) should be displayed.

 public  void setShowSummary(boolean showSummary) {
        getStateHelper().put(PropertyKeys.showSummary, showSummary);
}

Set the flag indicating whether the summary property of the associated message(s) should be displayed.