UIMessages (Java EE 5)

Java EE API

previous page next page
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

javax.faces.component Class UIMessages

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIMessages
All Implemented Interfaces:
StateHolder
Direct Known Subclasses:
HtmlMessages
public class UIMessages
extends UIComponentBase

Extends: UIComponent > UIComponentBase
Extended by: HtmlMessages

此组件的 renderer 负责获取来自 FacesContext 的消息并将其显示给用户。

此组件支持 Messages renderer 类型。

默认情况下，rendererType 属性必须设置为 "javax.faces.Messages"。可以调用 setRendererType() 方法更改此值。

英文文档：

The renderer for this component is responsible for obtaining the messages from the FacesContext and displaying them to the user.

This component supports the Messages renderer-type.

By default, the rendererType property must be set to "javax.faces.Messages". 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
UIMessages()
          Create a new UIMessages instance with default property values.
 
Method Summary
 String getFamily()
          Return the identifier of the component family to which this component belongs.
 boolean isGlobalOnly()
          Return the flag indicating whether only global messages (that is, messages with no associated client identifier) should be rendered.
 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 setGlobalOnly(boolean globalOnly)
          Set the flag indicating whether only global messages (that is, messages with no associated client identifier) should be rendered.
 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.UIComponentBase
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
 
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 UIMessages()

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

英文文档：

UIMessages

public UIMessages()

Create a new UIMessages 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 appropriate Renderer for this component instance.

Specified by:
getFamily in class UIComponent

public boolean isGlobalOnly()

返回指示是否仅应呈现全局消息（即没有关联客户端标识符的消息）的标志。默认值为 false。

英文文档：

isGlobalOnly

public boolean isGlobalOnly()

Return the flag indicating whether only global messages (that is, messages with no associated client identifier) should be rendered. Defaults to false.

public void setGlobalOnly(boolean globalOnly)

设置指示是否仅应呈现全局消息（即没有关联客户端标识符的消息）的标志。

globalOnly 新的标志值
英文文档：

setGlobalOnly

public void setGlobalOnly(boolean globalOnly)

Set the flag indicating whether only global messages (that is, messages with no associated client identifier) should be rendered.

Parameters:
globalOnly - The new flag value

public boolean isShowDetail()

返回指示是否应该显示关联消息的 detail 属性的标志。默认值为 false。

英文文档：

isShowDetail

public boolean isShowDetail()

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

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 属性的标志。默认值为 true。

英文文档：

isShowSummary

public boolean isShowSummary()

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

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)
英文文档：

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 the StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object) method on all those instances as well.

Specified by:
restoreState in interface StateHolder
Overrides:
restoreState in class UIComponentBase
Overview  Package   Class  Tree  Deprecated  Index  Help 
 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 : 未经我党受权你也可自由散发此文档。 如有任何错误请自行修正；若因此而造成任何损失请直接找人民主席，请勿与本人联系。谢谢！

previous page start next page