%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
- %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()
- render()
- renderContents()
- renderSVG()
- setProperty()
Subclasses
- %ZEN.Mojo.Plugin.HTML5Helper
- %ZEN.Mojo.Plugin.bootstrap33xHelper
- %ZEN.Mojo.Plugin.charts101Helper
- %ZEN.Mojo.Plugin.chui352Helper
- %ZEN.Mojo.Plugin.chuiHelper
- %ZEN.Mojo.Plugin.dojo1912DChartHelper
- %ZEN.Mojo.Plugin.dojo191DijitHelper
- %ZEN.Mojo.Plugin.dojo2DChartHelper
- %ZEN.Mojo.Plugin.dojoDijitHelper
- %ZEN.Mojo.Plugin.dojoGridX130Helper
- %ZEN.Mojo.Plugin.dojoGridXHelper
- %ZEN.Mojo.Plugin.googleMaps3Helper
- %ZEN.Mojo.Plugin.googleMapsHelper
- %ZEN.Mojo.Plugin.highCharts804Helper
- %ZEN.Mojo.Plugin.jQM132Helper
- %ZEN.Mojo.Plugin.jQM143Helper
- %ZEN.Mojo.Plugin.jQM145Helper
- %ZEN.Mojo.Plugin.jQMHelper
- %ZEN.Mojo.Plugin.mojoDefaultHelper