Class Reference
%DeepSee.UI.Dialog.WidgetCatalog
Server:basexml
Instance:SOAXML
User:UnknownUser
  
-
  [BASEXML] >  [%DeepSee] >  [UI] >  [Dialog] >  [WidgetCatalog]
Private  Storage

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

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

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 4 13


Summary

This is a Zen Page class. 

Properties
%condition %import %includeFiles %page
%resource align aux backgroundTimerInterval
cellAlign cellSize cellStyle cellVAlign
children composite containerStyle cssLevel
dashboardName dialogTitle disabled disabledStyle
dragAndDrop dragEnabled dropEnabled enclosingClass
enclosingStyle error groupClass groupStyle
height hidden hideApplyButton 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 widgetDescription widgetId widgetNo
width window zenPersistentPopup

Methods
%%OIDGet %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
%Extends %ForceClientRender %GetChildIndex %GetComponent
%GetComponentById %GetComponentByName %GetEventHandlers %GetLinks
%GetPageName %GetParameter %GetValueById %GetValueByName
%GetXMLName %IsA %IsModified %Link
%LinkCSS %LinkScript %MakeId %New
%NormalizeObject %ObjectModified %OnAddToPageAfter %OnAddToPageBefore
%OnAfterCreatePage %OnBeforeCreatePage %OnCreateApplication %OnCreatePage
%OnDetermineCSSLevel %OnDrawEnclosingDiv %OnDrawHTMLBody %OnDrawHTMLHead
%OnDrawHTMLMeta %OnDrawObjectProperties %OnFinishBackgroundTask %OnGetSubtitle
%OnGetTitle %OnMonitorBackgroundTask %OnMutateChildren %OnObjectSynch
%OnSubmit %OnUseSoftModals %OnZENDeserialize %OriginalNamespace
%PackageName %QuoteValue %QuoteValueL10N %RemoveChild
%RemoveChildren %RemoveComponent %RemoveFromSaveSet %RunBackgroundMethod
%Self %SerializeObject %SetBackgroundMethodStatus %SetErrorById
%SetErrorByName %SetModified %SetValueById %SetValueByName
%SetValuesByName %StartScript %ValidateObject %ZENVersion
AddWidgetToDashboard ChangeWidget ConvertParameter Decrypt
DrawWidgetList Encrypt EscapeHTML EscapeURL
HyperEventBody HyperEventCall HyperEventFrame HyperEventHead
Include InsertHiddenField InsertHiddenFields IsPrivate
Link OnHTTPHeader OnPage OnPageError
OnPostHTTP OnPostHyperEvent OnPreHTTP OnPreHyperEvent
Page QuoteJS RemoveFromCatalog RewriteURL
ShowError StartTimer StopTimer ThrowError
UnescapeHTML UnescapeURL XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType addChild addChildAfter
addChildBefore adjustSize btnApply btnOK
cancelPopup childrenMutated correctIELayering createComponent
createComponentNS ctrlKeyDown deleteComponent dialogApply
dialogCancel dialogFinish dialogTitleGet disableButtons
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
dropHandler dropStartHandler endModal exposeComponent
findElement fireOnLoadEvent fireOnResizeEvent fireOnUnloadEvent
fireOnUpdateEvent firePopupAction getChildIndex getComponent
getComponentById getDialogValue getEnclosingDiv getHidden
getHintElement getLabelElement getOpener getProperty
getSettings getType gotoPage invokeSuper
isOfType launchPopupWindow makeId onCreate
onDelete onDisplayHandler onEndModalHandler onPopupAction
onRefreshContents onSerialize onServerMethodCall onServerMethodError
onServerMethodReturn onStartModalHandler ondialogCancel ondialogFinish
ondialogStart ondisabledHandler onkeydownHandler onkeyupHandler
onlayoutHandler onloadHandler onlogoutHandler onoverlayHandler
onresizeHandler onunloadHandler onupdateHandler popupActionHandler
refreshContents removeChild removeFromList render
renderContents renderSVG selectWidget setComponentId
setHidden setOverlayMode setProperty setPropertyAll
setTraceOption startModal startProgressBar stopProgressBar
stripWhitespaces


Parameters

• parameter APPLYBUTTON = 0;
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 widgetDescription as %ZEN.Datatype.string;
Description of selected widget.
• property widgetId as %ZEN.Datatype.string;
Id of selected widget.
• property widgetNo as %ZEN.Datatype.string;
Row number of selected widget.

Methods

• method %OnAfterCreatePage() as %Status
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.
• method AddWidgetToDashboard(pDashboardName As %String, pWidgetTemplateName As %String) as %String [ ZenMethod ]
Add a widget to the given dashboard definition.
• method ChangeWidget(pWidgetTemplateId As %String) as %String [ ZenMethod ]
Display a new preview widget.
• method DrawWidgetList(pSeed As %String) as %Status
Render contents of the widget list.
• classmethod RemoveFromCatalog(pName As %String) as %String [ ZenMethod ]
Remove item from catalog.
• method adjustSize() [ Language = javascript ]
Adjust size and position of components on this page.
• method getDialogValue() [ Language = javascript ]
Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
• 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 removeFromList(name) [ Language = javascript ]
Remove item from catalog.
• method selectWidget(no, id) [ Language = javascript ]
User selected a widget in the list.