class %DeepSee.Component.Portlet.abstractPortlet extends
%ZEN.Component.component, %ZEN.Component.dataView

Base class for DeepSee Dashboard portlets.
A portlet is a specialized Zen component that can be plugged into a DeepSee dashboard to supply customized content.


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 1 6


%condition %controller %import %includeFiles
%page %resource align aux
composite containerStyle controller controllerId
dragEnabled dropEnabled enclosingClass enclosingStyle
error height hidden hint
hintClass hintStyle id index
label labelClass labelDisabledClass labelStyle
name onafterdrag onbeforedrag ondrag
ondrop onhide onnotifyView onrefresh
onshow onupdate parent settings
showLabel slice title tuple
valign visible width window

%AddToSaveSet %Attr %BindExport %ClassIsLatestVersion
%ClassName %ConstructClone %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawComponentHTML %DrawHTML %DrawJSStrings
%EnclosingDivId %Eval %EvalC %Extends
%ForceClientRender %GetEventHandlers %GetParameter %GetXMLName
%IsA %IsModified %MakeId %New
%NormalizeObject %ObjectModified %OnAddToPageAfter %OnAddToPageBefore
%OnDrawEnclosingDiv %OnDrawObjectProperties %OnGetPortletIcon %OnGetPortletName
%OnGetPortletSettings %OnObjectSynch %OnZENDeserialize %OriginalNamespace
%PackageName %QuoteValue %QuoteValueL10N %RemoveFromSaveSet
%Self %SerializeObject %SetModified %ValidateObject
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
adjustContentSize dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler exposeComponent
findElement fireOnUpdateEvent getController getEnclosingDiv
getHidden getHintElement getLabelElement getProperty
getSettings getType invokeSuper isOfType
makeId onApplyFilters onCreate onDelete
onDisplayHandler onEndModalHandler onPopupAction onRefreshContents
onSerialize onStartModalHandler onloadHandler onunloadHandler
onupdateHandler refreshContents render renderContents
renderSVG sendEventToController setControllerId setHidden
setOverlayMode setProperty startProgressBar stopProgressBar


• parameter NAMESPACE = "http://www.intersystems.com/deepsee";
This is the XML namespace used for library components.


• property settings as %String [ MultiDimensional ];
MultiDimensional property containing the current settings values for this portlet.


• method %DrawHTML()
Static HTML display method: draw the BODY of this component as HTML.
This should be overridden in subclasses.
• classmethod %OnGetPortletIcon() as %String
Return the URL of the icon to display for this portlet. This is displayed in the Widget Builder dialog. This should be overridden in subclasses.
• classmethod %OnGetPortletName() as %String
Return the localized caption of this portlet. This is displayed in the Widget Builder dialog. This should be overridden in subclasses.
• classmethod %OnGetPortletSettings(Output pInfo As %List, ByRef pSettings) as %Status
Return an optional array of "settings" values for this portlet.
The list of settings is displayed in the Widget Builder where the user can view and edit them. When the portlet is rendered, the values of all settings is made available to the portlet's %DrawHTML method via the settings--a multidimensional array subscripted by setting name.
On return, pInfo can contain a list of settings in the form:
pInfo(n) = $LB(name,value,type,caption,title)
name is the logical name of the setting.
value is the default value of the setting.
type indicates the type of the setting. This determines the control displayed to get the value of the setting. If omitted the type is assumed to be a string. The type can be: "%Integer", "%Boolean", or "ENUM^caption1:value1,caption2:value2".
caption is the localized caption of the setting.
title is an optional tooltip displayed for the setting.
Custom portlet settings can be controlled using the SETTINGS=PORTLET parameter in the dashboard URL
• abstract method adjustContentSize(load, width, height) [ Language = javascript ]
Notification from the containing widget that the page is loaded or the widget is resized. Subclass can implement this, if they wish.
• abstract method onApplyFilters(refresh, widget) [ Language = javascript ]
Notification that a filter has changed. Subclass can implement this, if they wish.
refresh inidicates if the display should be refreshed.
widget is the containing widget object.
Copyright © 1997-2020 InterSystems Corporation, Cambridge, MA