%DeepSee.UI.Dialog.WidgetWizard
class %DeepSee.UI.Dialog.WidgetWizard extends %DeepSee.UI.Dialog.standardDialog
This dialog creates a new widget for a dashboard.Property Inventory
- controlDefs
- dashboardName
- dataLink
- dataPropertyDefs
- dataSeriesDefs
- dataSource
- drillDownDataSource
- localDataSource
- previewName
- showPreview
- widgetCount
- widgetDescription
- widgetKey
- widgetKeywords
- widgetName
- widgetNames
- widgetOwner
- widgetPropertyArray
- widgetResource
- widgetSubtype
- widgetTemplateName
- widgetType
Method Inventory
- %OnAfterCreatePage()
- %OnGetSubtitle()
- %OnGetTitle()
- AddWidgetToDashboard()
- GetWidgetInfo()
- GetWidgetTypeList()
- adjustSize()
- browseDataSources()
- browseDrillDataSources()
- chooseDataSource()
- clearDataSource()
- clearDrillDataSource()
- dataSourceChange()
- getDialogValue()
- loadKPI()
- loadPivot()
- loadWorksheet()
- onPopupAction()
- ondialogFinish()
- ondialogStart()
- selectWidgetType()
Parameters
parameter APPLYBUTTON = 0;
Inherited description: If true, then this dialog displays an Apply button.
Properties
property controlDefs as list of %DeepSee.Component.controlDefinition;
List of control definitions for the widget.
Property methods: controlDefsBuildValueArray(), controlDefsCollectionToDisplay(), controlDefsCollectionToOdbc(), controlDefsDisplayToCollection(), controlDefsGet(), controlDefsGetObject(), controlDefsGetObjectId(), controlDefsGetSwizzled(), controlDefsIsValid(), controlDefsOdbcToCollection(), controlDefsSet(), controlDefsSetObject(), controlDefsSetObjectId()
property dashboardName as %ZEN.Datatype.string (ZENURL = "DASHBOARD");
Dashboard name.
Property methods: dashboardNameDisplayToLogical(), dashboardNameGet(), dashboardNameIsValid(), dashboardNameLogicalToDisplay(), dashboardNameLogicalToOdbc(), dashboardNameNormalize(), dashboardNameSet()
property dataLink as %ZEN.Datatype.string;
Data link name.
Property methods: dataLinkDisplayToLogical(), dataLinkGet(), dataLinkIsValid(), dataLinkLogicalToDisplay(), dataLinkLogicalToOdbc(), dataLinkNormalize(), dataLinkSet()
property dataPropertyDefs as list of %DeepSee.Component.dataPropertyDefinition;
List of data property definitions for the widget.
Property methods: dataPropertyDefsBuildValueArray(), dataPropertyDefsCollectionToDisplay(), dataPropertyDefsCollectionToOdbc(), dataPropertyDefsDisplayToCollection(), dataPropertyDefsGet(), dataPropertyDefsGetObject(), dataPropertyDefsGetObjectId(), dataPropertyDefsGetSwizzled(), dataPropertyDefsIsValid(), dataPropertyDefsOdbcToCollection(), dataPropertyDefsSet(), dataPropertyDefsSetObject(), dataPropertyDefsSetObjectId()
property dataSeriesDefs as list of %DeepSee.Component.dataSeriesDefinition;
List of data series definitions for the widget.
Property methods: dataSeriesDefsBuildValueArray(), dataSeriesDefsCollectionToDisplay(), dataSeriesDefsCollectionToOdbc(), dataSeriesDefsDisplayToCollection(), dataSeriesDefsGet(), dataSeriesDefsGetObject(), dataSeriesDefsGetObjectId(), dataSeriesDefsGetSwizzled(), dataSeriesDefsIsValid(), dataSeriesDefsOdbcToCollection(), dataSeriesDefsSet(), dataSeriesDefsSetObject(), dataSeriesDefsSetObjectId()
property dataSource as %ZEN.Datatype.string;
Data source name.
Property methods: dataSourceDisplayToLogical(), dataSourceGet(), dataSourceIsValid(), dataSourceLogicalToDisplay(), dataSourceLogicalToOdbc(), dataSourceNormalize(), dataSourceSet()
property drillDownDataSource as %ZEN.Datatype.string;
Drill down data source name.
Property methods: drillDownDataSourceDisplayToLogical(), drillDownDataSourceGet(), drillDownDataSourceIsValid(), drillDownDataSourceLogicalToDisplay(), drillDownDataSourceLogicalToOdbc(), drillDownDataSourceNormalize(), drillDownDataSourceSet()
property localDataSource as %ZEN.Datatype.string;
Local data source name (if any).
Property methods: localDataSourceDisplayToLogical(), localDataSourceGet(), localDataSourceIsValid(), localDataSourceLogicalToDisplay(), localDataSourceLogicalToOdbc(), localDataSourceNormalize(), localDataSourceSet()
property previewName as %ZEN.Datatype.string;
Name of dashboard used to hold preview copy.
Property methods: previewNameDisplayToLogical(), previewNameGet(), previewNameIsValid(), previewNameLogicalToDisplay(), previewNameLogicalToOdbc(), previewNameNormalize(), previewNameSet()
property showPreview as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Should dialog show the widget preview.
Property methods: showPreviewDisplayToLogical(), showPreviewGet(), showPreviewIsValid(), showPreviewLogicalToDisplay(), showPreviewLogicalToOdbc(), showPreviewLogicalToXSD(), showPreviewNormalize(), showPreviewSet(), showPreviewXSDToLogical()
property widgetCount as %ZEN.Datatype.csv (ZENURL = "COUNT");
Number of widgets on dashboard.
Property methods: widgetCountDisplayToLogical(), widgetCountGet(), widgetCountIsValid(), widgetCountLogicalToDisplay(), widgetCountLogicalToOdbc(), widgetCountNormalize(), widgetCountSet()
property widgetDescription as %ZEN.Datatype.string;
Description of the widget (if any).
Property methods: widgetDescriptionDisplayToLogical(), widgetDescriptionGet(), widgetDescriptionIsValid(), widgetDescriptionLogicalToDisplay(), widgetDescriptionLogicalToOdbc(), widgetDescriptionNormalize(), widgetDescriptionSet()
property widgetKey as %ZEN.Datatype.string (ZENURL = "KEY");
Key for widget (if editing).
Property methods: widgetKeyDisplayToLogical(), widgetKeyGet(), widgetKeyIsValid(), widgetKeyLogicalToDisplay(), widgetKeyLogicalToOdbc(), widgetKeyNormalize(), widgetKeySet()
property widgetKeywords as %ZEN.Datatype.string;
Keywords of the saved widget (if any).
Property methods: widgetKeywordsDisplayToLogical(), widgetKeywordsGet(), widgetKeywordsIsValid(), widgetKeywordsLogicalToDisplay(), widgetKeywordsLogicalToOdbc(), widgetKeywordsNormalize(), widgetKeywordsSet()
property widgetName as %ZEN.Datatype.string (ZENURL = "WIDGETNAME");
Name of widget (on the dashboard).
Property methods: widgetNameDisplayToLogical(), widgetNameGet(), widgetNameIsValid(), widgetNameLogicalToDisplay(), widgetNameLogicalToOdbc(), widgetNameNormalize(), widgetNameSet()
property widgetNames as %ZEN.Datatype.csv (ZENURL = "NAMES");
List of current widget names on dashboard.
Property methods: widgetNamesDisplayToLogical(), widgetNamesGet(), widgetNamesIsValid(), widgetNamesLogicalToDisplay(), widgetNamesLogicalToOdbc(), widgetNamesNormalize(), widgetNamesSet()
property widgetOwner as %ZEN.Datatype.string (MAXLEN = 255);
Widget owner.
Property methods: widgetOwnerDisplayToLogical(), widgetOwnerGet(), widgetOwnerIsValid(), widgetOwnerLogicalToDisplay(), widgetOwnerLogicalToOdbc(), widgetOwnerNormalize(), widgetOwnerSet()
property widgetPropertyArray as array of %ZEN.Datatype.string;
Additional name/value pairs for the widget.
Property methods: widgetPropertyArrayBuildValueArray(), widgetPropertyArrayCollectionToDisplay(), widgetPropertyArrayCollectionToOdbc(), widgetPropertyArrayDisplayToCollection(), widgetPropertyArrayDisplayToLogical(), widgetPropertyArrayGet(), widgetPropertyArrayGetObject(), widgetPropertyArrayGetObjectId(), widgetPropertyArrayGetSwizzled(), widgetPropertyArrayIsValid(), widgetPropertyArrayLogicalToDisplay(), widgetPropertyArrayLogicalToOdbc(), widgetPropertyArrayNormalize(), widgetPropertyArrayOdbcToCollection(), widgetPropertyArraySet(), widgetPropertyArraySetObject(), widgetPropertyArraySetObjectId()
property widgetResource as %ZEN.Datatype.string (MAXLEN = 255);
Widget resource.
Property methods: widgetResourceDisplayToLogical(), widgetResourceGet(), widgetResourceIsValid(), widgetResourceLogicalToDisplay(), widgetResourceLogicalToOdbc(), widgetResourceNormalize(), widgetResourceSet()
property widgetSubtype as %ZEN.Datatype.string;
Current selected widget subtype.
Property methods: widgetSubtypeDisplayToLogical(), widgetSubtypeGet(), widgetSubtypeIsValid(), widgetSubtypeLogicalToDisplay(), widgetSubtypeLogicalToOdbc(), widgetSubtypeNormalize(), widgetSubtypeSet()
property widgetTemplateName as %ZEN.Datatype.string;
Name used to save this widget to the catalog!
Property methods: widgetTemplateNameDisplayToLogical(), widgetTemplateNameGet(), widgetTemplateNameIsValid(), widgetTemplateNameLogicalToDisplay(), widgetTemplateNameLogicalToOdbc(), widgetTemplateNameNormalize(), widgetTemplateNameSet()
property widgetType as %ZEN.Datatype.string;
Current selected widget type.
Property methods: widgetTypeDisplayToLogical(), widgetTypeGet(), widgetTypeIsValid(), widgetTypeLogicalToDisplay(), widgetTypeLogicalToOdbc(), widgetTypeNormalize(), widgetTypeSet()
Methods
method %OnAfterCreatePage() as %Status
Apply changes to page.
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.
classmethod GetWidgetInfo(pKey As %String, pInfo As %ZEN.proxyObject) as %String [ ZenMethod ]
Get info on the selected widget.
method GetWidgetTypeList(ByRef pParameters, Output pMetaData, Output pData) as %Status
Return JSON array of widget types.
clientmethod adjustSize() [ Language = javascript ]
Adjust size and position of components on this page.
clientmethod browseDataSources() [ Language = javascript ]
Launch the data source finder.
clientmethod browseDrillDataSources() [ Language = javascript ]
Launch the data source finder.
clientmethod chooseDataSource(id) [ Language = javascript ]
Show data source finder for widget property control
clientmethod clearDataSource() [ Language = javascript ]
Clear the data source.
If there is a local override, first clear it and restore the original value.
clientmethod clearDrillDataSource() [ Language = javascript ]
Clear the data source.
clientmethod dataSourceChange() [ Language = javascript ]
User edit of dataSource.
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 loadKPI() [ Language = javascript ]
Launch the KPI finder dialog.
clientmethod loadPivot() [ Language = javascript ]
Launch the pivot finder dialog.
clientmethod loadWorksheet() [ Language = javascript ]
Launch the worksheet finder dialog.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
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 ondialogStart() [ Language = javascript ]
This callback, if defined, is called when the dialog page is loaded.
clientmethod selectWidgetType(key) [ Language = javascript ]
User selected a widget type.
Inherited Members
Inherited Properties
- %condition
- %import
- %includeFiles
- %page
- %resource
- align
- aux
- backgroundTimerInterval
- cellAlign
- cellSize
- cellStyle
- cellVAlign
- children
- composite
- containerStyle
- cssLevel
- dialogTitle
- disabled
- disabledStyle
- dragAndDrop
- dragEnabled
- dropEnabled
- enclosingClass
- enclosingStyle
- error
- groupClass
- groupStyle
- height
- hidden
- hideApplyButton
- hideCancelButton
- hint
- hintClass
- hintStyle
- id
- index
- label
- labelClass
- labelDisabledClass
- labelPosition
- labelStyle
- layout
- name
- onafterdrag
- onbeforedrag
- onclick
- ondrag
- ondrop
- onhide
- onrefresh
- onshow
- onupdate
- parent
- showLabel
- slice
- title
- tuple
- useSVG
- useSoftModals
- valign
- visible
- width
- window
- zenPersistentPopup
Inherited Methods
- %AddChild()
- %AddChildAfter()
- %AddChildBefore()
- %AddComponent()
- %AddImportedComponents()
- %AddToSaveSet()
- %ApplyURLParms()
- %Attr()
- %BindExport()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %DrawAutoLogout()
- %DrawClassDefinitions()
- %DrawComponentHTML()
- %DrawHTML()
- %DrawHTMLPage()
- %DrawJSStrings()
- %DrawObjectDefinitions()
- %DrawTitle()
- %EnclosingDivId()
- %EndBackgroundMethod()
- %EndScript()
- %Eval()
- %EvalC()
- %Extends()
- %ForceClientRender()
- %GetChildIndex()
- %GetComponent()
- %GetComponentById()
- %GetComponentByName()
- %GetEventHandlers()
- %GetLinks()
- %GetPageName()
- %GetParameter()
- %GetValueById()
- %GetValueByName()
- %GetXMLName()
- %IsA()
- %IsModified()
- %Link()
- %LinkCSS()
- %LinkScript()
- %MakeId()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OnAddToPageAfter()
- %OnAddToPageBefore()
- %OnBeforeCreatePage()
- %OnCreateApplication()
- %OnCreatePage()
- %OnDetermineCSSLevel()
- %OnDrawEnclosingDiv()
- %OnDrawHTMLBody()
- %OnDrawHTMLHead()
- %OnDrawHTMLMeta()
- %OnDrawObjectProperties()
- %OnFinishBackgroundTask()
- %OnMonitorBackgroundTask()
- %OnMutateChildren()
- %OnObjectSynch()
- %OnPreHTTP()
- %OnSubmit()
- %OnUseSoftModals()
- %OnZENDeserialize()
- %OriginalNamespace()
- %PackageName()
- %QuoteValue()
- %QuoteValueL10N()
- %RemoveChild()
- %RemoveChildren()
- %RemoveComponent()
- %RemoveFromSaveSet()
- %RunBackgroundMethod()
- %Self()
- %SerializeObject()
- %SetBackgroundMethodStatus()
- %SetErrorById()
- %SetErrorByName()
- %SetModified()
- %SetValueById()
- %SetValueByName()
- %SetValuesByName()
- %StartScript()
- %ValidateObject()
- %ZENVersion()
- ConvertParameter()
- Decrypt()
- Encrypt()
- EscapeHTML()
- EscapeURL()
- HyperEventCall()
- HyperEventHead()
- Include()
- InsertHiddenField()
- InsertHiddenFields()
- IsPrivate()
- Link()
- OnHTTPHeader()
- OnPage()
- OnPageError()
- OnPostHTTP()
- OnPostHyperEvent()
- OnPreHTTP()
- OnPreHyperEvent()
- Page()
- QuoteJS()
- RewriteURL()
- ShowError()
- StartTimer()
- StopTimer()
- ThrowError()
- UnescapeHTML()
- UnescapeURL()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- addChild()
- addChildAfter()
- addChildBefore()
- btnApply()
- btnOK()
- cancelPopup()
- childrenMutated()
- correctIELayering()
- createComponent()
- createComponentNS()
- ctrlKeyDown()
- deleteComponent()
- dialogApply()
- dialogCancel()
- dialogFinish()
- dialogTitleGet()
- disableButtons()
- dragFinishHandler()
- dragHandler()
- dragNotifyHandler()
- dragStartHandler()
- dropHandler()
- dropStartHandler()
- endModal()
- exposeComponent()
- findElement()
- fireOnResizeEvent()
- fireOnUnloadEvent()
- fireOnUpdateEvent()
- firePopupAction()
- getChildIndex()
- getComponent()
- getComponentById()
- getEnclosingDiv()
- getHidden()
- getHintElement()
- getLabelElement()
- getOpener()
- getProperty()
- getSettings()
- getType()
- gotoPage()
- invokeSuper()
- isOfType()
- launchPopupWindow()
- makeId()
- onCreate()
- onDelete()
- onDisplayHandler()
- onEndModalHandler()
- onRefreshContents()
- onSerialize()
- onServerMethodCall()
- onServerMethodError()
- onServerMethodReturn()
- onStartModalHandler()
- ondialogCancel()
- ondisabledHandler()
- onkeydownHandler()
- onkeyupHandler()
- onlayoutHandler()
- onloadHandler()
- onlogoutHandler()
- onoverlayHandler()
- onresizeHandler()
- onunloadHandler()
- onupdateHandler()
- popupActionHandler()
- refreshContents()
- removeChild()
- render()
- renderContents()
- renderSVG()
- setComponentId()
- setHidden()
- setOverlayMode()
- setProperty()
- setPropertyAll()
- setTraceOption()
- startModal()
- startProgressBar()
- stopProgressBar()
- stripWhitespaces()