%ZEN.Mojo.Plugin.dojo191DijitHelper
class %ZEN.Mojo.Plugin.dojo191DijitHelper 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.10 - NAN026 - add support for $hide and $show to dojo plugin 1.0.9 - minor fixes to $refresh logic 1.0.8 - add support for $ignoreSelect and $ignoreChange 1.0.7 - implement $refresh logic 1.0.6 - correcting event handling in Firefox 1.0.5 - introducing library version in the classname 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 pluginProperty Inventory
Method Inventory
- addProp()
- addTabWithDocumentView()
- clone()
- createDocumentView()
- createLayoutObjects()
- getDojoTypes()
- getFeatures()
- injectDocumentViewIntoContentPane()
- linkDojoItem()
- onCheckLibraries()
- refreshGeneric()
- registerDojoType()
- registerDojoTypeByType()
- renderGeneric()
- renderOptions()
- renderP()
- renderStoreMethods()
- resizeDocumentViewWithinContentPane()
- resizeDocumentViewWithinKey()
Parameters
parameter XMLNAME = dojo-1.9.1-DijitHelper;
This parameter provides the default XMLNAME for the class. If it is
empty then the class name will be used to construct a default XML name.
The default XMLNAME is used as the top level tag
when exporting objects and the export context
did not provide an XML container name.
Properties
property pluginName as %String (XMLPROJECTION = "NONE") [ InitialExpression = "dojo-1.9.1-DijitHelper" ];
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.10" ];
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, refreshMode) [ 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 refreshGeneric() [ Language = javascript ]
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
- %condition
- %import
- %includeFiles
- %page
- %resource
- aux
- composite
- id
- index
- name
- onupdate
- parent
- tuple
- visible
- window
Inherited 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()
- findElement()
- fireOnUpdateEvent()
- getProperty()
- getSettings()
- getType()
- invokeSuper()
- isOfType()
- makeId()
- onCreate()
- onDelete()
- onSerialize()
- onloadHandler()
- onunloadHandler()
- onupdateHandler()
- registerPlugin()
- render()
- renderContents()
- renderSVG()
- setProperty()