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.
This is a Zen Page class.
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.
property helpId
as %ZEN.Datatype.string [ InitialExpression = ..#HELPID ];
DocBook topic id used to show help for this template.
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.