org.itsnat.comp

Interface CreateItsNatComponentListener

public interface CreateItsNatComponentListener

This listener type is used to add new user defined components to the framework. If it was previously registered the listener is called when the framework needs to create a component instance.

Author:

Jose Maria Arranz Santamaria

See Also:

ItsNatComponentManager.createItsNatComponent(Node,String,NameValue[]), ItsNatDocumentTemplate.addCreateItsNatComponentListener(CreateItsNatComponentListener)

Method Summary

Methods

Modifier and Type	Method and Description
ItsNatComponent	after(ItsNatComponent comp) Is called after a component was created (user or framework defined).
ItsNatComponent	before(Node node, String compType, NameValue[] artifacts, ItsNatComponentManager compMgr) Is called before calling the default component factory of the framework.

Method Detail

before

ItsNatComponent before(Node node,
                     String compType,
                     NameValue[] artifacts,
                     ItsNatComponentManager compMgr)

Is called before calling the default component factory of the framework. This is an opportunity to create a user defined component because the returned object will be used by the framework if non-null, if returned null the framework will use the next user defined factory if any or the default factory.

Method parameters are the same as the factory method ItsNatComponentManager.createItsNatComponent(Node,String,NameValue[])

Parameters:

node - the node to associate the new component.

compType - the component type, may be null.

artifacts - declared artifacts, may be null.

compMgr - the component manager used to create the component.

Returns:

the new component, if null the framework will use the next user defined factory if any or the default factory.

after

ItsNatComponent after(ItsNatComponent comp)

Is called after a component was created (user or framework defined). This is the opportunity to initialize the component before is returned to normal use. In fact nothing prevents to return a different component (component replaced) or return null (component rejected).

Parameters:

comp - the component to initialize/replace/reject, never is null.

Returns:

the same component, a different component or null.