Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

%ZEN.Mojo.Plugin.jQM132PageManager

class %ZEN.Mojo.Plugin.jQM132PageManager 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.7 - JBE059 - jQM: Fix hiddenArray.length undefined error 1.0.6 - jQM: Remove a page layout before it is re-rendered (JBE041) 1.0.5 - jQM: Fix $hide, $show, and the hidden attribute (JBE038) 1.0.4 - introducing library version in the classname 1.0.3 - added support for setting a global theme using the property jQueryTheme

Property Inventory

Method Inventory

Parameters

parameter XMLNAME = jQM-1.3.2-PageManager;
This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.

Properties

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 = "jQM-1.3.2-PageManager" ];
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.7" ];
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 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

Inherited Methods

FeedbackOpens in a new tab