class %DeepSee.UI.Dialog.WidgetBuilder
extends %DeepSee.UI.Dialog.standardDialog
This dialog adds (or edits) a new item (such as a widget) to a DeepSee dashboard definition.
This is a Zen Page class.
• parameter APPLYBUTTON = 0;
If true, then this dialog displays an Apply button.
• method %OnAfterCreatePage()
as %Status
Apply changes to page.
• method %OnDrawHTMLHead()
as %Status
Add include files to support color schemes.
• 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.
• method AddWidgetToDashboard(pDashboardName As %String, pWidgetName As %String, pInfo As %ZEN.proxyObject, pPreview As %Boolean = 0)
as %String
[ ZenMethod ]
Add a widget to the given dashboard definition.
If pPreview, then save to the private preview dashboard.
• method CreateWidgetMenu(pMenu As %ZEN.Component.lookoutMenu)
as %Status
Add elements to the widget menu.
• method DrawChartSeries(pWidgetType As %String)
as %Status
Draw contents of chart series box.
• method DrawControlList(pSeed As %String)
as %Status
Draw contents of control list box.
• method DrawDataPropertyList(pSeed As %String)
as %Status
Draw contents of data property list box.
• method DrawWidgetIcon(pInfo As %String)
as %Status
Draw a widget icon box.
pInfo is type^subtype^title^icon
• method DrawWidgetProperties(pWidgetType As %String)
as %Status
Draw contents of widget properties box.
• classmethod GetDimensionInfo(pRoot As %String, Output pTree, ByRef pParms)
as %Status
Place holder for pivot widget dynaTree.
• method SaveWidgetToCatalog(pInfo As %ZEN.proxyObject)
as %String
[ ZenMethod ]
Save the widget to the catalog.
• method addControlDef()
[ Language = javascript ]
Add a control definition.
• method addDataPropertyDef()
[ Language = javascript ]
Add a data property definition.
• method addDataSeriesDef()
[ Language = javascript ]
Add a data series definition.
• method adjustSize()
[ Language = javascript ]
Adjust size and position of components on this page.
• method browseDataSources()
[ Language = javascript ]
Launch the data source finder.
• method browseDrillDataSources()
[ Language = javascript ]
Launch the data source finder.
• method cbSelected(cb, num)
[ Language = javascript ]
Click on control cbox.
• method chooseDataSource(id)
[ Language = javascript ]
Show data source finder for widget property control
• method clearDataSource()
[ Language = javascript ]
Clear the data source.
If there is a local override, first clear it and restore the original value.
• method clearDrillDataSource()
[ Language = javascript ]
Clear the data source.
• method createCopy()
[ Language = javascript ]
Create a copy of this widget.
• method dashboardEventHandler(sourceWidget, which, control, action, target, targetProperty)
[ Language = javascript ]
Central handler for control events on this dashboard.
This is called whenever a control is modified (or otherwise activated).
This is also called when a widget raises an event.
• method dataSourceChange()
[ Language = javascript ]
User edit of dataSource.
• method editControlDef(n)
[ Language = javascript ]
Edit a control definition.
• method editDataPropertyDef(n)
[ Language = javascript ]
Edit a data property definition.
• method editDataSeriesDef(n)
[ Language = javascript ]
Edit a data series definition.
• method getDialogValue()
[ Language = javascript ]
Get the value that will be applied when the user presses the OK button.
This is implemented by subclasses.
• method loadKPI()
[ Language = javascript ]
Launch the KPI finder dialog.
• method loadPivot()
[ Language = javascript ]
Launch the pivot finder dialog.
• method loadWorksheet()
[ Language = javascript ]
Launch the worksheet finder dialog.
• method moveControlDefDown(n)
[ Language = javascript ]
Move a control definition up.
• method moveControlDefUp(n)
[ Language = javascript ]
Move a control definition up.
• method moveDataPropertyDefDown(n)
[ Language = javascript ]
Move a dataProperty definition up.
• method moveDataPropertyDefUp(n)
[ Language = javascript ]
Move a dataProperty definition up.
• method moveDataSeriesDefDown(n)
[ Language = javascript ]
Move a data series definition up.
• method moveDataSeriesDefUp(n)
[ Language = javascript ]
Move a data series definition up.
• method onPopupAction(popupName, action, value)
[ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
• method 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.
• method ondialogStart()
[ Language = javascript ]
This callback, if defined, is called when the dialog page is loaded.
• method removeControlDef(n)
[ Language = javascript ]
Remove a control definition.
• method removeDataPropertyDef(n)
[ Language = javascript ]
Remove a dataProperty definition.
• method removeDataSeriesDef(n)
[ Language = javascript ]
Remove a data series definition.
• method saveToCatalog()
[ Language = javascript ]
Invoke the save widget dialog.
• method selectWidgetSubtype(type)
[ Language = javascript ]
Click on a new widget subtype.
• method selectWidgetType(type, subtype)
[ Language = javascript ]
Click on a new widget type and subtype.
• method togglePreviewMode()
[ Language = javascript ]
Turn widget preview on or off.
• method updatePreview()
[ Language = javascript ]
Update widget preview.
• method widgetPropertyChange()
[ Language = javascript ]
Change in value in a control within the property table.
