UIMessage (Java EE 5)

此组件负责显示由 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.

英文文档：

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

public UIMessage()

使用默认属性值创建新的 UIMessage 实例。

英文文档：

UIMessage

public UIMessage()

Create a new UIMessage instance with default property values.

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 appropriate Renderer for this component instance.

Specified by:

getFamily in class UIComponent

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

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

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 the StateHolder.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 the StateManager

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 interface StateHolder

Overrides:

saveState in class UIComponentBase

public void restoreState(FacesContext context,
                         Object state)