%DeepSee.UI.Dialog.WidgetCatalog

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

This dialog lets the user select a widget template from the DeepSee widget catalog.

Property Inventory

Method Inventory

Parameters

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

Properties

property dashboardName as %ZEN.Datatype.string (ZENURL = "DASHBOARD");
Name of dashbvoard that launched the dialog.
Property methods: dashboardNameDisplayToLogical(), dashboardNameGet(), dashboardNameIsValid(), dashboardNameLogicalToDisplay(), dashboardNameLogicalToOdbc(), dashboardNameNormalize(), dashboardNameSet()
property widgetDescription as %ZEN.Datatype.string;
Description of selected widget.
Property methods: widgetDescriptionDisplayToLogical(), widgetDescriptionGet(), widgetDescriptionIsValid(), widgetDescriptionLogicalToDisplay(), widgetDescriptionLogicalToOdbc(), widgetDescriptionNormalize(), widgetDescriptionSet()
property widgetId as %ZEN.Datatype.string;
Id of selected widget.
Property methods: widgetIdDisplayToLogical(), widgetIdGet(), widgetIdIsValid(), widgetIdLogicalToDisplay(), widgetIdLogicalToOdbc(), widgetIdNormalize(), widgetIdSet()
property widgetNo as %ZEN.Datatype.string;
Row number of selected widget.
Property methods: widgetNoDisplayToLogical(), widgetNoGet(), widgetNoIsValid(), widgetNoLogicalToDisplay(), widgetNoLogicalToOdbc(), widgetNoNormalize(), widgetNoSet()

Methods

method %OnAfterCreatePage() as %Status [ Language = objectscript ]
Inherited description: Be sure to do ##super() when overriding.
method %OnGetSubtitle() as %String [ Language = objectscript ]
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
method %OnGetTitle() as %String [ Language = objectscript ]
Get the (localized) title string for the dialog. This should be implemented in a subclass.
method AddWidgetToDashboard(pDashboardName As %String, pWidgetTemplateName As %String) as %String [ Language = objectscript, ZenMethod ]
Add a widget to the given dashboard definition.
method ChangeWidget(pWidgetTemplateId As %String) as %String [ Language = objectscript, ZenMethod ]
Display a new preview widget.
method DrawWidgetList(pSeed As %String) as %Status [ Language = objectscript ]
Render contents of the widget list.
classmethod RemoveFromCatalog(pName As %String) as %String [ Language = objectscript, ZenMethod ]
Remove item from catalog.
clientmethod adjustSize() [ Language = javascript ]
Adjust size and position of components on this page.
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 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 removeFromList(name) [ Language = javascript ]
Remove item from catalog.
clientmethod selectWidget(no, id) [ Language = javascript ]
User selected a widget in the list.

Inherited Members

Inherited Properties

Inherited Methods

Feedback