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

%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.

Property Inventory

Method Inventory

Parameters

parameter NAMESPACE = http://www.intersystems.com/zen/mojo;
Inherited description: 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 methods: pluginNameDisplayToLogical(), pluginNameGet(), pluginNameIsValid(), pluginNameLogicalToDisplay(), pluginNameLogicalToOdbc(), pluginNameNormalize(), pluginNameSet()
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 methods: suppressCodeExecutionDisplayToLogical(), suppressCodeExecutionGet(), suppressCodeExecutionIsValid(), suppressCodeExecutionLogicalToDisplay(), suppressCodeExecutionLogicalToXSD(), suppressCodeExecutionNormalize(), suppressCodeExecutionSet(), suppressCodeExecutionXSDToLogical()
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 methods: suppressRenderDisplayToLogical(), suppressRenderGet(), suppressRenderIsValid(), suppressRenderLogicalToDisplay(), suppressRenderLogicalToXSD(), suppressRenderNormalize(), suppressRenderSet(), suppressRenderXSDToLogical()
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 methods: suppressStopPropagationDisplayToLogical(), suppressStopPropagationGet(), suppressStopPropagationIsValid(), suppressStopPropagationLogicalToDisplay(), suppressStopPropagationLogicalToXSD(), suppressStopPropagationNormalize(), suppressStopPropagationSet(), suppressStopPropagationXSDToLogical()
property version as %String (XMLPROJECTION = "NONE") [ InitialExpression = "0.0.0" ];
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!
final clientmethod checkLibraries() [ Language = javascript ]
This method checks that all libraries are loaded for the page manager and the corresponding helper plugins
clientmethod getDocumentAttributes(docView, displayMode) [ Language = javascript ]
Returns a string which gets injected as attributes to the
holding the document.
clientmethod getPluginByName(pluginName) [ Language = javascript ]
clientmethod onCheckLibraries() [ Language = javascript ]
This method is supposed to check that all required libraries have been loaded. Returns true for success, false otherwise.
final clientmethod 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.

Inherited Members

Inherited Properties

Inherited Methods

Subclasses