This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %ZEN.Mojo.Plugin.chuiPageManager

%ZEN.Mojo.Plugin.chuiPageManager

class %ZEN.Mojo.Plugin.chuiPageManager extends %ZEN.Mojo.Plugin.basePageManager

This plugin adds support for the chocolate-chip UI library. It was developed and tested with chui version 3.5.2

Property Inventory

Method Inventory

Properties

property onPageShow as %ZEN.Datatype.eventHandler;
gets called when a page transition to another document has finished
Property methods: onPageShowDisplayToLogical(), onPageShowGet(), onPageShowIsValid(), onPageShowLogicalToDisplay(), onPageShowLogicalToOdbc(), onPageShowNormalize(), onPageShowSet()
property pluginName as %String [ InitialExpression = "chuiPageManager" ];
The unique name of the Plugin. All features of this plugin will be registered using this identifier.
Property methods: pluginNameDisplayToLogical(), pluginNameGet(), pluginNameIsValid(), pluginNameLogicalToDisplay(), pluginNameLogicalToOdbc(), pluginNameNormalize(), pluginNameSet()
property suppressRender as %Boolean (XMLPROJECTION = "NONE") [ InitialExpression = 1 ];
If any plugin sets this flag to true the documentView component will not inject the HTML into the DOM and will not update when a document level gets popped. The plugin will be responsible to do the rendering using the callbacks afterRenderDocument() and afterPopDocument()
Property methods: suppressRenderDisplayToLogical(), suppressRenderGet(), suppressRenderIsValid(), suppressRenderLogicalToDisplay(), suppressRenderLogicalToXSD(), suppressRenderNormalize(), suppressRenderSet(), suppressRenderXSDToLogical()
property version as %String (XMLPROJECTION = "NONE") [ InitialExpression = "0.5.3" ];
A version string of the base page manager. Major/Minor/Build
Property methods: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()

Methods

clientmethod afterPopDocument(docView, render) [ Language = javascript ]
Gets called after a document level was popped from the stack. The rendering for the transition already started, except suppressRender is set to true by any plugin.
clientmethod afterRenderDocument(docView, displayMode, html) [ Language = javascript ]
Gets called after the HTML for the current document got rendered and is successfully injected into the DOM. If suppressRender is set to true for any registered plugin the HTML is generated but not injected!
clientmethod onCheckLibraries() [ Language = javascript ]
This method is supposed to check that all required libraries have been loaded. Returns true for success, false otherwise.

Inherited Members

Inherited Properties

Inherited Methods