Home > Class Reference > ENSLIB namespace > EnsPortal.Dialog.Confirmation

EnsPortal.Dialog.Confirmation

class EnsPortal.Dialog.Confirmation extends EnsPortal.Dialog.standardDialog

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 Management Portal.

Property Inventory

Method Inventory

Parameters

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

Properties

property ActionButtons as %ZEN.Datatype.integer (ZENURL = "ACTIONBUTTONS") [ InitialExpression = 2 ];
Property methods: ActionButtonsDisplayToLogical(), ActionButtonsGet(), ActionButtonsIsValid(), ActionButtonsLogicalToDisplay(), ActionButtonsLogicalToOdbc(), ActionButtonsNormalize(), ActionButtonsSet()
property Button1Caption as %ZEN.Datatype.string (ZENURL = "CAPTION1") [ InitialExpression = $$$TextJS("OK") ];
Property methods: Button1CaptionDisplayToLogical(), Button1CaptionGet(), Button1CaptionIsValid(), Button1CaptionLogicalToDisplay(), Button1CaptionLogicalToOdbc(), Button1CaptionNormalize(), Button1CaptionSet()
property Button1Title as %ZEN.Datatype.string (ZENURL = "TITLE1") [ InitialExpression = $$$TextJS("Confirm and close") ];
Property methods: Button1TitleDisplayToLogical(), Button1TitleGet(), Button1TitleIsValid(), Button1TitleLogicalToDisplay(), Button1TitleLogicalToOdbc(), Button1TitleNormalize(), Button1TitleSet()
property Button2Caption as %ZEN.Datatype.string (ZENURL = "CAPTION2") [ InitialExpression = $$$TextJS("Apply") ];
Property methods: Button2CaptionDisplayToLogical(), Button2CaptionGet(), Button2CaptionIsValid(), Button2CaptionLogicalToDisplay(), Button2CaptionLogicalToOdbc(), Button2CaptionNormalize(), Button2CaptionSet()
property Button2Title as %ZEN.Datatype.string (ZENURL = "TITLE2") [ InitialExpression = $$$TextJS("Apply and close") ];
Property methods: Button2TitleDisplayToLogical(), Button2TitleGet(), Button2TitleIsValid(), Button2TitleLogicalToDisplay(), Button2TitleLogicalToOdbc(), Button2TitleNormalize(), Button2TitleSet()
property CancelButton as %ZEN.Datatype.integer (ZENURL = "CANCELBUTTON") [ InitialExpression = 0 ];
Property methods: CancelButtonDisplayToLogical(), CancelButtonGet(), CancelButtonIsValid(), CancelButtonLogicalToDisplay(), CancelButtonLogicalToOdbc(), CancelButtonNormalize(), CancelButtonSet()
property Icon as %ZEN.Datatype.string (ZENURL = "ICON") [ InitialExpression = "portal/warning_64.png" ];
Property methods: IconDisplayToLogical(), IconGet(), IconIsValid(), IconLogicalToDisplay(), IconLogicalToOdbc(), IconNormalize(), IconSet()
property Message as %ZEN.Datatype.string (ZENURL = "MESSAGE") [ InitialExpression = $$$Text("Confirmation") ];
Property methods: MessageDisplayToLogical(), MessageGet(), MessageIsValid(), MessageLogicalToDisplay(), MessageLogicalToOdbc(), MessageNormalize(), MessageSet()

Methods

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

Inherited Members

Inherited Properties

Inherited Methods