Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%ZEN] >  [Template] >  [WebFormWizard] >  [Home]
Private  Storage   

deprecatedclass %ZEN.Template.WebFormWizard.Home extends %ZEN.Template.WebFormWizard.Template

Studio Template.
Create CSP forms for classes.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
7 3 45


Summary

This is a Zen Page class. 

Properties
%condition %import %includeFiles %page
%resource CSPCHD DocumentName DocumentNamespace
FullClassName Language Namespace Project
SelectedText TreeTotal User align
aux backgroundTimerInterval cellAlign cellSize
cellStyle cellVAlign children composite
containerStyle cssLevel disabled dragAndDrop
dragEnabled dropEnabled enclosingClass enclosingStyle
error groupClass groupStyle height
helpId hidden hint hintClass
hintStyle id index label
labelClass labelDisabledClass labelPosition labelStyle
layout name onafterdrag onbeforedrag
onclick ondrag ondrop onhide
onrefresh onshow onupdate parent
sId showLabel slice title
tuple useSVG useSoftModals valign
visible width window zenPersistentPopup

Methods
%AddChild %AddChildAfter %AddChildBefore %AddComponent
%AddImportedComponents %AddToProject %AddToSaveSet %AddToSourceControl
%ApplyURLParms %Attr %BindExport %ClassIsLatestVersion
%ClassName %ConstructClone %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawAutoLogout %DrawClassDefinitions %DrawComponentHTML
%DrawHTML %DrawHTMLPage %DrawJSStrings %DrawObjectDefinitions
%DrawTitle %EnclosingDivId %EndBackgroundMethod %EndScript
%Eval %EvalC %Extends %ForceClientRender
%GetChildIndex %GetComponent %GetComponentById %GetComponentByName
%GetDescHTML %GetDescHTML2 %GetDescHTML3 %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 %OnFinishBackgroundTask
%OnMonitorBackgroundTask %OnMutateChildren %OnObjectSynch %OnPreHTTP
%OnSubmit %OnTemplateAction %OnUseSoftModals %OnZENDeserialize
%OriginalNamespace %PackageName %QuoteValue %QuoteValueL10N
%RemoveChild %RemoveChildren %RemoveComponent %RemoveFromSaveSet
%RunBackgroundMethod %Self %SerializeObject %SetBackgroundMethodStatus
%SetClassName %SetErrorById %SetErrorByName %SetModified
%SetValueById %SetValueByName %SetValuesByName %StartScript
%TemplateHeader %ValidateObject %ZENVersion ConvertKeyNameToIntName
ConvertParameter Decrypt Encrypt EscapeHTML
EscapeURL GetOptionsList GetParameterList GetSearchList
HyperEventCall HyperEventHead Include InsertHiddenField
InsertHiddenFields IsEnabled IsPrivate IsValidClassName
JavaInstalled Link LocalizeName OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page PopulateAttributeList
PopulateClassList PopulateQueryList PopulateRefPropList PopulateRefQueryColumn
QuoteJS RewriteURL SaveAttribute SavePropList
ShowError ShowRef StartTimer StopTimer
ThrowError UnescapeHTML UnescapeURL WriteConField
WriteFields WriteFormFooter WriteFormHeader WriteJS
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore adjustSize
arrowClicked canFinish canGoBack canGoNext
cancelPopup cancelTemplate childrenMutated correctIELayering
createComponent createComponentNS deleteComponent doSettings
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
dropHandler dropStartHandler endModal exposeComponent
findElement finishTemplate fireOnResizeEvent fireOnUnloadEvent
fireOnUpdateEvent firePopupAction formValidationHandler getChildIndex
getClassName getComponent getComponentById getEnclosingDiv
getHidden getHintElement getLabelElement getOpener
getProperty getSettings getType gotoPage
hasMultiplePages invokeSuper isOfType launchPopupWindow
loadFields loadProperties locationChange lstFieldsClick
lstQueryColumnClick lstQueryNameClick makeId moveBack
moveBackAll moveTo moveToAll moveUpDown
nextPage onCreate onDelete onDisplayHandler
onEndModalHandler onPopupAction onRefreshContents onSerialize
onServerMethodCall onServerMethodError onServerMethodReturn onStartModalHandler
ondisabledHandler onfinishHandler onhandleAutoLogoutWarn onkeydownHandler
onkeyupHandler onlayoutHandler onloadHandler onlogoutHandler
onoverlayHandler onresizeHandler onstartHandler onunloadHandler
onupdateHandler popupActionHandler previousPage refreshContents
removeChild render renderContents renderSVG
setComponentId setHidden setOverlayMode setProperty
setPropertyAll setTraceOption showDocumentation showHelp
startModal startProgressBar stopProgressBar treeClick
updateAttribute updateState


Parameters

• parameter DOMAIN = "%ZEN";
Domain used for localization.
• parameter PAGETITLE = "Web Form Wizard";
Display title of this page
• parameter TEMPLATEDESCRIPTION = "Create a CSP form for a Cache class.";
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 = "Web Form Wizard";
Name of the template to show in Studio.
If DOMAIN is defined this will be localized.
• parameter TEMPLATETITLE = "Web Form Wizard";
Title of the template to show in the template window.
• parameter TEMPLATETYPE = "cls,csp";
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.

Properties

• property FullClassName as %ZEN.Datatype.string;
User selected class name
• property TreeTotal as %ZEN.Datatype.integer;
• property sId as %ZEN.Datatype.string [ InitialExpression = $select($isObject($get(%session)):%session.SessionId,1:$j) ];

Methods

• method %GetDescHTML(pSeed As %String) as %Status
Provide contents of description component for tab1.
• method %GetDescHTML2(pSeed As %String) as %Status
Provide contents of description component for tab2.
• method %GetDescHTML3(pSeed As %String) as %Status
Provide contents of description component for tab3.
• 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 ConvertKeyNameToIntName(Key) as %String
*************************************************************** /// * The following methods are for generating code for a form. * /// *************************************************************** /// Check for JavaScript name identifiers. If invalid characters (including foreign language) exist in a property name, then that property name will not be used in the field name on the new generated form. Instead, a "fieldNN" name will be used where NN is the unique "findex" number.
• method GetOptionsList(Layout) as %String
Build option list based on user's Settings
• method GetParameterList(clsName, sIntName)
This module is called to heck if ValueList and DisplayList exist. If yes, build SELECT box.
• method GetSearchList(sId, clsName) as %String
Loop through the selected properties. Add to search list if the property is searchable
• classmethod PopulateAttributeList(pRoot As %String, Output pTree, ByRef pParms) as %Status
Load fields into Available/Selected list boxes. ClassMethod PopulateAttributeList(NAMESPACE, FullClassName, sId) As %Boolean [ ZenMethod ]
• classmethod PopulateClassList(pRoot As %String, Output pTree, ByRef pParms) as %Status
Build tree for class names
• classmethod PopulateQueryList(sId, sName) as %String [ ZenMethod ]
User wants to create Drop-down for refclass. Return Query Name choices.
• classmethod PopulateRefPropList(sId, sName) as %String [ ZenMethod ]
User wants to show reference as Pull-down menu and has selected a Query Name. Return Query Column choices.
• classmethod PopulateRefQueryColumn(sId, sName) as %String [ ZenMethod ]
User wants to show reference as Search button or Hyperlink. Return Query Column choices.
• classmethod SaveAttribute(sId, sName, sField, sValue) [ ZenMethod ]
• classmethod SavePropList(sId, sValue) as %Boolean [ ZenMethod ]
Save the selected property list into %session for processing
• classmethod ShowRef(sName) as %ZEN.proxyObject [ ZenMethod ]
Given property name, decide now what type of attribute we should show. idAttr1 = show reference idAttr2 = show collection or multiline idAttr3 = show image idAttr4 = show Pull-down menu for reference
• method WriteConField(clsName, sId, sName, Layout, gsAlign, sBold1, sBold2)
Write out HTML code: Write out code for individual field
• method WriteFields(sId, clsName, Layout, bReq)
Write out HTML code: Loop through all selected fields Set indicator (bReq) for whether there is at least one required field for footer.
• method WriteFormFooter(clsName, Layout, bReq)
Write out HTML code: form footer and finish
• method WriteFormHeader(sId, clsName, Layout)
Write out HTML code for form header
• method WriteJS(sId, clsName, Layout)
Write out Javascript code for page
• method arrowClicked() [ Language = javascript ]
User clicked one of the arrows or double clicked.
• method canFinish() [ Language = javascript ]
Return true if this template can Finish (i.e., enable the Finish button).
This is implemented by subclasses.
• method canGoBack() [ Language = javascript ]
Return true if this template can go to the previous page (i.e., enable the Back button).
This is implemented by subclasses.
• method canGoNext() [ Language = javascript ]
Return true if this template can go to the next page (i.e., enable the Next button).
• method formValidationHandler() [ Language = javascript ]
Validation handler for form built-into template.
• method getClassName() [ Language = javascript ]
Return currently selected package and classname
• 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 loadFields() [ Language = javascript ]
Load selected properties into fields box on tab3
• method loadProperties() [ Language = javascript ]
Load properties for selected table
• method locationChange(ctrl) [ Language = javascript ]
This is called when the user changes the Location control(s).
• method lstFieldsClick(ctrl) [ Language = javascript ]
User clicked a selected property in lstFields on tab3. Fill in caption and determine if the reference radiobuttons should be shown.
• method lstQueryColumnClick(ctrl) [ Language = javascript ]
User selected a Query Column for reference class. Save the selection and enable fields.
• method lstQueryNameClick(ctrl) [ Language = javascript ]
User selected a Query Name for reference class. Save the selection and load the Query Columns field.
• method moveBack() [ Language = javascript ]
Move item from listbox to tree
• method moveBackAll() [ Language = javascript ]
Move item from listbox to tree
• method moveTo() [ Language = javascript ]
Move item from tree to listbox
• method moveToAll() [ Language = javascript ]
Select the entire list from tree to the list, marking tree item style as selected
• method moveUpDown(flag) [ Language = javascript ]
Moving item in a listbox up and down
• method nextPage() [ Language = javascript ]
Go to the next page of the template (if there is one).
This is implemented by subclasses.
• 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).
This is implemented by subclasses.
• method treeClick(gonext) [ Language = javascript ]
User clicked an item in the tree
• method updateAttribute(ctrl) [ Language = javascript ]
User changed an attribute field. Save it to temp array.


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.