javax.faces.component: public class: UIMessage

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

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

All Implemented Interfaces:
PartialStateHolder, ComponentSystemEventListener, SystemEventListenerHolder

Direct Known Subclasses:
HtmlMessage

This component is responsible for displaying messages for a specific UIComponent , identified by a clientId. The component obtains the messages from the FacesContext .

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

Nested Class Summary:
enum class	UIMessage.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 UIMessage() { super(); setRendererType("javax.faces.Message"); } Create a new UIMessage instance with default property values.

Constructor:

 public UIMessage() {
        super();
        setRendererType("javax.faces.Message");
}

Create a new UIMessage instance with default property values.

Method from javax.faces.component.UIMessage Summary:
getFamily, getFor, isRedisplay, isShowDetail, isShowSummary, setFor, 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.UIMessage 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 isRedisplay() { return (Boolean) getStateHelper().eval(PropertyKeys.redisplay, true); }
public boolean isShowDetail() { return (Boolean) getStateHelper().eval(PropertyKeys.showDetail, true); } Return the flag indicating whether the `detail` property of the associated message(s) should be displayed. Defaults to `true`.
public boolean isShowSummary() { return (Boolean) getStateHelper().eval(PropertyKeys.showSummary, false); } Return the flag indicating whether the `summary` property of the associated message(s) should be displayed. Defaults to `false`.
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 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.UIMessage 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 isRedisplay() {
        return (Boolean) getStateHelper().eval(PropertyKeys.redisplay, true);
}

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

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

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

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

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