|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
javax.faces.component Class UIMessage
java.lang.Object javax.faces.component.UIComponent javax.faces.component.UIComponentBase javax.faces.component.UIMessage
- All Implemented Interfaces:
- StateHolder
- Direct Known Subclasses:
- HtmlMessage
public class UIMessage
- extends UIComponentBase
此组件负责显示由 clientId
标识的特定 UIComponent
的消息。该组件获取来自 FacesContext
的消息。
默认情况下,rendererType
属性必须设置为 "javax.faces.Message
"。可以调用 setRendererType()
方法更改此值。
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.
Field Summary | |
---|---|
static String |
COMPONENT_FAMILY
The standard component family for this component. |
static String |
COMPONENT_TYPE
The standard component type for this component. |
Fields inherited from class javax.faces.component.UIComponent |
---|
bindings |
Constructor Summary | |
---|---|
UIMessage()
Create a new UIMessage instance with default property
values. |
Method Summary | |
---|---|
String |
getFamily()
Return the identifier of the component family to which this component belongs. |
String |
getFor()
Return the client identifier of the component for which this component represents associated message(s) (if any). |
boolean |
isShowDetail()
Return the flag indicating whether the detail
property of the associated message(s) should be displayed. |
boolean |
isShowSummary()
Return the flag indicating whether the summary
property of the associated message(s) should be displayed. |
void |
restoreState(FacesContext context,
Object state)
Perform any processing required to restore the state from the entries in the state Object. |
Object |
saveState(FacesContext context)
Gets the state of the instance as a Serializable Object. |
void |
setFor(String newFor)
Set the client identifier of the component for which this component represents associated message(s) (if any). |
void |
setShowDetail(boolean showDetail)
Set the flag indicating whether the detail property
of the associated message(s) should be displayed. |
void |
setShowSummary(boolean showSummary)
Set the flag indicating whether the summary property
of the associated message(s) should be displayed. |
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 |
---|
英文文档:
COMPONENT_TYPE
public static final String COMPONENT_TYPE
The standard component type for this component.
- See Also:
- Constant Field Values
英文文档:
COMPONENT_FAMILY
public static final String COMPONENT_FAMILY
The standard component family for this component.
- See Also:
- Constant Field Values
Constructor Detail |
---|
public
UIMessage()
使用默认属性值创建新的 UIMessage
实例。
UIMessage
public UIMessage()
Create a new
UIMessage
instance with default property values.
Method Detail |
---|
public String
getFamily()
英文文档:
getFamily
public String getFamily()
- Description copied from class:
UIComponent
Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the
rendererType
property, may be used to select the appropriateRenderer
for this component instance.- Specified by:
getFamily
in classUIComponent
public String
getFor()
返回此组件为其表示关联消息(如果有)的组件的客户端标识符。
getFor
public String getFor()
Return the client identifier of the component for which this component represents associated message(s) (if any).
public void
setFor(String newFor)
设置此组件为其表示关联消息(如果有)的组件的客户端标识符。必须在显示该消息前设置此属性。
newFor | 新的客户端 ID |
setFor
public void setFor(String 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.
- Parameters:
newFor
- The new client id
public boolean
isShowDetail()
返回指示是否应该显示关联消息的 detail
属性的标志。默认值为 true
。
isShowDetail
public boolean isShowDetail()
Return the flag indicating whether the
detail
property of the associated message(s) should be displayed. Defaults totrue
.
public void
setShowDetail(boolean showDetail)
设置指示是否应该显示关联消息的 detail
属性的标志。
showDetail | 新的标志 |
setShowDetail
public void setShowDetail(boolean showDetail)
Set the flag indicating whether the
detail
property of the associated message(s) should be displayed.- Parameters:
showDetail
- The new flag
public boolean
isShowSummary()
返回指示是否应该显示关联消息的 summary
属性的标志。默认值为 false
。
isShowSummary
public boolean isShowSummary()
Return the flag indicating whether the
summary
property of the associated message(s) should be displayed. Defaults tofalse
.
public void
setShowSummary(boolean showSummary)
设置指示是否应该显示关联消息的 summary
属性的标志。
showSummary | 新的标志值 |
setShowSummary
public void setShowSummary(boolean showSummary)
Set the flag indicating whether the
summary
property of the associated message(s) should be displayed.- Parameters:
showSummary
- The new flag value
public Object
saveState(FacesContext context)
英文文档:
saveState
public Object saveState(FacesContext context)
- Description copied from interface:
StateHolder
Gets the state of the instance as a
Serializable
Object.If the class that implements this interface has references to instances that implement StateHolder (such as a
UIComponent
with event handlers, validators, etc.) this method must call theStateHolder.saveState(javax.faces.context.FacesContext)
method on all those instances as well. This method must not save the state of children and facets. That is done via theStateManager
This method must not alter the state of the implementing object. In other words, after executing this code:
Object state = component.saveState(facesContext);
component
should be the same as before executing it.The return from this method must be
Serializable
- Specified by:
saveState
in interfaceStateHolder
- Overrides:
saveState
in classUIComponentBase
public void
restoreState(FacesContext context, Object state)
英文文档:
restoreState
public void restoreState(FacesContext context, Object state)
- Description copied from interface:
StateHolder
Perform any processing required to restore the state from the entries in the state Object.
If the class that implements this interface has references to instances that also implement StateHolder (such as a
UIComponent
with event handlers, validators, etc.) this method must call theStateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)
method on all those instances as well.- Specified by:
restoreState
in interfaceStateHolder
- Overrides:
restoreState
in classUIComponentBase
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Submit a bug or feature
Copyright 2007 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.
PS : 未经我党受权你也可自由散发此文档。 如有任何错误请自行修正;若因此而造成任何损失请直接找人民主席,请勿与本人联系。谢谢!