This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRISOpens in a new window, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions pageOpens in a new window (login required).

Caché & Ensemble 2018.1.5Opens in a new window > Class Reference > %SYS namespace > %ZEN.Mojo.Plugin.jQMPageManager


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

This plugin adds support for the jQueryMobile library. It was developed and tested with jQM version 1.3.2 and jQuery 1.10.2. - 1.0.3 added support for setting a global theme using the property jQueryTheme

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property jQueryAnimation as %ZEN.Datatype.string [ InitialExpression = "slide" ];
jQM animation used between document push and pop transitions
Property methods: jQueryAnimationDisplayToLogical(), jQueryAnimationGet(), jQueryAnimationIsValid(), jQueryAnimationLogicalToDisplay(), jQueryAnimationLogicalToOdbc(), jQueryAnimationNormalize(), jQueryAnimationSet()
property jQueryTheme as %ZEN.Datatype.string [ InitialExpression = "c" ];
Current jQuery theme for the page. Don't change them after initial set, but use the changeTheme method of the helper plugin instead
Property methods: jQueryThemeDisplayToLogical(), jQueryThemeGet(), jQueryThemeIsValid(), jQueryThemeLogicalToDisplay(), jQueryThemeLogicalToOdbc(), jQueryThemeNormalize(), jQueryThemeSet()
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 = "jQMPageManager" ];
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 suppressStopPropagation as %Boolean (XMLPROJECTION = "NONE") [ InitialExpression = 1 ];
If any plugin sets this flag to true the event handler of the documentView component will not stop the propagation of the event
Property methods: suppressStopPropagationDisplayToLogical(), suppressStopPropagationGet(), suppressStopPropagationIsValid(), suppressStopPropagationLogicalToDisplay(), suppressStopPropagationLogicalToXSD(), suppressStopPropagationNormalize(), suppressStopPropagationSet(), suppressStopPropagationXSDToLogical()
property version as %String (XMLPROJECTION = "NONE") [ InitialExpression = "1.0.3" ];
A version string of the base page manager. Major/Minor/Build
Property methods: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()

Methods (Including Private)

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 getDocumentAttributes(docView, displayMode) [ Language = javascript ]
Returns a string which gets injected as attributes to the
holding the document.
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 (Including Private)

Inherited Methods (Including Private)

FeedbackOpens in a new window