javax.faces.event
Class PreRenderComponentEvent

java.lang.Object
  extended by java.util.EventObject
      extended by javax.faces.event.SystemEvent
          extended by javax.faces.event.ComponentSystemEvent
              extended by javax.faces.event.PreRenderComponentEvent
All Implemented Interfaces:
Serializable

public class PreRenderComponentEvent
extends ComponentSystemEvent

When an instance of this event is passed to SystemEventListener.processEvent(javax.faces.event.SystemEvent) or ComponentSystemEventListener.processEvent(javax.faces.event.ComponentSystemEvent), the listener implementation may assume that the source of this event instance is the UIComponent instance that is about to be rendered and that it is safe to call UIComponent.getParent(), UIComponent.getClientId(), and other methods that depend upon the component instance being in the view.

Since:
2.0
See Also:
Serialized Form

Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
PreRenderComponentEvent(UIComponent component)
          

Instantiate a new PreRenderComponentEvent that indicates the argument component is about to be rendered.

 
Method Summary
 
Methods inherited from class javax.faces.event.ComponentSystemEvent
getComponent
 
Methods inherited from class javax.faces.event.SystemEvent
isAppropriateListener, processListener
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PreRenderComponentEvent

public PreRenderComponentEvent(UIComponent component)

Instantiate a new PreRenderComponentEvent that indicates the argument component is about to be rendered.

Parameters:
component - the UIComponent that is about to be rendered.
Throws:
IllegalArgumentException - if the argument is null.


Copyright 2002-2009 Sun Microsystems, Inc. All Rights Reserved.