class %ZEN.Template.ZENElementInspector
extends %ZEN.Template.studioTemplate
Studio Template:
Insert a new ZEN Element within an XData definition.
This is a Zen Page class.
parameter DOMAIN = "%ZEN";
Domain used for localization.
parameter HELPID = "GZEN_element_wizard";
DOCBOOK Topic Id that offers help for this template.
parameter TEMPLATEDESCRIPTION = "Inserts a Zen XML element within a Contents document.";
Short description of the template to show in Studio.
If DOMAIN is defined this will be localized.
parameter TEMPLATEMODE = "template";
What type of template.
parameter TEMPLATENAME = "Zen Element Wizard";
Name of the template to show in Studio.
If DOMAIN is defined this will be localized.
parameter TEMPLATETITLE = "Zen Element Wizard";
Title of the template to show in the template window.
parameter TEMPLATETYPE = "cls";
Comma separated list of 'CSP', 'CSR', 'MAC', 'INT', 'INC',
'BAS', 'CLS' to say what type of code this template
generates; CSP, CSR, Routine, or Class code.
You can also specify '*' for all types.
method %GetDescHTML(pSeed As %String)
as %Status
Provide contents of description component.
method %GetElementHelpHTML(pSeed As %String = "")
as %Status
Provide contents of element help component.
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.
method %OnTemplateAction()
as %Status
This method is called when the template is complete. Any
output to the principal device is returned to the Studio.
method CreateElementRS(Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo)
as %ResultSet
Create the result set used by the Element dataCombo.
classmethod GetElementInfo(pClass As %String)
as %String
[ ZenMethod ]
Return csv-list of properties for the given element.
method canGoBack()
[ Language = javascript ]
Return true if this template can go to the previous page (i.e., enable
the Back button).
method canGoNext()
[ Language = javascript ]
Return true if this template can go to the next page (i.e., enable
the Next button).
method computeGridValue(grid)
[ Language = javascript ]
Convert the value within the property grid to something
we can submit!
method drawPropCell(grid, data)
[ Language = javascript ]
called when cell is about to be drawn in dynaGrid
method elementChange(cb)
[ Language = javascript ]
Notification that the element combo has changed.
method formValidationHandler()
[ Language = javascript ]
Validation handler for form built-into template.
method hasMultiplePages()
[ Language = javascript ]
Return true if this template has more than one "page".
This will display Back and Next buttons.
This is implemented by subclasses.
method htmlRefreshHandler()
[ Language = javascript ]
htmlRefreshHandler
This is called when the HTML help component is refreshed from the server.
method nextPage()
[ Language = javascript ]
Go to the next page of the template (if there is one).
method onPopupAction(popupName, action, value)
[ Language = javascript ]
This client event, if present, is fired when the a popup page
launched from this page fires an action.
method onstartHandler()
[ Language = javascript ]
This is called when the template is first displayed;
This provides a chance to set focus etc.
method previousPage()
[ Language = javascript ]
Go to the previous page of the template (if there is one).
method showValueEditor(propNo)
[ Language = javascript ]
Launch property editor.
propNo is index of property in dataSet.
method tabChange(tabGroup)
[ Language = javascript ]
Notification that a new tab was selected.