|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIMessage
public class UIMessage
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_FAMILY
|
static java.lang.String |
COMPONENT_TYPE
|
Fields inherited from class javax.faces.component.UIComponent |
---|
bindings |
Constructor Summary | |
---|---|
UIMessage()
Construct an instance of the UIMessage. |
Method Summary | |
---|---|
java.lang.String |
getFamily()
|
java.lang.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,
java.lang.Object state)
Invoked in the "restore view" phase, this initialises this object's members from the values saved previously into the provided state object. |
java.lang.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(java.lang.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. |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getContainerClientId, getValueExpression, setValueExpression |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public UIMessage()
Method Detail |
---|
public java.lang.String getFor()
This is a required property on the component.
public void setFor(java.lang.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 java.lang.Object saveState(FacesContext facesContext)
UIComponentBase
saveState
in interface StateHolder
saveState
in class UIComponentBase
public void restoreState(FacesContext facesContext, java.lang.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 java.lang.String getFamily()
getFamily
in class UIComponent
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |