UIMessage (Java EE 5 SDK)

Java

previous page next page
概述  软件包   类  树  已过时  索引  帮助 
Java EE 5 SDK

深圳电信培训中心.徐海蛟老师.
 上一个类   下一个类 框架    无框架    
摘要: 嵌套 | 字段 | 构造器 | 方法 详细信息: 字段 | 构造器 | 方法

javax.faces.component Class UIMessage

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIMessage
所有已实现的接口:
StateHolder
直接已知子类:
HtmlMessage
public class UIMessage
extends UIComponentBase

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.

字段摘要
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
 
构造器摘要
UIMessage()
          Create a new UIMessage instance with default property values.
 
方法摘要
 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.
 
类方法继承 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
 
类方法继承 javax.faces.component.UIComponent
encodeAll, getContainerClientId, getValueExpression, setValueExpression
 
类方法继承 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

字段详细信息

COMPONENT_TYPE

public static final String COMPONENT_TYPE

The standard component type for this component.

另请参见:
常量字段

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

The standard component family for this component.

另请参见:
常量字段

构造器详细信息

UIMessage

public UIMessage()

Create a new UIMessage instance with default property values.

方法详细信息

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.

规范说明:
getFamily in class UIComponent

getFor

public String getFor()

Return the client identifier of the component for which this component represents associated message(s) (if any).

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.

参数:
newFor - The new client id

isShowDetail

public boolean isShowDetail()

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

setShowDetail

public void setShowDetail(boolean showDetail)

Set the flag indicating whether the detail property of the associated message(s) should be displayed.

参数:
showDetail - The new flag

isShowSummary

public boolean isShowSummary()

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

setShowSummary

public void setShowSummary(boolean showSummary)

Set the flag indicating whether the summary property of the associated message(s) should be displayed.

参数:
showSummary - The new flag value

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

规范说明:
saveState in interface StateHolder
重写:
saveState in class UIComponentBase

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.

规范说明:
restoreState in interface StateHolder
重写:
restoreState in class UIComponentBase
概述  软件包   类  树  已过时  索引  帮助 
Java EE 5 SDK

深圳电信培训中心.徐海蛟老师.
 上一个类   下一个类 框架    无框架    
摘要: 嵌套 | 字段 | 构造器 | 方法 详细信息: 字段 | 构造器 | 方法
提交错误或意见

版权所有 2007 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。深圳电信培训中心.徐海蛟老师教学参考.

previous page start next page