Skip to main content

%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.

Property Inventory

Method Inventory

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.
Property methods: helpIdDisplayToLogical(), helpIdGet(), helpIdIsValid(), helpIdLogicalToDisplay(), helpIdLogicalToOdbc(), helpIdNormalize(), helpIdSet()

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)
clientmethod canFinish() [ Language = javascript ]
Return true if this template can Finish (i.e., enable the Finish button).
This is implemented by subclasses.
clientmethod 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.
clientmethod 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.
clientmethod formValidationHandler() [ Language = javascript ]
Validation handler for form built-into template.
clientmethod 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.
clientmethod nextPage() [ Language = javascript ]
Go to the next page of the template (if there is one).
This is implemented by subclasses.
clientmethod onfinishHandler() [ Language = javascript ]
This is called when the template is finished;
clientmethod onkeydownHandler(evt) [ Language = javascript ]
This client event, if present, is fired when a keydown event occurs on the page.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod onstartHandler() [ Language = javascript ]
This is called when the template is first displayed; This provides a chance to set focus etc.
clientmethod previousPage() [ Language = javascript ]
Go to the previous page of the template (if there is one).
This is implemented by subclasses.
clientmethod showDocumentation(topic) [ Language = javascript ]
Open a browser window to show documentation.
clientmethod 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.
clientmethod 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.
clientmethod 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.

Inherited Members

Inherited Properties

Inherited Methods

Subclasses

FeedbackOpens in a new tab