API Specification for Context Renderers
This topic describes the methods that Siebel Open UI uses with Context Renderer base class. Any customized context renderer must extend from Base Context Renderer (SiebelAppFacade.BaseCR) and implement following functions:
-
Init Method. Siebel Open UI framework calls the Context Renderer's Init function after instantiating the Context Renderer object. This method is called before the execution of Physical Renderer's life cycle events. For information about physical renderer life cycle events, see Life Cycle of a Physical Renderer.
Siebel Open UI also injects the corresponding physical renderer's instance to this function. The implementation calls the methods supported via the physical renderer's instance.
For example, if the customized context renderer needs to attach a method binding for ShowSelection, it can call AttachPMBinding by implementing the Init function as follows (this example assumes that the method OnShowSelection is defined in the customized Context Renderer):
prContext refers to the corresponding physical renderer instance injected by the Siebel Open UI framework while calling this function.CustomCR.prototype.Init = function ( prContext ) { prContext.AttachPMBinding ( "ShowSelection", OnShowSelection); }
-
Execute Method. Siebel Open UI framework calls the Context Renderer's Execute function immediately after the execution of Physical Renderer's life cycle events. For information about physical renderer life cycle events, see Life Cycle of a Physical Renderer.
Siebel Open UI also injects the corresponding physical renderer's instance to this function. The implementation calls the method supported via the Physical Renderer's instance.
For example, if the context renderer needs to determine the available recordset, it can implement the function as follows:
prContext refers to the corresponding physical renderer instance injected by the Siebel Open UI framework while calling this function.CustomCR.prototype.Execute = function ( prContext ) { var recordSet = prContext.GetPM().Get( "GetRecordSet" ); }