This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRISOpens in a new window, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions pageOpens in a new window (login required).

Caché & Ensemble 2018.1.5Opens in a new window > Class Reference > %SYS namespace > %CSP.UI.Portal.Mappings.Template

%CSP.UI.Portal.Mappings.Template

class %CSP.UI.Portal.Mappings.Template extends %CSP.Portal.standardDialog

This class is used internally by Caché. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

Template for Mappings popup dialogs Management Portal

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter APPLICATION = %CSP.UI.Portal.Application;
Class name of application this page belongs to.
parameter APPLYBUTTON = 1;
If true, then this dialog displays an Apply button.
parameter EMSSERVICE = Namespace;
parameter RESOURCE = %Admin_Manage;
Security requirement

Properties (Including Private)

property CPFMapFile as %String;
Property methods: CPFMapFileDisplayToLogical(), CPFMapFileGet(), CPFMapFileIsValid(), CPFMapFileLogicalToDisplay(), CPFMapFileLogicalToOdbc(), CPFMapFileNormalize(), CPFMapFileSet()
property CPFMapName as %String;
Property methods: CPFMapNameDisplayToLogical(), CPFMapNameGet(), CPFMapNameIsValid(), CPFMapNameLogicalToDisplay(), CPFMapNameLogicalToOdbc(), CPFMapNameNormalize(), CPFMapNameSet()
property IsNew as %Boolean [ InitialExpression = $G(%request.Data("$ID2",1),"") = "" ];
Property methods: IsNewDisplayToLogical(), IsNewGet(), IsNewIsValid(), IsNewLogicalToDisplay(), IsNewLogicalToXSD(), IsNewNormalize(), IsNewSet(), IsNewXSDToLogical()
property MappingName as %String (ZENURL = "$ID2");
Property methods: MappingNameDisplayToLogical(), MappingNameGet(), MappingNameIsValid(), MappingNameLogicalToDisplay(), MappingNameLogicalToOdbc(), MappingNameNormalize(), MappingNameSet()
property Namespace as %String (ZENURL = "$ID1");
Property methods: NamespaceDisplayToLogical(), NamespaceGet(), NamespaceIsValid(), NamespaceLogicalToDisplay(), NamespaceLogicalToOdbc(), NamespaceNormalize(), NamespaceSet()
property disabledStyle as %ZEN.Datatype.style [ InitialExpression = "background:darkgray;color:#545454;" ];
Inherited description: Style applied to buttons when automatically disabled.
Property methods: disabledStyleDisplayToLogical(), disabledStyleGet(), disabledStyleIsValid(), disabledStyleLogicalToDisplay(), disabledStyleLogicalToOdbc(), disabledStyleNormalize(), disabledStyleSet()

Methods (Including Private)

method %OnGetSubtitle() as %String
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
clientmethod checkFields() [ Language = javascript ]
Override in subclasses
clientmethod dialogApply() [ Language = javascript ]
Apply the value for this dialog and keep it open. Overriding so that we can disable the ok and apply buttons after.
clientmethod getDialogValue() [ Language = javascript ]
Inherited description: Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
clientmethod ondialogCancel() [ Language = javascript ]
This callback, if defined, is called when the user presses the Cancel button. If this returns false, then the dialog is not cancelled.
clientmethod ondialogFinish(action) as %Boolean [ Language = javascript ]
This callback, if defined, is called when the user presses the OK or Apply action buttons. If this returns false, then the action is cancelled.
clientmethod onloadHandler() [ Language = javascript ]
Inherited description: This client event, if present, is fired when the page is loaded.
clientmethod toggleButtons(flag) [ Language = javascript ]

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Subclasses

FeedbackOpens in a new window