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 > %DeepSee.UI.Dialog.ListingGroupAdd


class %DeepSee.UI.Dialog.ListingGroupAdd extends %DeepSee.UI.Dialog.standardDialog

This dialog allows the user to define a new Listing Group

Property Inventory (Including Private)

Method Inventory (Including Private)


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

Properties (Including Private)

property msgClass as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Please enter a valid class name.") ];
Property methods: msgClassDisplayToLogical(), msgClassGet(), msgClassIsValid(), msgClassLogicalToDisplay(), msgClassLogicalToOdbc(), msgClassNormalize(), msgClassSet()
property msgDefineRequest as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Please define a new Listing Group.") ];
Property methods: msgDefineRequestDisplayToLogical(), msgDefineRequestGet(), msgDefineRequestIsValid(), msgDefineRequestLogicalToDisplay(), msgDefineRequestLogicalToOdbc(), msgDefineRequestNormalize(), msgDefineRequestSet()
property msgGroup as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("A listing group name must be defined.") ];
Property methods: msgGroupDisplayToLogical(), msgGroupGet(), msgGroupIsValid(), msgGroupLogicalToDisplay(), msgGroupLogicalToOdbc(), msgGroupNormalize(), msgGroupSet()

Methods (Including Private)

method %OnAfterCreatePage() as %Status
Inherited description: This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.
method %OnGetSubtitle() as %String
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
method %OnGetTitle() as %String
Get the (localized) title string for the dialog. This should be implemented in a subclass.
classmethod IsValidClassName(pClassName As %String) as %Boolean [ ZenMethod ]
Test if the given class name is valid.
method SaveData(pClassName) as %String [ ZenMethod ]
Save general association data to server and compile.
classmethod TrimSpaces(pName As %String) as %String [ ZenMethod ]
Remove all spaces inside a string.
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 nameChanged(value, field) [ Language = javascript ]
Take steps to clean the user modified name for the listing group.
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 ]
This client event, if present, is fired when the page is loaded.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

FeedbackOpens in a new window