ilog.views.faces.dhtml.renderkit

Class IlvDependencyManager

java.lang.Object

ilog.views.faces.dhtml.renderkit.IlvDependencyManager

public class IlvDependencyManager
extends Object

The IlvDependencyManager manages the dependencies between the components. It should be called by the renderers in their resolveDependencies method to register new ComponentCreationListeners or to notify the creation of new components that can resolve some dependencies.

Since:

JViews 6.0

Constructor Summary

Constructors

Constructor and Description
IlvDependencyManager() Creates a new IlvDependencyManager instance.

Method Summary

Modifier and Type	Method and Description
void	addDependencyListener(javax.faces.component.UIComponent componentRef, String clientId, ComponentCreationListener listener) Adds a dependency listener.
void	addDependencyListener(javax.faces.component.UIComponent componentRef, javax.faces.component.UIComponent depComponent, ComponentCreationListener listener) Adds a dependency listener.
HashMap	getListenerMap()
IlvRendererManager	getRendererManager() Returns the renderer manager instance associated with the manager.
boolean	isRendered(javax.faces.component.UIComponent component) Returns the rendering state of a component.
void	notifyComponentCreation(Writer writer, javax.faces.component.UIComponent component) Notifies the interested listeners of the creation of a component by calling their onComponentCreated method.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvDependencyManager

public IlvDependencyManager()

Creates a new IlvDependencyManager instance.

Method Detail

addDependencyListener

public void addDependencyListener(javax.faces.component.UIComponent componentRef,
                                  String clientId,
                                  ComponentCreationListener listener)

Adds a dependency listener.

Parameters:

componentRef - The base component that resolves the absolute ID of the component that is needed.

clientId - The relative ID of the component that is needed.

listener - The ComponentCreationListener that must be triggered upon creation of the required component.

addDependencyListener

public void addDependencyListener(javax.faces.component.UIComponent componentRef,
                                  javax.faces.component.UIComponent depComponent,
                                  ComponentCreationListener listener)

Adds a dependency listener.

Parameters:

componentRef - The base component that resolves the absolute ID of the component that is needed.

depComponent - The dependency component that is needed.

listener - The ComponentCreationListener that must be triggered upon creation of the required component.

Since:

JViews 6.5

notifyComponentCreation

public void notifyComponentCreation(Writer writer,
                                    javax.faces.component.UIComponent component)
                             throws IOException

Notifies the interested listeners of the creation of a component by calling their onComponentCreated method.

Parameters:

writer - The writer that writes the code to resolve the dependency on the client side.

component - The new component that was created.

Throws:

IOException

getListenerMap

public HashMap getListenerMap()

Returns:

The listeners map.

Internal: do not use!

Returns the listeners map. Used only by the IlvDebugDependencies component.

getRendererManager

public IlvRendererManager getRendererManager()

Returns the renderer manager instance associated with the manager.

Returns:

The renderer manager.

Since:

JViews 6.5

isRendered

public boolean isRendered(javax.faces.component.UIComponent component)

Returns the rendering state of a component.

Parameters:

component - The component to test.

Returns:

True if the component has already been rendered, false otherwise.

Since:

JViews 6.5