deprecatedclass %iKnow.UI.Dialog.buildDomain
extends %ZEN.Dialog.standardDialog
This is a Zen Page class.
• parameter APPLYBUTTON = 0;
If true, then this dialog displays an Apply button.
• parameter CANCELBUTTON = 0;
If true, then this dialog displays a Cancel button.
• parameter DOMAIN = "%iKnow";
Localization domain
• parameter RESOURCE = "%Development";
This is a comma-delimited list of system Resources and associated
permissions. A user must hold the specified permissions on at least
one of the specified resources in order to view this page or
invoke any of its server-side methods from the client.
The format of each item in the list should be as follows:
Resource[:Permission]
Permission is optional, and defaults to USE if not supplied. If it
is supplied, it should be one of USE, READ or WRITE.
• method %OnAfterCreatePage()
as %Status
This callback is called after the server-side page
object and all of its children are created.
Subclasses can override this to add, remove, or modify
items within the page object model, or to provide values
for controls.
• 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.
• method %OnGetSubtitle()
as %String
Get the (localized) subtitle string for the dialog.
This should be implemented in a subclass.
• method %OnGetTitle()
as %String
Get the (localized) title string for the dialog.
This should be implemented in a subclass.
• 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.
• method BuildDomain()
as %Status
[ ZenMethod ]
• classmethod IsValidClassName(pClassName As %String)
as %Boolean
[ ZenMethod ]
Test if the given class name is valid.
• method getDialogValue()
[ Language = javascript ]
Get the value that will be applied when the user presses the OK button.
This is implemented by subclasses.
• method ondialogFinish(action)
[ Language = javascript ]
This callback, if defined, is called when the user presses the OK or Apply action buttons.
If this returns false, then the action is cancelled.
• method ondialogStart()
[ Language = javascript ]
This callback, if defined, is called when the dialog page is loaded.
