Home > Class Reference > ENSLIB namespace > %ZEN.Mojo.Plugin.mojoDefaultHelper

%ZEN.Mojo.Plugin.mojoDefaultHelper

class %ZEN.Mojo.Plugin.mojoDefaultHelper extends %ZEN.Mojo.Plugin.baseHelperPlugin

This plugin adds basic support and helper layout objects. 1.0.9 - add support for $ignoreSelect 1.0.8 - only inject eventHandler for $content for layout objects that define a key 1.0.7 - add support for $if 1.0.6 - package this plugin into the core of Zen Mojo 1.0.5 - decoupled documentation from plugin 1.0.4 - removed the generated div block around $content element to allow easier styling 1.0.3 - updated documentation to reflect current state

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter SYSMODULE = core;
Inherited description: If set, this indicates that this system component should be placed in the given "module". A module is a grouping of components within the same class package that share common include (js or css) files. Note that certain root classes are implicitly placed within the "core" module.
Classes outside of the Zen library should not set this, they should use the MODULE instead.

Properties (Including Private)

property pluginName as %String (XMLPROJECTION = "NONE") [ InitialExpression = "mojoDefaultHelper" ];
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 version as %String (XMLPROJECTION = "NONE") [ InitialExpression = "1.0.9" ];
A version string of the base helper plugin. Major/Minor/Build
Property methods: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()

Methods (Including Private)

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 ]
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

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)