public abstract class ChangeManager extends Object
Modifier and Type | Class and Description |
---|---|
static class |
ChangeManager.ChangeOutcome
Indicates the outcome of the attempt to apply a Change.
|
static class |
ChangeManager.NotificationOutcome
Indicates whether the notification was handled:
1.
|
Constructor and Description |
---|
ChangeManager() |
Modifier and Type | Method and Description |
---|---|
abstract void |
addComponentChange(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent uiComponent,
ComponentChange change)
Adds a ComponentChange to the current request for a specified component.
|
void |
addDocumentChange(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent uiComponent,
DocumentChange change)
|
ChangeManager.ChangeOutcome |
addDocumentChangeWithOutcome(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent uiComponent,
DocumentChange change)
Add a DocumentChange for a specified component, and return the outcome of adding the change.
|
void |
applyComponentChangesForCurrentView(javax.faces.context.FacesContext facesContext)
Applies all the ComponentChanges added so far for the current view.
|
void |
applyComponentChangesForSubtree(javax.faces.context.FacesContext facesContext,
javax.faces.component.NamingContainer root)
Applies the ComponentChanges added so far for components underneath
the specified NamingContainer.
|
void |
applySimpleComponentChanges(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component)
Apply non-cross-component changes to a component in its original location.
|
protected static DocumentChange |
createDocumentChange(ComponentChange change)
Use the conversion rules to attempt to retrieve the equivalent
document change for a ComponentChange
|
ChangeManager.NotificationOutcome |
documentChangeApplied(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent component,
ComponentChange componentChange)
This method is called on the registered ChangeManager if a ChangeManager in its
addComponentChange() implementation automatically creates an equivalent DocumentChange and
applies the change.
|
static void |
registerDocumentFactory(String targetClassName,
String converterClassName) |
AttributeComponentChange |
replaceAttributeChangeIfPresent(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent uiComponent,
AttributeComponentChange attributeComponentChange)
Replace an AttributeComponentChange if it's present.
|
public static void registerDocumentFactory(String targetClassName, String converterClassName)
protected static DocumentChange createDocumentChange(ComponentChange change)
change
- to convertpublic abstract void addComponentChange(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent, ComponentChange change)
IllegalArgumentException
- if any of the supplied parameters were to be null.DocumentChangeFactory
,
#documentChangeApplied(FacesContext, UIComponent, ComponentChange
public AttributeComponentChange replaceAttributeChangeIfPresent(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent, AttributeComponentChange attributeComponentChange)
facesContext
- uiComponent
- attributeComponentChange
- @Deprecated public void addDocumentChange(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent, DocumentChange change)
addDocumentChangeWithOutcome(javax.faces.context.FacesContext,javax.faces.component.UIComponent,org.apache.myfaces.trinidad.change.DocumentChange)
insteadIllegalArgumentException
- if any of the supplied parameters were to
be null.public ChangeManager.ChangeOutcome addDocumentChangeWithOutcome(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent, DocumentChange change)
facesContext
- The FacesContext instance for the current requestuiComponent
- The UIComponent instance for which the DocumentChange is to be addedchange
- The DocumentChange to be addedIllegalArgumentException
- if any of the supplied parameters were to
be null.ChangeManager.ChangeOutcome
public ChangeManager.NotificationOutcome documentChangeApplied(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component, ComponentChange componentChange)
component
- The target UIComponent instance for which the DocumentChange was
appliedcomponentChange
- The ComponentChange for which an equivalent DocumentChange was appliedIllegalArgumentException
- if the supplied ComponentChange is null. *public void applyComponentChangesForCurrentView(javax.faces.context.FacesContext facesContext)
facesContext
- The FacesContext instance for the current request.public void applyComponentChangesForSubtree(javax.faces.context.FacesContext facesContext, javax.faces.component.NamingContainer root)
facesContext
- The FacesContext instance for the current request.root
- The NamingContainer that contains the component subtree
to which ComponentChanges should be applied. If null, all changes are
applied.IllegalArgumentException
- if the root NamingContainer is not a
UIComponent instance.public void applySimpleComponentChanges(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
context
- component
- Component to apply the simple changes toCopyright © 2001-2017 The Apache Software Foundation. All Rights Reserved.