This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

%ZEN.Mojo.Plugin.dojoDijitHelper

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

This plugin adds support for the dojo library. It was developed and tested with dojo version 1.9 1.0.4 - corrected apostrophe escaping for $StoreMemory 1.0.3 - corrected some attribute settings to provide proper default values 1.0.2 - decoupled documentation from plugin

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties

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

Methods

clientmethod addProp(properties, instance, property, propertyToAdd, type, defaultValue) [ Language = javascript ]
clientmethod addTabWithDocumentView(docView, tabKey, tabId, tabTitle, newDocView) [ Language = javascript ]
clientmethod clone(obj) [ Language = javascript ]
helper function, adapted from http://stackoverflow.com/questions/728360/most-elegant-way-to-clone-a-javascript-object clones object, arrays, dates, strings, numbers and booleans other types are not supported
clientmethod createDocumentView(layoutKey, dataKey, id) [ Language = javascript ]
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 getDojoTypes() [ Language = javascript ]
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
clientmethod injectDocumentViewIntoContentPane(documentView, key) [ Language = javascript ]
works only for content panes that where created in a static way
clientmethod linkDojoItem() [ 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.
clientmethod registerDojoType(instance) [ Language = javascript ]
Register a dojo type for the require call by specifying the instance
clientmethod registerDojoTypeByType(type) [ Language = javascript ]
Register a dojo type for the require call by specifying the type as string
clientmethod renderGeneric() [ Language = javascript ]
clientmethod renderOptions() [ Language = javascript ]
render
clientmethod renderP() [ Language = javascript ]
render

tags containing the value

clientmethod renderStoreMethods() [ Language = javascript ]
render inline script methods needed for the store api
clientmethod resizeDocumentViewWithinContentPane(documentView, cp) [ Language = javascript ]
clientmethod resizeDocumentViewWithinKey(documentView, key) [ Language = javascript ]
deprecated?

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Feedback