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.Manager

class %CSP.Portal.SourceControl.Dialog.Manager extends %CSP.Portal.Template

Wrapper class to correctly manage popups requested by Source Control hooks.

Property Inventory

Method Inventory

Parameters

parameter PAGENAME = Source Control Dialog;
Inherited description: Displayed name of this page.

Properties

property %CSSLevel as %String;
Property to indicate whether a specific CSS Level should be used for the page. By default, we will attempt to use CSS Level 3 if we can detect the browser supports HTML 5. The value can be modified by implementing the GetPortalPageOptions() callback defined in %Studio.SourceControl.Base.
Property methods: %CSSLevelDisplayToLogical(), %CSSLevelGet(), %CSSLevelIsValid(), %CSSLevelLogicalToDisplay(), %CSSLevelLogicalToOdbc(), %CSSLevelNormalize(), %CSSLevelSet()
property %UseIEEdge as %Boolean [ InitialExpression = 1 ];
Flag to indicate whether the IE=Edge meta tag should be written out to force Internet Explorer to use its most recent rendering engine. By default, the portal does write out this flag, but users can disable the flag by implementing the GetPortalPageOptions() callback defined in %Studio.SourceControl.Base to specify that IE Compatibility should be permitted.
Property methods: %UseIEEdgeDisplayToLogical(), %UseIEEdgeGet(), %UseIEEdgeIsValid(), %UseIEEdgeLogicalToDisplay(), %UseIEEdgeLogicalToXSD(), %UseIEEdgeNormalize(), %UseIEEdgeSet(), %UseIEEdgeXSDToLogical()
property targetURL as %String);
Property methods: targetURLDisplayToLogical(), targetURLGet(), targetURLIsValid(), targetURLLogicalToDisplay(), targetURLLogicalToOdbc(), targetURLNormalize(), targetURLSet()

Methods

method %OnAfterCreatePage() as %Status
Point the iframe at the URL specified in targetURL.
method %OnDetermineCSSLevel() as %Integer
If the source control hooks a specific CSS level is specified in %CSSLevel, return the value, otherwise use the default for the portal.
method %OnDrawHTMLMeta() as %Status
If the source control hooks specify that IE Edge mode should NOT be used, ensure that we don't invoke the code to write out the corresponding meta tag.
clientmethod addCompletionCheck(checkFunc, time) [ Language = javascript ]
Adds a JS Interval which executes the supplied function at the supplied interval.
clientmethod checkCompletion() [ Language = javascript ]
Check whether the contents of the iframe have been completely loaded, and close the window if it's a Studio template, otherwise add the source control specific onbeforeunload event handling.
clientmethod clearCompletionChecks() [ Language = javascript ]
Remove any intervals created while waiting for source control frames to load. Primarily used to check on the status of the popup.
clientmethod initializeFrame(newSrc) [ Language = javascript ]
Code to resize the iframe based on the window size and check whether a title
clientmethod onlayoutHandler(load) [ Language = javascript ]
Inherited description: This client event, if present, is fired when the page is first loaded or whenever it is resized.
If this is called at load time, then load will be true.
clientmethod updateTitle() [ Language = javascript ]
Update the title of the main window based on the title of the inner iframe.

Inherited Members

Inherited Properties

Inherited Methods

Feedback