Home > Class Reference > ENSLIB namespace > %ZEN.Mojo.Plugin.basePageManager
Private  Storage   

%ZEN.Mojo.Plugin.basePageManager


abstract class %ZEN.Mojo.Plugin.basePageManager extends
%ZEN.Component.object

This is the base class for all page managers that can be registered at the documentView component. Plugins are intended to take care of the documentView rendering behavior. Additionally they can be enriched with helper plugins that implement supported layout objects.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 6 7


Summary


Properties
%condition %import %includeFiles %page
%resource aux composite id
index name onupdate parent
pluginName suppressCodeExecution suppressRender suppressStopPropagation
tuple version visible window

Methods
%AddToSaveSet %Attr %BindExport %ClassIsLatestVersion
%ClassName %ConstructClone %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawHTML %DrawJSStrings %Eval
%EvalC %Extends %ForceClientRender %GetEventHandlers
%GetParameter %GetXMLName %IsA %IsModified
%MakeId %New %NormalizeObject %ObjectModified
%OnAddToPageAfter %OnAddToPageBefore %OnDrawObjectProperties %OnObjectSynch
%OnZENDeserialize %OriginalNamespace %PackageName %QuoteValue
%QuoteValueL10N %RemoveFromSaveSet %Self %SerializeObject
%SetModified %ValidateObject XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType afterPopDocument afterRenderDocument
checkLibraries findElement fireOnUpdateEvent getDocumentAttributes
getPluginByName getProperty getSettings getType
invokeSuper isOfType makeId onCheckLibraries
onCreate onDelete onSerialize onloadHandler
onunloadHandler onupdateHandler registerPlugins render
renderContents renderSVG setProperty

Subclasses
%ZEN.Mojo.Plugin.chui352PageManager %ZEN.Mojo.Plugin.chuiPageManager %ZEN.Mojo.Plugin.dojo191PageManager
%ZEN.Mojo.Plugin.dojoPageManager %ZEN.Mojo.Plugin.jQM132PageManager %ZEN.Mojo.Plugin.jQM143PageManager
%ZEN.Mojo.Plugin.jQM145PageManager %ZEN.Mojo.Plugin.jQMPageManager %ZEN.Mojo.Plugin.mojoDefaultPageManager

Parameters


• parameter NAMESPACE = "http://www.intersystems.com/zen/mojo";
This is the XML namespace used for library components.

Properties


• property pluginName as %String(XMLPROJECTION="NONE") [ InitialExpression = "basePageManager" ];
The unique name of the PageManager. All features of this component will be registered using this identifier.
• property suppressCodeExecution as %Boolean(XMLPROJECTION="NONE") [ InitialExpression = 0 ];
If any plugin sets this flag to true the renderDocument method of the documentView component will not call the code execution and the plugin is responsible for doing this
• property suppressRender as %Boolean(XMLPROJECTION="NONE") [ InitialExpression = 0 ];
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 suppressStopPropagation as %Boolean(XMLPROJECTION="NONE") [ InitialExpression = 0 ];
If any plugin sets this flag to true the event handler of the documentView component will not stop the propagation of the event
• property version as %String(XMLPROJECTION="NONE") [ InitialExpression = "0.0.0" ];
A version string of the base page manager. Major/Minor/Build

Methods


• method 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.
• method 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!
• final method checkLibraries() [ Language = javascript ]
This method checks that all libraries are loaded for the page manager and the corresponding helper plugins
• method getDocumentAttributes(docView, displayMode) [ Language = javascript ]
Returns a string which gets injected as attributes to the
holding the document.
• method getPluginByName(pluginName) [ Language = javascript ]
• method onCheckLibraries() [ Language = javascript ]
This method is supposed to check that all required libraries have been loaded. Returns true for success, false otherwise.
• final method registerPlugins(documentView) [ Language = javascript ]
This method gets called by the documentView component when it get's rendered the first time. It is used to link the plugin with the documentView component.