public class UIMessage extends UIComponentBase
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
bindings
Constructor and Description |
---|
UIMessage()
Construct an instance of the UIMessage.
|
Modifier and Type | Method and Description |
---|---|
String |
getFamily() |
String |
getFor()
Gets The ID of the component whose attached FacesMessage object (if present) should be
diplayed by this component.
|
boolean |
isShowDetail()
Gets Specifies whether the detailed information from the message should be shown.
|
boolean |
isShowSummary()
Gets Specifies whether the summary information from the message should be shown.
|
void |
restoreState(FacesContext facesContext,
Object state)
Invoked in the "restore view" phase, this initialises this
object's members from the values saved previously into the
provided state object.
|
Object |
saveState(FacesContext facesContext)
Invoked after the render phase has completed, this method
returns an object which can be passed to the restoreState
of some other instance of UIComponentBase to reset that
object's state to the same values as this object currently
has.
|
void |
setFor(String forParam)
Sets The ID of the component whose attached FacesMessage object (if present) should be
diplayed by this component.
|
void |
setShowDetail(boolean showDetail)
Sets Specifies whether the detailed information from the message should be shown.
|
void |
setShowSummary(boolean showSummary)
Sets Specifies whether the summary information from the message should be shown.
|
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
encodeAll, getContainerClientId, getValueExpression, setValueExpression
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
public String getFor()
This is a required property on the component.
public void setFor(String forParam)
This is a required property on the component.
forParam
- the new for valuepublic boolean isShowDetail()
public void setShowDetail(boolean showDetail)
showDetail
- the new showDetail valuepublic boolean isShowSummary()
public void setShowSummary(boolean showSummary)
showSummary
- the new showSummary valuepublic Object saveState(FacesContext facesContext)
UIComponentBase
saveState
in interface StateHolder
saveState
in class UIComponentBase
public void restoreState(FacesContext facesContext, Object state)
UIComponentBase
restoreState
in interface StateHolder
restoreState
in class UIComponentBase
state
- is an object previously returned by
the saveState method of this class.public String getFamily()
getFamily
in class UIComponent
Copyright © 2013 Apache Software Foundation. All Rights Reserved.