EnsPortal.Template.base
abstract class EnsPortal.Template.base
Property Inventory
Method Inventory
- %AddCSPShareHyperevents()
- %AddEnsExceptionHandler()
- SimpleKeepAlive()
- addPopupSuffix()
- clientKeepAlive()
- inResizeLoop()
- initPopupSuffix()
- onServerMethodError()
- removePopupSuffix()
- startKeepAlive()
- stopKeepAlive()
Parameters
parameter DOMAIN = Ensemble;
parameter USEKEEPALIVE = 1;
Control whether we use a KeepAlive in subclasses of this page.
Properties
property keepAliveInterval as %ZEN.Datatype.integer [ InitialExpression = $select(..#USEKEEPALIVE: ($select(%session.AppTimeout < 60: %session.AppTimeout - 2, 1: %session.AppTimeout - 30)) * 1000, 1: 0) ];
The interval in milliseconds at which keepalive events should be triggered.
A value of 0 is used when USEKEEPALIVE is 0 - this indicates that no keepalive is in use.
The default value is 30 seconds less than the CSP application timeout, but this is reduced to 2 seconds less than the timeout if the timeout is
less than 60 seconds.
Property methods: keepAliveIntervalDisplayToLogical(), keepAliveIntervalGet(), keepAliveIntervalIsValid(), keepAliveIntervalLogicalToDisplay(), keepAliveIntervalLogicalToOdbc(), keepAliveIntervalNormalize(), keepAliveIntervalSet()
Methods
Add a modified version of cspIntHttpServerMethod to the page to force
hyperevents to specify CSPSHARE in requests to the server.
Add centralised error handling for standard pages and dialogue windows.
Simple method for the client to call.
clientmethod addPopupSuffix(popupName) [ Language = javascript ]
Add a suffix to the popup name to avoid name collisions.
clientmethod clientKeepAlive() [ Language = javascript ]
Simple call back to the server.
clientmethod inResizeLoop() [ Language = javascript ]
Helper method to allow pages to detect when they are in a resize loop under IE8.
clientmethod initPopupSuffix() [ Language = javascript ]
clientmethod onServerMethodError(err, errObject) [ Language = javascript ]
Override onServerMethodError to funnel HyperEvent errors through the
central Ensemble exception handling code.
If session pollution occurs while in Studio mode, alert the user to the problem instead of reloading.
The method sets zenPage._staleStudioSession to true to ensure that an alert is displayed only once and subsequent
hyperevent failures will not trigger a reload of the page.
clientmethod removePopupSuffix(popupName) [ Language = javascript ]
Strip the suffix from a popup name created by addPopupSuffix()().
clientmethod startKeepAlive() [ Language = javascript ]
Start the client keepalive.
clientmethod stopKeepAlive() [ Language = javascript ]
Stop the client keepalive.