DocBook|Search
Class Reference
%Activate.UI.Wizard
   
Server:basexml
Instance:SOAXML
User:UnknownUser
 
-
  [BASEXML] >  [%Activate] >  [UI] >  [Wizard]
Private  Storage  

class %Activate.UI.Wizard extends %ZEN.Template.ObjectGatewayWizard.Template

Activate Wizard

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
6 3 15


Summary

This is a Zen Page class. 

Properties
%condition %import %includeFiles %page
%resource CSPSessionCookie DocumentName DocumentNamespace
Language Namespace Project SelectedText
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 isExit label labelClass
labelDisabledClass labelPosition labelStyle layout
lblExit lblFinish lblNoRespond lblNotExist
msgSelectRows msgTooManyRows name onafterdrag
onbeforedrag onclick ondrag ondrop
onhide onrefresh onshow onupdate
parent showLabel slice title
tuple useSVG useSoftModals valign
visible width window zenPersistentPopup

Methods
%%OIDGet %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 %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 %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
CheckAllBlanks ConvertParameter Decrypt Encrypt
EscapeHTML EscapeURL HyperEventBody HyperEventCall
HyperEventFrame HyperEventHead Include InsertHiddenField
InsertHiddenFields IsEnabled IsPrivate IsValidClassName
Link LocalizeName OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent OnPreHTTP
OnPreHyperEvent Page QuoteJS RewriteURL
SetSelected ShowError StartTimer StopTimer
ThrowError UnescapeHTML UnescapeURL XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType addChild
addChildAfter addChildBefore adjustSize canFinish
canGoBack canGoNext cancelPopup cancelTemplate
childrenMutated correctIELayering createComponent createComponentNS
deleteComponent dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler endModal
exposeComponent findElement finishTemplate fireOnLoadEvent
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent firePopupAction
formValidationHandler getChildIndex getComponent getComponentById
getEnclosingDiv getHidden getHintElement getLabelElement
getOpener getProperty getSettings getType
gotoPage hasMultiplePages hasSelected invokeSuper
isOfType launchPopupWindow makeId nextPage
onCreate onDelete onDisplayHandler onEndModalHandler
onPopupAction onRefreshContents onSerialize onServerMethodCall
onServerMethodError onServerMethodReturn onStartModalHandler ondisabledHandler
onfinishHandler onkeydownHandler onkeyupHandler onlayoutHandler
onloadHandler onlogoutHandler onoverlayHandler onresizeHandler
onstartHandler onunloadHandler onupdateHandler popupActionHandler
previousPage refreshContents removeChild render
renderContents renderSVG rowChecked rowSelected
setComponentId setHidden setOverlayMode setProperty
setPropertyAll setTraceOption showDocumentation showHelp
startModal startProgressBar stopProgressBar updateState
validateRequired


Parameters

• parameter HELPID = "BGAX_using_wizard";
DOCBOOK Topic Id that offers help for this template.
• parameter PAGENAME = "Activate Wizard";
Optional. This is the display name used for this page. If not provided, the class name is used.
• parameter PAGETITLE = "Activate Wizard";
Display title of this page
• parameter TEMPLATEDESCRIPTION = "Activate Wizard";
Short description of the template to show in Studio.
If DOMAIN is defined this will be localized.
• parameter TEMPLATENAME = "Activate Wizard";
Name of the template to show in Studio.
If DOMAIN is defined this will be localized.
• parameter TEMPLATETITLE = "Activate Wizard";
Title of the template to show in the template window.

Properties

• property isExit as %Boolean [ InitialExpression = 0 ];
After user clicks the Finish button, the caption of button Finish becomes Exit,and isExit becomes 1. If btnFinish is clicked when isExit = 1 then we exit out of the wizard.
• property msgSelectRows as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Please select an object reference before clicking FINISH.") ];
• property msgTooManyRows as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("You have selected more than 10 objects and this may take a long time to process. Are you sure you want to do this?") ];

Methods

• 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.
• classmethod CheckAllBlanks(string) as %Boolean [ ZenMethod ]
• classmethod IsEnabled() as %Boolean
Return false from this method to disable this template (for example based on the server platform)
• method SetSelected(selectedRows As %String, package As %String, details As %Boolean) as %Boolean [ ZenMethod ]
Set the selected rows into %session data for the result page Save the package and show details also.
• method canFinish() [ Language = javascript ]
Return true if this template can Finish (i.e., enable the Finish button).
As long as you are on page 2+, Finish is enabled.
• 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 finishTemplate() [ Language = javascript ]
User clicked the Finish button
• method hasMultiplePages() [ Language = javascript ]
Set to true so btnNext and btnBack will show.
• method hasSelected() [ Language = javascript ]
• method nextPage() [ Language = javascript ]
Go to the next page of the template.
• 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.
• method rowChecked(table) [ Language = javascript ]
User checked a checkbox in a row in the table. Show the location and update Finish button.
• method rowSelected(table) [ Language = javascript ]
User selected a row in the table. Show the location.