Open Exchange
Global Masters
Home > Class Reference > ENSLIB namespace > EnsPortal.Dialog.Confirmation
Private  Storage   


class EnsPortal.Dialog.Confirmation extends

Ensemble confirmation dialog that can be used as a replacement for JS alert and confirm boxes. It displays a message and presents one or two buttons with configurable captions and titles. See the parameters and properties that control its behavior and their default values. Button1 takes the role of the OK button and button 2 takes the role of the Apply button except that it also closes the popup. The dialog can have a Cancel button which closes the dialog without notifying the caller page. Examples: zenLaunchPopupWindow('EnsPortal.Dialog.Confirmation.cls?MESSAGE=' + msg,'confirmationDialog','resizable,width=400,height=200'); where msg is a JS variable containing the message to be displayed in the dialog (use \n to include line-breaks in it).

Note: This class is for internal use of the Ensemble Management Portal.


Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 8 5


This is a Zen Page class. It belongs to the application EnsPortal.Application.

%condition %import %includeFiles %page
%resource ActionButtons Button1Caption Button1Title
Button2Caption Button2Title CancelButton Icon
Message align aux backgroundTimerInterval
canEdit cellAlign cellSize cellStyle
cellVAlign children closeOnEnter closeOnEsc
composite containerStyle cssLevel dialogTitle
disabled disabledStyle dragAndDrop dragEnabled
dropEnabled enclosingClass enclosingStyle error
groupClass groupStyle hasButtons height
hidden hideApplyButton hideCancelButton hideOKButton
hint hintClass hintStyle id
index keepAliveInterval label labelClass
labelDisabledClass labelPosition labelStyle layout
msgNotPermitted name onafterdrag onbeforedrag
onclick ondrag ondrop onhide
onrefresh onshow onupdate parent
showLabel slice studioMode title
tuple useSVG useSoftModals valign
visible width window zenPersistentPopup

%AddCSPShareHyperevents %AddChild %AddChildAfter %AddChildBefore
%AddComponent %AddEnsExceptionHandler %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
GetHyperEventResources HyperEventCall HyperEventHead Include
InsertHiddenField InsertHiddenFields IsPrivate Link
OnHTTPHeader OnPage OnPageError OnPostHTTP
OnPostHyperEvent OnPreHTTP OnPreHyperEvent Page
QuoteJS RewriteURL ShowError SimpleKeepAlive
StartTimer StopTimer ThrowError UnescapeHTML
UnescapeURL XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType addChild addChildAfter addChildBefore
addPopupSuffix adjustSize btnApply btnOK
cancelPopup checkEdit childrenMutated clientKeepAlive
correctIELayering createComponent createComponentNS ctrlKeyDown
deleteComponent dialogApply dialogCancel dialogFinish
dialogTitleGet disableButtons dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
endModal exposeComponent findElement fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction getChildIndex
getComponent getComponentById getDialogValue getEnclosingDiv
getHidden getHintElement getLabelElement getOpener
getProperty getSettings getType gotoPage
inResizeLoop initPopupSuffix invokeSuper isOfType
launchPopupWindow makeId onCreate onDelete
onDisplayHandler onEndModalHandler onPopupAction onRefreshContents
onSerialize onServerMethodCall onServerMethodError onServerMethodReturn
onStartModalHandler ondialogCancel ondialogFinish ondialogStart
ondisabledHandler onkeydownHandler onkeyupHandler onlayoutHandler
onloadHandler onlogoutHandler onoverlayHandler onresizeHandler
onunloadHandler onupdateHandler popupActionHandler refreshContents
removeChild removePopupSuffix render renderContents
renderSVG setComponentId setHidden setOverlayMode
setProperty setPropertyAll setTraceOption startKeepAlive
startModal startProgressBar stopKeepAlive stopProgressBar


• parameter APPLYBUTTON = 1;
If true, then this dialog displays an Apply button.
• parameter CANCELBUTTON = 1;
If true, then this dialog displays a Cancel button.
• parameter DOMAIN = "Ensemble";
Localization domain


• property ActionButtons as %ZEN.Datatype.integer(ZENURL="ACTIONBUTTONS") [ InitialExpression = 2 ];
• property Button1Caption as %ZEN.Datatype.string(ZENURL="CAPTION1") [ InitialExpression = $$$TextJS("OK") ];
• property Button1Title as %ZEN.Datatype.string(ZENURL="TITLE1") [ InitialExpression = $$$TextJS("Confirm and close") ];
• property Button2Caption as %ZEN.Datatype.string(ZENURL="CAPTION2") [ InitialExpression = $$$TextJS("Apply") ];
• property Button2Title as %ZEN.Datatype.string(ZENURL="TITLE2") [ InitialExpression = $$$TextJS("Apply and close") ];
• property CancelButton as %ZEN.Datatype.integer(ZENURL="CANCELBUTTON") [ InitialExpression = 0 ];
• property Icon as %ZEN.Datatype.string(ZENURL="ICON") [ InitialExpression = "portal/warning_64.png" ];
• property Message as %ZEN.Datatype.string(ZENURL="MESSAGE") [ InitialExpression = $$$Text("Confirmation") ];


• method %DrawTitle(pSeed As %String) as %Status
Provide HTML for html title box.
Override for DeepSee dialogs.
• method %OnAfterCreatePage() as %Status
Set message and buttons according to parameters.
• method %OnGetTitle() as %String
Get the (localized) title string for the dialog. This should be implemented in a subclass.
• method dialogApply() [ Language = javascript ]
Invoked when user clicks button 2 which is a dialog 'Apply' button. Overriden in order to close the dialog.
• method getDialogValue() [ Language = javascript ]
This is called when the user presses one of the buttons and after ondialogFinish.