%ZEN.Mojo.Component.contentTemplate
class %ZEN.Mojo.Component.contentTemplate extends %ZEN.Component.component, %ZEN.Mojo.localizableObject
A content template defines a set of data and layout documents and custom behaviors (code).Method Inventory
Parameters
parameter DEFAULTVISIBLE = 0;
This component is not visible.
parameter NAMESPACE = http://www.intersystems.com/zen/mojo;
Inherited description: This is the XML namespace used for library components.
Methods
classmethod %OnGetJSONContent(pProviderName As %String, pKey As %String, ByRef pParms, Output pResponse As %RegisteredObject, pCriteria As %RegisteredObject, pLoad As %Boolean = 0) as %Status
Server-side method to provide content to JSON providers.
pProviderName is the name of the provider.
pKey is an app-defined key that is used to indicate which content is to be served.
pCriteriais an object containing criteria. If provided it as a %ZEN.proxyObject
pParms is an array of additional parameters from the JSON provider. (not current used).
pResponse is the object that will be served to the client in JSON format.
pLoad is true is this is called when the page is first being served. In this case, this method will be called even though there may a client-side method used to load the content.
pProviderName is the name of the provider.
pKey is an app-defined key that is used to indicate which content is to be served.
pCriteriais an object containing criteria. If provided it as a %ZEN.proxyObject
pParms is an array of additional parameters from the JSON provider. (not current used).
pResponse is the object that will be served to the client in JSON format.
pLoad is true is this is called when the page is first being served. In this case, this method will be called even though there may a client-side method used to load the content.
classmethod %OnSubmitData(pKey As %String, pID As %String, pSubmitObject As %RegisteredObject, ByRef pResponseObject As %RegisteredObject) as %Status
Submit data handler for content provider.
Overridden by subclasses.
Overridden by subclasses.
clientmethod onGetContent(providerName, key, criteria) [ Language = javascript ]
Client-side content provider method.
providerName is the name of the json provider.
key is the key value associated with the request.
criteria is the search criteria associated with the request.
clientmethod onLoadTemplate() [ Language = javascript ]
Notification that this template was dynamically loaded.
clientmethod onchange(key, value, final, docViewId) [ Language = javascript ]
Notification that a change event has happened
clientmethod onevent(eventType, key, value, docViewId) [ Language = javascript ]
Notification that an event has happened
All events except select and change are handled here
clientmethod onselect(key, value, docViewId) [ Language = javascript ]
Notification that a select event has happened
Inherited Members
Inherited Properties
- %condition
- %import
- %includeFiles
- %page
- %resource
- align
- aux
- composite
- containerStyle
- dragEnabled
- dropEnabled
- enclosingClass
- enclosingStyle
- error
- height
- hidden
- hint
- hintClass
- hintStyle
- id
- index
- label
- labelClass
- labelDisabledClass
- labelStyle
- name
- onafterdrag
- onbeforedrag
- ondrag
- ondrop
- onhide
- onrefresh
- onshow
- onupdate
- parent
- showLabel
- slice
- title
- tuple
- valign
- visible
- width
- window
Inherited Methods
- %AddToSaveSet()
- %Attr()
- %BindExport()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %DrawComponentHTML()
- %DrawHTML()
- %DrawJSStrings()
- %EnclosingDivId()
- %Eval()
- %EvalC()
- %Extends()
- %ForceClientRender()
- %GetEventHandlers()
- %GetMojoJSStrings()
- %GetParameter()
- %GetXMLName()
- %IsA()
- %IsModified()
- %MakeId()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OnAddToPageAfter()
- %OnAddToPageBefore()
- %OnDrawEnclosingDiv()
- %OnDrawObjectProperties()
- %OnObjectSynch()
- %OnZENDeserialize()
- %OriginalNamespace()
- %PackageName()
- %QuoteValue()
- %QuoteValueL10N()
- %RemoveFromSaveSet()
- %Self()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- dragFinishHandler()
- dragHandler()
- dragNotifyHandler()
- dragStartHandler()
- dropHandler()
- dropStartHandler()
- exposeComponent()
- findElement()
- fireOnUpdateEvent()
- getEnclosingDiv()
- getHidden()
- getHintElement()
- getLabelElement()
- getProperty()
- getSettings()
- getType()
- invokeSuper()
- isOfType()
- makeId()
- onCreate()
- onDelete()
- onDisplayHandler()
- onEndModalHandler()
- onPopupAction()
- onRefreshContents()
- onSerialize()
- onStartModalHandler()
- onloadHandler()
- onunloadHandler()
- onupdateHandler()
- refreshContents()
- render()
- renderContents()
- renderSVG()
- setHidden()
- setOverlayMode()
- setProperty()
- startProgressBar()
- stopProgressBar()
Subclasses
- %ZEN.Mojo.PluginDocumentation.Templates.Data.abstractTemplate
- %ZEN.Mojo.PluginDocumentation.Templates.Events.abstractTemplate
- %ZEN.Mojo.PluginDocumentation.Templates.Layout.abstractTemplate
- %ZEN.Mojo.PluginDocumentation.baseTemplate
- %ZEN.Mojo.WidgetReference.HomeTemplate
- %ZEN.Mojo.WidgetReference.bootstrap33xBaseTemplate
- %ZEN.Mojo.WidgetReference.jQM132BaseTemplate