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.
protected static DocumentChange createDocumentChange(ComponentChange change)
          Use the conversion rules to attempt to retrieve the equivalent document change for a ComponentChange
abstract  java.util.Iterator<ComponentChange> getComponentChanges(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent)
          Retrieve the ComponentChanges available for specified component on this request.
abstract  java.util.Iterator<java.lang.String> getComponentIdsWithChanges(javax.faces.context.FacesContext facesContext)
          Retrieve the identifiers of all components on this request that have Changes associated with them for the viewId specified in the facesContext.
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.

getComponentChanges

public abstract java.util.Iterator<ComponentChange> getComponentChanges(javax.faces.context.FacesContext facesContext,
                                                                        javax.faces.component.UIComponent uiComponent)
Retrieve the ComponentChanges available for specified component on this request.

Returns:
An Iterator of ComponentChanges in the order in which they are associated with the UIComponent. Returns null if there are no such Changes

getComponentIdsWithChanges

public abstract java.util.Iterator<java.lang.String> getComponentIdsWithChanges(javax.faces.context.FacesContext facesContext)
Retrieve the identifiers of all components on this request that have Changes associated with them for the viewId specified in the facesContext.

Parameters:
facesContext -
Returns:
An Iterator that can be used to access the collection of component identifiers. Returns null if there are no such components.


Copyright © 2001-2007 Apache Software Foundation. All Rights Reserved.