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

%ZEN.Mojo.Plugin.baseHelperPlugin

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

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 = "baseHelperPlugin" ];
The unique name of the helper plugin. All features of this component will be registered using this identifier.
Property methods: pluginNameDisplayToLogical(), pluginNameGet(), pluginNameIsValid(), pluginNameLogicalToDisplay(), pluginNameLogicalToOdbc(), pluginNameNormalize(), pluginNameSet()
property version as %String (XMLPROJECTION = "NONE") [ InitialExpression = "0.0.0" ];
A version string of the base helper plugin. Major/Minor/Build
Property methods: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()

Methods

clientmethod createLayoutObjects(type, instance) [ Language = javascript ]
Create a layout object for a document item. These objects form the layout graph used to render the document. Each layout object contains the context and code needed to render itself.
clientmethod getFeatures() [ Language = javascript ]
Implemented by subclasses. This method returns an array containing objects which describe all layout elements the plugin supports. Each object in the list has to set the property 'identifier' in order to register this layout element for this plugin. In case multiple plugins register for the same feature the documentView component will indicate this conflict. Use the getPluginConflicts method in order to retrieve the conflicts. The first plugin which registers a features will be used for dispatching in case there is a conflict. If you want to change preference use the setPluginMapping method of the documentView
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 registerPlugin(documentView, pageManager) [ 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