Skip to main content

%DeepSee.UI.Dialog.WidgetCatalog

Class %DeepSee.UI.Dialog.WidgetCatalog Extends %DeepSee.UI.Dialog.standardDialog [ System = 4 ]

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

Parameters​

APPLYBUTTON​

Parameter APPLYBUTTON = 0;

Properties​

dashboardName​

Property dashboardName As %ZEN.Datatype.string(ZENURL = "DASHBOARD");

Name of dashbvoard that launched the dialog.

widgetNo​

Property widgetNo As %ZEN.Datatype.string;

Row number of selected widget.

widgetId​

Property widgetId As %ZEN.Datatype.string;

Id of selected widget.

widgetDescription​

Property widgetDescription As %ZEN.Datatype.string;

Description of selected widget.

XDatas​

Style​

XData Style

dialogBody​

XData dialogBody [ XMLNamespace = "http://www.intersystems.com/zen" ]

Contents of the dialog body.

Methods​

%OnPreHTTP​

ClassMethod %OnPreHTTP() As %Boolean [ Internal, ServerOnly = 1 ]

Zen page notification of an HTTP request.

%OnGetTitle​

Method %OnGetTitle() As %String

Get the (localized) title string for the dialog. This should be implemented in a subclass.

%OnGetSubtitle​

Method %OnGetSubtitle() As %String

Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.

getDialogValue​

ClientMethod getDialogValue() [ Language = javascript ]

ondialogFinish​

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.

adjustSize​

ClientMethod adjustSize() [ Language = javascript ]

Adjust size and position of components on this page.

%OnAfterCreatePage​

Method %OnAfterCreatePage() As %Status

selectWidget​

ClientMethod selectWidget(no, id) [ Language = javascript ]

User selected a widget in the list.

DrawWidgetList​

Method DrawWidgetList(pSeed As %String) As %Status

Render contents of the widget list.

AddWidgetToDashboard​

Method AddWidgetToDashboard(pDashboardName As %String, pWidgetTemplateName As %String) As %String [ ZenMethod ]

Add a widget to the given dashboard definition.

ChangeWidget​

Method ChangeWidget(pWidgetTemplateId As %String) As %String [ ZenMethod ]

Display a new preview widget.

removeFromList​

ClientMethod removeFromList(name) [ Language = javascript ]

Remove item from catalog.

RemoveFromCatalog​

ClassMethod RemoveFromCatalog(pName As %String) As %String [ ZenMethod ]

Remove item from catalog.