org.apache.myfaces.trinidad.change

Class InsertingComponentFragmentLocator

java.lang.Object

org.apache.myfaces.trinidad.change.InsertingComponentFragmentLocator

public abstract class InsertingComponentFragmentLocator
extends Object

Strategy implemented for components that insert document fragments to return the URL of the fragment currently inserted by this component. When determining the URL of the document that defines the tag corresponding to a target component, clients will call getFramentUrlForInsertedComponent for each registered InsertedComponentFragmentLocator on each UIComponent starting from the target component and upto the UIViewRoot and each registered InsertingComponentFragmentLocator on each component from the parent of the target component to the UIViewRoot. If a non-null URL string is returned, the walk of the ancestor chain halts and the returned value is considered the URL string for the document for the target component. If the registered listeners return null for every component in the ancestor chain, the containing URL is assumed to be the URL of the enclosing page. Implementations of InsertingComponentFragmentLocator are registered using the normal Service Provider Interface pattern. A text file named "org.apache.myfaces.trinidad.change.InsertingComponentFragmentLocator" is placed in the META-INF/services directory. This file contains the fully qualified class names of all the InsertingComponentFragmentLocator strategy to register.

See Also:

InsertedComponentFragmentLocator

Constructor Summary

Constructors

Constructor and Description
InsertingComponentFragmentLocator()

Method Summary

Methods

Modifier and Type	Method and Description
abstract String	getInsertedFragmentUrl(javax.faces.context.FacesContext context, javax.faces.component.UIComponent componentToTest, javax.faces.component.UIComponent targetComponent) Returns the URL string of the fragment inserted by componentToTest, or null if this InsertingComponentFragmentLocator could not determine the URL.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InsertingComponentFragmentLocator

public InsertingComponentFragmentLocator()

Method Detail

getInsertedFragmentUrl

public abstract String getInsertedFragmentUrl(javax.faces.context.FacesContext context,
                            javax.faces.component.UIComponent componentToTest,
                            javax.faces.component.UIComponent targetComponent)

Returns the URL string of the fragment inserted by componentToTest, or null if this InsertingComponentFragmentLocator could not determine the URL.

Parameters:

context - The FacesContext instance for current request

componentToTest - The component that possibly inserted the targetComponent. This component will be used to determine the fragment URL for targetComponent. componentToTest will be an ancestor of the targetComponent. EL context will NOT be setup for componentToTest when this method is called.

targetComponent - The component to determine the fragment URL for