Home > Class Reference > ENSLIB namespace > %CSP.UI.Portal.Dialog.WizardTemplate
Private  Storage   

%CSP.UI.Portal.Dialog.WizardTemplate


abstract class %CSP.UI.Portal.Dialog.WizardTemplate extends %CSP.Portal.standardDialog

Wizard style template for System Management Portal.
Zen-based SMP wizard dialogs with multiple pages extend this class.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 1 17


Summary


This is a Zen Page class. 

Properties
%condition %import %includeFiles %page
%resource FirstFailed InvalidParam IsEMSReadOnly
ValidationErrorMsg align aux backgroundTimerInterval
cellAlign cellSize cellStyle cellVAlign
children composite containerStyle cssLevel
dialogTitle disabled disabledStyle dragAndDrop
dragEnabled dropEnabled enclosingClass enclosingStyle
error groupClass groupStyle height
helpId hidden hideApplyButton hideCancelButton
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

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 %DrawTitle %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 %OnFinishBackgroundTask %OnGetSubtitle
%OnGetTitle %OnMonitorBackgroundTask %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 EvalResult HyperEventCall
HyperEventHead Include InsertHiddenField InsertHiddenFields
IsEnabled 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 adjustSize btnApply
btnOK canFinish canGoBack canGoNext
cancelPopup childrenMutated correctIELayering createComponent
createComponentNS ctrlKeyDown deleteComponent dialogApply
dialogCancel dialogFinish dialogTitleGet disableButtons
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
dropHandler dropStartHandler endModal exposeComponent
findElement fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent
firePopupAction formValidationHandler getChildIndex getComponent
getComponentById getDialogValue getEnclosingDiv getHidden
getHintElement getLabelElement getOpener getProperty
getSettings getType gotoPage hasMultiplePages
invokeSuper isOfType launchPopupWindow makeId
nextPage onCreate onDelete onDisplayHandler
onEndModalHandler onPopupAction onRefreshContents onSerialize
onServerMethodCall onServerMethodError onServerMethodReturn onStartModalHandler
ondialogCancel ondialogFinish ondialogStart ondisabledHandler
onfinishHandler onkeydownHandler onkeyupHandler onlayoutHandler
onloadHandler onlogoutHandler onoverlayHandler onresizeHandler
onstartHandler onunloadHandler onupdateHandler popupActionHandler
previousPage refreshContents removeChild render
renderContents renderSVG resetMsg setComponentId
setHidden setOverlayMode setProperty setPropertyAll
setTraceOption showDocumentation showHelp showMsg
startModal startProgressBar stopProgressBar updateState
validateRequired

Subclasses
%CSP.UI.Portal.Dialog.Broadcast %CSP.UI.Portal.Dialog.Compile %CSP.UI.Portal.Dialog.DBMirrorAdd
%CSP.UI.Portal.Dialog.DatabaseDelete %CSP.UI.Portal.Dialog.DatabaseWizard %CSP.UI.Portal.Dialog.ECPDataServer
%CSP.UI.Portal.Dialog.Export %CSP.UI.Portal.Dialog.ExportResource %CSP.UI.Portal.Dialog.Import
%CSP.UI.Portal.Dialog.Integ %CSP.UI.Portal.Dialog.IntegLog %CSP.UI.Portal.Dialog.NamespaceDelete
%CSP.UI.Portal.Dialog.ProcessTerminate %CSP.UI.Portal.Dialog.RemoteDatabase %CSP.UI.Portal.Dialog.Resource
%CSP.UI.Portal.Dialog.RoleResourceEdit %CSP.UI.Portal.Dialog.SQLReportGenerator %CSP.UI.Portal.Dialog.SQLStatementDetails
%CSP.UI.Portal.Dialog.SQLTuneTables %CSP.UI.Portal.Dialog.SQLView %CSP.UI.Portal.Dialog.Service
%CSP.UI.Portal.Dialog.ShadowDBMapping %CSP.UI.Portal.Mirror.Dialog.AddAsync %CSP.UI.Portal.Mirror.Dialog.AsyncEdit
%CSP.UI.Portal.Mirror.Dialog.AsyncRemoveConfig %CSP.UI.Portal.Mirror.Dialog.AsyncStopTracking %CSP.UI.Portal.Mirror.Dialog.EditFilter
%CSP.UI.Portal.Mirror.Dialog.FailoverRemoveConfig %CSP.UI.Portal.Mirror.Dialog.FailoverRemoveOthers %CSP.UI.Portal.Mirror.Dialog.JoinNewMember
%CSP.UI.Portal.Mirror.Dialog.NodeAddressEdit %CSP.UI.Portal.Mirror.Dialog.RemoveLocalConfig %CSP.UI.Portal.Mirror.Dialog.SSL
%iKnow.UI.Dialog.CreateUserDictionaryEntry %iKnow.UI.Dialog.addDomain %iKnow.UI.Dialog.dropDomain

Parameters


• parameter AUTONS = 1;
If $NAMESPACE is set, auto switch namespace
• parameter HELPID;
DOCBOOK Topic Id that offers help for this template.
• parameter TEMPLATETITLE;
Title of the template to show in the template window.

Properties


• property helpId as %ZEN.Datatype.string [ InitialExpression = ..#HELPID ];
DocBook topic id used to show help for this template.

Methods


• method %DrawTitle(pSeed As %String) as %Status
Provide HTML for standard template html title box.
• classmethod IsEnabled() as %Boolean
Return false from this method to disable this template (for example based on the server platform)
• 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).
This is implemented by subclasses.
• 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 nextPage() [ Language = javascript ]
Go to the next page of the template (if there is one).
This is implemented by subclasses.
• method onfinishHandler() [ Language = javascript ]
This is called when the template is finished;
• method onkeydownHandler(evt) [ Language = javascript ]
This client event, if present, is fired when a keydown event occurs on the page.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• 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 showDocumentation(topic) [ Language = javascript ]
Open a browser window to show documentation.
• method showHelp() [ Language = javascript ]
Show the help message for this template. This opens a browser and goes to the DocBook application using the value given by helpId.
• method updateState() [ Language = javascript ]
Update the state of the template buttons. Subclasses should call this method when they need to update the state of the footer buttons.
• method validateRequired(ctl, pass, type, checkRange, minVal, maxVal) as %Boolean [ Language = javascript ]
Validate the control value. pass is either "true" or "false" indicating if there is already a field that failed validation. Type is "N" for numeric or "S" for string. If numeric, if checkRange is true, we additionally validate that the number is between minVal and maxVal, inclusive.