This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

%ZEN.Mojo.Wizard.MojoWizard

class %ZEN.Mojo.Wizard.MojoWizard extends %ZEN.Template.studioTemplate

This class is used internally by InterSystems. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

Method Inventory (Including Private)

Parameters

parameter DOMAIN = %ZEN;
Domain used for localization.
parameter HELPID = GZCP_forms;
DOCBOOK Topic Id that offers help for this template.
parameter TEMPLATEDESCRIPTION = Creates a stub of a Zen Mojo application with parameters for includes, providers, application, home page and template class;
Inherited description: Short description of the template to show in Studio.
If DOMAIN is defined this will be localized.
parameter TEMPLATEGROUP = Zen;
Inherited description: If this is a TEMPLATEMODE="new" then this is the name of the tab in Studio this template is dispayed on. If none specified then it displays on 'Custom' tab.
parameter TEMPLATEMODE = new;
What type of template.
parameter TEMPLATENAME = Zen Mojo Site;
Inherited description: Name of the template to show in Studio.
If DOMAIN is defined this will be localized.
parameter TEMPLATETITLE = Zen Mojo Wizard;
Inherited description: Title of the template to show in the template window.
parameter TEMPLATETYPE = cls;
Inherited description: 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.

Methods

method %GetDescHTML(pSeed As %String) as %Status
Provide contents of description component on the first tab.
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.
classmethod CreateMojo(tPackage As %String, tPageClassName As %String, tPageName As %String, tTemplateName As %String, tAppClassName As %String, tAppName As %String, tDomain As %String, tJSInc As %String, tCSSInc As %String, tPageManager As %String, tHelperPlugins As %String) as %Status
method CreatePackageRS(Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet
Create the result set used by the Package dataCombo.
classmethod CreateZenApp(appClassName As %String, pkgName As %String, applicationname As %String, pageName As %String) as %Status
classmethod CreateZenMojoHomePage(pageClass As %String, pkgName As %String, application As %String, pageName As %String, templateClass As %String, domain As %String, jsIncludes As %String, cssIncludes As %String, tPageManager As %String, tHelperPlugins As %String) as %Status
classmethod CreateZenMojoTemplate(tempName As %String, pkgName As %String, application As %String, domain As %String, pageName As %String, pPageManager As %String) as %Status
method HelperPluginsRS(Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet
Create the result set used by the Helper Plugins dataList
method PageManagerRS(Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet
Create the result set used by the PageManager dataCombo.
clientmethod canGoNext() [ Language = javascript ]
Return true if this template can go to the next page (i.e., enable the Next button).
clientmethod deselectHelper(index) [ Language = javascript ]
clientmethod hasMultiplePages() [ Language = javascript ]
Inherited description: Return true if this template has more than one "page". This will display Back and Next buttons. This is implemented by subclasses.
clientmethod selectHelper(index) [ Language = javascript ]

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Feedback