This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

%CSP.Portal.SourceControl.Dialog.ServerOutput

class %CSP.Portal.SourceControl.Dialog.ServerOutput extends %ZEN.Dialog.standardDialog

Helper dialog to display the server-side output from Source Control classes. This class should only be opened from a class which extends %CSP.Portal.SourceControl.Base. Note that any changes to this class should also be propagated to EnsPortal.Dialog.SourceControlOutput.

Property Inventory

Method Inventory

Parameters

parameter APPLYBUTTON = 0;
Inherited description: If true, then this dialog displays an Apply button.
parameter CANCELBUTTON = 0;
Inherited description: If true, then this dialog displays a Cancel button.

Properties

property isNotZenPopup as %ZEN.Datatype.string (ZENURL = "NOTZENPOPUP");
Flag to avoid certain Zen behaviours regarding the closing of the popup.
Property methods: isNotZenPopupDisplayToLogical(), isNotZenPopupGet(), isNotZenPopupIsValid(), isNotZenPopupLogicalToDisplay(), isNotZenPopupLogicalToOdbc(), isNotZenPopupNormalize(), isNotZenPopupSet()

Methods

method %OnGetSubtitle() as %String
Inherited description: Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
method %OnGetTitle() as %String
Inherited description: Get the (localized) title string for the dialog. This should be implemented in a subclass.
classmethod ClearSCOutput() as %Integer [ ZenMethod ]
Remove the output data from the session.
method DrawButtons(pSeed As %String) as %Status
Draw the clear and refresh buttons.
method DrawOutput(pSeed As %String) as %Status
Write out the contents of the current session's output. If there is no data, write out a non-breaking space for display purposes.
clientmethod clearOutput() [ Language = javascript ]
clear output from the session and update the display. Note that this method is copied in the Ensemble subclass, so any changes also need to be implemented there as well.
clientmethod dialogFinish() [ Language = javascript ]
Override the handling of firePopupAction() for the default case where the popup has not been launched using zenLaunchPopupWindow().
clientmethod getDialogValue() [ Language = javascript ]
This dialog doesn't return a value.
clientmethod ondialogFinish(action) [ Language = javascript ]
Close the window and update the parent when the user is finished with the page.
clientmethod onloadHandler() [ Language = javascript ]
Ensure that we refresh the output (and thus update the parent flag) whenever the user comes back to the popup.
clientmethod onunloadHandler() [ Language = javascript ]
Ensure that the parent page knows when this page gets closed.
clientmethod refreshOutput(array) [ Language = javascript ]
Refresh the output based on the data supplied in array or from the server. This method also hides the new output indicator on the source page. Note that this method is copied in the Ensemble subclass, so any changes also need to be implemented there as well.

Inherited Members

Inherited Properties

Inherited Methods

Feedback