org.apache.myfaces.trinidad.change
Class ChangeManager

java.lang.Object
  extended by org.apache.myfaces.trinidad.change.ChangeManager
Direct Known Subclasses:
SessionChangeManager

public abstract class ChangeManager
extends java.lang.Object

The base class for all ChangeManagers. A ChangeManager should manage accumulation of Changes and also take care of their persistence.

Version:
$Name: $ ($Revision: adfrt/faces/adf-faces-api/src/main/java/oracle/adf/view/faces/change/ChangeManager.java#0 $) $Date: 10-nov-2005.19:09:58 $

Constructor Summary
ChangeManager()
           
 
Method Summary
abstract  void addComponentChange(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent, ComponentChange change)
          Add a ComponentChange to this current request for a specified component.
 void addDocumentChange(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent, DocumentChange change)
          Add a DocumentChange to this current request for a specified component.
 void applyComponentChangesForCurrentView(javax.faces.context.FacesContext facesContext)
          Applies all the ComponentChanges added so far for the current view.
protected static DocumentChange createDocumentChange(ComponentChange change)
          Use the conversion rules to attempt to retrieve the equivalent document change for a ComponentChange
static void registerDocumentFactory(java.lang.String targetClassName, java.lang.String converterClassName)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ChangeManager

public ChangeManager()
Method Detail

registerDocumentFactory

public static void registerDocumentFactory(java.lang.String targetClassName,
                                           java.lang.String converterClassName)

createDocumentChange

protected static DocumentChange createDocumentChange(ComponentChange change)
Use the conversion rules to attempt to retrieve the equivalent document change for a ComponentChange

Parameters:
change - to convert

addComponentChange

public abstract void addComponentChange(javax.faces.context.FacesContext facesContext,
                                        javax.faces.component.UIComponent uiComponent,
                                        ComponentChange change)
Add a ComponentChange to this current request for a specified component.

Throws:
java.lang.IllegalArgumentException - if any of the supplied parameters were to be null.

addDocumentChange

public void addDocumentChange(javax.faces.context.FacesContext facesContext,
                              javax.faces.component.UIComponent uiComponent,
                              DocumentChange change)
Add a DocumentChange to this current request for a specified component.

Throws:
java.lang.IllegalArgumentException - if any of the supplied parameters were to be null.

applyComponentChangesForCurrentView

public void applyComponentChangesForCurrentView(javax.faces.context.FacesContext facesContext)
Applies all the ComponentChanges added so far for the current view. Developers should not need to call this method. Internal implementation will call it as the component tree is built and is ready to take changes.

Parameters:
facesContext - The FacesContext instance for the current request.


Copyright © 2001-2008 The Apache Software Foundation. All Rights Reserved.