IRISLIB database
Controller Class Reference

This utility class provides a centralized place for managing events between the client and the server. More...

Static Public Member Functions

_.Library.String InvokeClassMethod (_.Library.String pPageClass, _.Library.String pClass, _.Library.String pMethod, _.Library.String pRetType, _.Library.Boolean pSyncFlag, _.Library.String pHeader, _.Library.String pBody, _.Library.String pSpec, _.Library.String pArgs, _.Library.String pNamespace, _.Library.Integer pThreadId)
 This method is called from the client when it wants to. More...
 
 InvokeInstanceMethod (_.Library.String pPageClass, _.Library.Integer pObjIndex, _.Library.String pMethod, _.Library.String pRetType, _.Library.Boolean pSyncFlag, _.Library.String pHeader, _.Library.String pBody, _.Library.String pSpec, _.Library.String pArgs, _.Library.String pNamespace, _.Library.Integer pThreadId)
 This method is called from the client when it wants to. More...
 
 OnEndSession ()
 Called when the session is about to be deleted.
 
 OnPostHTTP (_.Library.String pPageClass)
 PostHTTP handler shared by all ZEN pages.
 
_.Library.Boolean OnPostHyperEvent (_.Library.String pPageClass)
 PostHyperEvent handler shared by all ZEN pages.
 
_.Library.Boolean OnPreHTTP (_.Library.String pPageClass, _.Library.Boolean pClientCache, _.Library.Boolean pAutoNS, _.Library.String pResource, _.Library.String pContentType, _.Library.Boolean pIframeallowed)
 PreHTTP handler shared by all ZEN pages.
 
_.Library.Boolean OnPreHyperEvent (_.Library.String pPageClass, _.Library.String pMethod, _.Library.Boolean pAutoNS, _.Library.String pResource)
 PreHyperEvent handler shared by all ZEN pages.
 

Static Private Member Functions

_.Library.Integer BeginChangeTracking ()
 Start capturing changes to objects.
 
_.Library.String BeginJSTranslation ()
 This method begins JS translation of Write commands. More...
 
_.Library.Status ChangeNS (_.Library.String pNS)
 Change namespace for the context of this page (see the AUTONS parameter)
 
_.Library.Status DeserializePage (_.Library.String pHeader, _.Library.String pBody, pObjects)
 Takes the serialized state of a set of client components and. More...
 
 EndChangeTracking (_.Library.Integer pMaxIndex, _.Library.String pMode, _.Library.String pTrace)
 Stop capturing changes to objects;. More...
 
 EndJSTranslation (_.Library.String pToken)
 This method ends JS translation of Write commands.
 
_.Library.RegisteredObject GetOREF (_.Library.Integer orefint)
 Internal helper method: convert integer to oref. More...
 
_.Library.String GetStackTrace (_.Library.Integer pIgnoreTop)
 Returns a stack trace, pass pIgnoreTop if you want to skip any stack levels at the top. More...
 
_.Library.Status InvokeFormSubmitCallback (_.Library.String pClass, _.Library.String pMethod, _.ZEN.Submit pSubmit)
 Invoke the OnSubmitForm callback for a form.
 
_.Library.Status InvokeFormSubmitHandler (_.ZEN.Submit pSubmit)
 For a bound form, invoke the submit handler for the associated. More...
 
_.Library.Status MaterializeComposites ()
 Internal method. More...
 
_.Library.Status SetNS (_.Library.String pNS)
 Specify a target namespace for any links we generate.
 

Detailed Description

This utility class provides a centralized place for managing events between the client and the server.


There are no user-callable methods within this class.

Member Function Documentation

◆ BeginJSTranslation()

_.Library.String BeginJSTranslation ( )
staticprivate

This method begins JS translation of Write commands.

Returns a token that should be passed along to EndJSTranslation

◆ DeserializePage()

_.Library.Status DeserializePage ( _.Library.String  pHeader,
_.Library.String  pBody,
  pObjects 
)
staticprivate

Takes the serialized state of a set of client components and.

recreates the set of server-side objects.
On return, pObjects is array of objects subscripted by component index.
As a side-effect it will set page.

◆ EndChangeTracking()

EndChangeTracking ( _.Library.Integer  pMaxIndex,
_.Library.String  pMode,
_.Library.String  pTrace 
)
staticprivate

Stop capturing changes to objects;.

Generate JS to sync client to server changes. If pMode is "page" then this is called at page render time. pTrace is provided for diagnostic purposes.

◆ GetOREF()

_.Library.RegisteredObject GetOREF ( _.Library.Integer  orefint)
staticprivate

Internal helper method: convert integer to oref.

[Previously private]

◆ GetStackTrace()

_.Library.String GetStackTrace ( _.Library.Integer  pIgnoreTop)
staticprivate

Returns a stack trace, pass pIgnoreTop if you want to skip any stack levels at the top.

If you want the stack from the most recent error or exception, then pass -1 for pIgnoreTop, otherwise $ECODE is cleared and $STACK gives the current stack. This method is not called anywhere, but is available for debugging.

◆ InvokeFormSubmitHandler()

_.Library.Status InvokeFormSubmitHandler ( _.ZEN.Submit  pSubmit)
staticprivate

For a bound form, invoke the submit handler for the associated.

DataModel class.

◆ MaterializeComposites()

_.Library.Status MaterializeComposites ( )
staticprivate

Internal method.


This method tests if there are any unmaterialized composite elements on the current page. If any are present they will be materialized (their children are created).

◆ InvokeClassMethod()

_.Library.String InvokeClassMethod ( _.Library.String  pPageClass,
_.Library.String  pClass,
_.Library.String  pMethod,
_.Library.String  pRetType,
_.Library.Boolean  pSyncFlag,
_.Library.String  pHeader,
_.Library.String  pBody,
_.Library.String  pSpec,
_.Library.String  pArgs,
_.Library.String  pNamespace,
_.Library.Integer  pThreadId 
)
static

This method is called from the client when it wants to.

invoke a class method.
pPageClass is the class name of the page invoking the method.
pClass is the class name.
pMethod is the method name.
pRetType is the client type of the return type (or "").
pHeader is the header section of the serial state.
pBody is the body section of the serial state.
pSpec is the method signature: "L,L,O" (L = Literal, B = Boolean, O = Object).
pArgs is the serialized set of arguments. ($C(4) delimited).
pNamespace is the namespace to run in.

◆ InvokeInstanceMethod()

InvokeInstanceMethod ( _.Library.String  pPageClass,
_.Library.Integer  pObjIndex,
_.Library.String  pMethod,
_.Library.String  pRetType,
_.Library.Boolean  pSyncFlag,
_.Library.String  pHeader,
_.Library.String  pBody,
_.Library.String  pSpec,
_.Library.String  pArgs,
_.Library.String  pNamespace,
_.Library.Integer  pThreadId 
)
static

This method is called from the client when it wants to.

invoke an instance method for a component. pPageClass is the class name of the page invoking the method.
pObjIndex is the index of this object.
pMethod is the method name.
pRetType is the client type of the return type (or "").
pHeader is the header section of the serial state.
pBody is the body section of the serial state.
pSpec is the method signature: "L,L,O" (L = Literal, B = Boolean, O = Object).
pArgs is the serialized set of arguments. ($C(4) delimited).
pNamespace is the namespace to run in.