ZENDemo.MethodTest
class ZENDemo.MethodTest extends %ZEN.Component.page
Zen Demo page for methods. This page demonstrates the various ways in which Zen pages can invoke methods.Property Inventory
Method Inventory
- %OnFinishBackgroundTask()
- %OnMonitorBackgroundTask()
- BackgroundTask()
- GetQuickLinks()
- RunBackgroundTask()
- ServerAsynch()
- ServerSynch()
- assertionTest()
- calendarAction()
- clientMethod()
- clientMethodCreate()
- createCustomObject()
- isOfTypeTest()
- methodMixed()
- mgBtnClick()
- modalGroupCal()
- modalGroupDynamic()
- modalGroupMsg()
- modalGroupStatic()
- onloadHandler()
- ontaskHandler()
- refreshHTML()
- serverClassMethod()
- serverClassMethodArgs()
- serverClassMethodWithError()
- serverInstanceMethod()
- serverInstanceMethodArgs()
- serverInstanceMethodCreate()
- serverInstanceMethodDelete()
- serverInstanceMethodMod()
- serverInstanceMethodRet()
- toggleDebugMode()
Parameters
parameter APPLICATION = ZENDemo.Application;
Class name of application this page belongs to.
parameter DOMAIN = ZENDEMO;
Domain used for localization.
parameter PAGENAME = Method Test Page;
Inherited description: Optional. This is the display name used for this page.
If not provided, the class name is used.
Properties
property customClass as ZENTest.customClass;
This property is here to make sure client page includes
definition of customClass.
Property methods: customClassGet(), customClassGetSwizzled(), customClassIsValid(), customClassNewObject(), customClassSet()
Methods
classmethod %OnFinishBackgroundTask(pTaskID As %String)
This server-side callback method is called whenever the client
calls to monitor the current background task and the task is complete.
Typically a subclass uses this to send back JavaScript to update
the page.
classmethod %OnMonitorBackgroundTask(pTaskID As %String, pStatus As %String, pPercentComplete As %Float)
This server-side callback method is called whenever the client
calls to monitor the current background task.
Typically a subclass uses this to send back JavaScript to update
a progress bar.
classmethod BackgroundTask()
This is an example of a task that is run in the background.
classmethod GetQuickLinks(Output pLinks) as %Status
Return an array of quick links to be displayed by the locator bar.
classmethod RunBackgroundTask() [ ZenMethod ]
Run a method in the background.
method ServerAsynch(x As %Integer) [ ZenMethod ]
test
test
clientmethod assertionTest() [ Language = javascript ]
ASSERT test method
clientmethod calendarAction(group) [ Language = javascript ]
User action handler for calendar flaotingGroup.
clientmethod clientMethod() [ Language = javascript ]
Client method
clientmethod clientMethodCreate() [ Language = javascript ]
A client-method that creates a component dynamically
clientmethod createCustomObject() [ Language = javascript ]
Create an instance of the customClass class.
clientmethod isOfTypeTest() [ Language = javascript ]
test the isOfType method
clientmethod methodMixed() [ Language = javascript ]
Test of intermixed Synch and Asynch methods
clientmethod mgBtnClick() [ Language = javascript ]
OK button pressed within static modalGroup.
clientmethod modalGroupCal() [ Language = javascript ]
display a modalGroup calendar
clientmethod modalGroupDynamic() [ Language = javascript ]
display a dynamic modalGroup
clientmethod modalGroupMsg() [ Language = javascript ]
display a modalGroup msgBox
clientmethod modalGroupStatic() [ Language = javascript ]
Display the static modalGroup.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod ontaskHandler(taskInfo) [ Language = javascript ]
Client-side callback to update task status.
taskInfo is an associative array (object) containing task status indexed by taskid.
taskInfo is an associative array (object) containing task status indexed by taskid.
clientmethod refreshHTML() [ Language = javascript ]
Refresh contents of html element.
classmethod serverClassMethod() [ ZenMethod ]
Server class method
classmethod serverClassMethodArgs(p1 As %ZEN.Component.object, p2 As %Integer, p3 As %String) [ ZenMethod ]
Server instance method
classmethod serverClassMethodWithError() [ ZenMethod ]
Server class method with an error to demonstrate
error handling.
method serverInstanceMethod() [ ZenMethod ]
Server instance method
method serverInstanceMethodArgs(p1 As %ZEN.Component.object, p2 As %Integer, p3 As %String) [ ZenMethod ]
Server instance method
method serverInstanceMethodCreate() [ ZenMethod ]
Server instance method with server modifications
method serverInstanceMethodDelete() [ ZenMethod ]
Server instance method with server modifications
method serverInstanceMethodMod() [ ZenMethod ]
Server instance method with server modifications
method serverInstanceMethodRet() as %String [ ZenMethod ]
Server instance method
clientmethod toggleDebugMode(cb, name) [ Language = javascript ]
User click on debug mode checkbox.
Inherited Members
Inherited Properties
- %condition
- %import
- %includeFiles
- %page
- %resource
- align
- aux
- backgroundTimerInterval
- cellAlign
- cellSize
- cellStyle
- cellVAlign
- children
- composite
- containerStyle
- cssLevel
- disabled
- dragAndDrop
- dragEnabled
- dropEnabled
- enclosingClass
- enclosingStyle
- error
- groupClass
- groupStyle
- height
- hidden
- hint
- hintClass
- hintStyle
- id
- index
- label
- labelClass
- labelDisabledClass
- labelPosition
- labelStyle
- layout
- name
- onafterdrag
- onbeforedrag
- onclick
- ondrag
- ondrop
- onhide
- onrefresh
- onshow
- onupdate
- parent
- showLabel
- slice
- title
- tuple
- useSVG
- useSoftModals
- valign
- visible
- width
- window
- zenPersistentPopup
Inherited Methods
- %AddChild()
- %AddChildAfter()
- %AddChildBefore()
- %AddComponent()
- %AddImportedComponents()
- %AddToSaveSet()
- %ApplyURLParms()
- %Attr()
- %BindExport()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %DrawAutoLogout()
- %DrawClassDefinitions()
- %DrawComponentHTML()
- %DrawHTML()
- %DrawHTMLPage()
- %DrawJSStrings()
- %DrawObjectDefinitions()
- %EnclosingDivId()
- %EndBackgroundMethod()
- %EndScript()
- %Eval()
- %EvalC()
- %Extends()
- %ForceClientRender()
- %GetChildIndex()
- %GetComponent()
- %GetComponentById()
- %GetComponentByName()
- %GetEventHandlers()
- %GetLinks()
- %GetPageName()
- %GetParameter()
- %GetValueById()
- %GetValueByName()
- %GetXMLName()
- %IsA()
- %IsModified()
- %Link()
- %LinkCSS()
- %LinkScript()
- %MakeId()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OnAddToPageAfter()
- %OnAddToPageBefore()
- %OnAfterCreatePage()
- %OnBeforeCreatePage()
- %OnCreateApplication()
- %OnCreatePage()
- %OnDetermineCSSLevel()
- %OnDrawEnclosingDiv()
- %OnDrawHTMLBody()
- %OnDrawHTMLHead()
- %OnDrawHTMLMeta()
- %OnDrawObjectProperties()
- %OnMutateChildren()
- %OnObjectSynch()
- %OnPreHTTP()
- %OnSubmit()
- %OnUseSoftModals()
- %OnZENDeserialize()
- %OriginalNamespace()
- %PackageName()
- %QuoteValue()
- %QuoteValueL10N()
- %RemoveChild()
- %RemoveChildren()
- %RemoveComponent()
- %RemoveFromSaveSet()
- %RunBackgroundMethod()
- %Self()
- %SerializeObject()
- %SetBackgroundMethodStatus()
- %SetErrorById()
- %SetErrorByName()
- %SetModified()
- %SetValueById()
- %SetValueByName()
- %SetValuesByName()
- %StartScript()
- %ValidateObject()
- %ZENVersion()
- ConvertParameter()
- Decrypt()
- Encrypt()
- EscapeHTML()
- EscapeURL()
- HyperEventCall()
- HyperEventHead()
- Include()
- InsertHiddenField()
- InsertHiddenFields()
- IsPrivate()
- Link()
- OnHTTPHeader()
- OnPage()
- OnPageError()
- OnPostHTTP()
- OnPostHyperEvent()
- OnPreHTTP()
- OnPreHyperEvent()
- Page()
- QuoteJS()
- RewriteURL()
- ShowError()
- StartTimer()
- StopTimer()
- ThrowError()
- UnescapeHTML()
- UnescapeURL()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- addChild()
- addChildAfter()
- addChildBefore()
- cancelPopup()
- childrenMutated()
- correctIELayering()
- createComponent()
- createComponentNS()
- deleteComponent()
- dragFinishHandler()
- dragHandler()
- dragNotifyHandler()
- dragStartHandler()
- dropHandler()
- dropStartHandler()
- endModal()
- exposeComponent()
- findElement()
- fireOnResizeEvent()
- fireOnUnloadEvent()
- fireOnUpdateEvent()
- firePopupAction()
- getChildIndex()
- getComponent()
- getComponentById()
- getEnclosingDiv()
- getHidden()
- getHintElement()
- getLabelElement()
- getOpener()
- getProperty()
- getSettings()
- getType()
- gotoPage()
- invokeSuper()
- isOfType()
- launchPopupWindow()
- makeId()
- onCreate()
- onDelete()
- onDisplayHandler()
- onEndModalHandler()
- onPopupAction()
- onRefreshContents()
- onSerialize()
- onServerMethodCall()
- onServerMethodError()
- onServerMethodReturn()
- onStartModalHandler()
- ondisabledHandler()
- onkeydownHandler()
- onkeyupHandler()
- onlayoutHandler()
- onlogoutHandler()
- onoverlayHandler()
- onresizeHandler()
- onunloadHandler()
- onupdateHandler()
- popupActionHandler()
- refreshContents()
- removeChild()
- render()
- renderContents()
- renderSVG()
- setComponentId()
- setHidden()
- setOverlayMode()
- setProperty()
- setPropertyAll()
- setTraceOption()
- startModal()
- startProgressBar()
- stopProgressBar()