Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %DeepSee.Component.Widget.portlet
Private  Storage   


class %DeepSee.Component.Widget.portlet extends

A specialized DeepSee Dashboard widget that displays a user-defined "portlet". A portlet serves users defined HTML or SVG content that is displayed within the widge. The portlet type is specified by the subtype property.
If you wish to create your own portlet, do NOT subclass this component; instead, create a subclass of the %DeepSee.Component.Portlet.abstractPortlet class.


Parameters Properties Methods Queries Indices ForeignKeys Triggers


%condition %definition %import %includeFiles
%page %resource align aux
backgroundColor cellAlign cellSize cellStyle
cellVAlign centerHeader children clickActions
clickActive clickFilterSpec clickTargetProperties clickTargets
colSpan colorToolbar composite containerStyle
controlIndices currFilterSpec currItemNo currSeriesNo
currValue currValueName dataSource disabled
dragEnabled dropEnabled enclosingClass enclosingStyle
error filterDefault filterState filterText
forceToolbar groupClass groupStyle hasInitialFilters
header headerLayout height hidden
hint hintClass hintStyle homeCol
homeRow id imageAppLogo imageAppLogoWidth
imageClose imageCloseHover imageCloseWidth imageContract
imageContractHover imageContractWidth imageExpand imageExpandHover
imageExpandWidth imageMaximize imageMaximizeHover imageMaximizeWidth
imageMinimize imageMinimizeHover imageMinimizeWidth imageResize
imageResizeSize index label labelClass
labelDisabledClass labelPosition labelStyle layout
linkWidgetKey maximized minWidth moveEnabled
name onafterdrag onbeforedrag onclick
onclosepending ondrag ondrop onhide
onrefresh onresize onshow onupdate
onwindowdrop onwindowgrab opacity opacityToolbar
parent previewMode resizeEnabled rowSpan
sessionCookie settings showLabel showSidebar
showToolbar showToolbarBottomBorder showToolbarOnlyWhenMaximized sidebarContent
sidebarWidth slice subtype title
tuple valign visible widgetKey
widgetLayout width window

%AddChild %AddChildAfter %AddChildBefore %AddFooter
%AddSidebar %AddToSaveSet %Attr %BindExport
%ClassIsLatestVersion %ClassName %ConstructClone %CreateController
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %DrawComponentHTML
%DrawHTML %DrawJSStrings %EnclosingDivId %Eval
%EvalC %Extends %FindComponent %ForceClientRender
%GetCatalogInfo %GetChildIndex %GetDataController %GetEventHandlers
%GetParameter %GetWidgetPropertyInfo %GetWidgetSettings %GetXMLName
%IsA %IsModified %MakeId %MakeWidgetId
%New %NormalizeObject %ObjectModified %OnAddToPageAfter
%OnAddToPageBefore %OnCreateControls %OnCreateWidget %OnDrawEnclosingDiv
%OnDrawObjectProperties %OnMutateChildren %OnObjectSynch %OnZENDeserialize
%OriginalNamespace %PackageName %QuoteValue %QuoteValueL10N
%RemoveChild %RemoveChildren %RemoveFromSaveSet %Self
%SerializeObject %SetModified %ValidateObject GetKpiFilterCaption
ResolveText XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType abortClose addChild addChildAfter
addChildBefore adjustChildArea adjustContentSize adjustHandleWidth
adjustResizeBox adjustSizes animateIcon applyCSSSettings
childrenMutated close compress constrainDragX
constrainDragY controlEventHandler disableCoverplate disableDrag
disableHeaderMaxToggle disableResize dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
enableCoverplate enableDrag enableHeaderMaxToggle enableResize
endDrag expand exportExcel exportPDF
exposeComponent findComponent findElement fireOnUpdateEvent
getChildDiv getChildIndex getCoverplateDiv getDataController
getDefinition getEnclosingDiv getFilterTableForPrinting getHeaderDiv
getHeaderUserDiv getHidden getHintElement getLabelElement
getOverrideSkipList getOverrides getProperty getSVGFrame
getSettingDisplayValue getSettingLists getSettings getState
getSubtypeClass getType getWindowHeight getWindowWidth
hasOverrides invokeSuper isCompressed isMasterWidget
isMaximized isOfType isResizeInProgress makeId
maximize navCloseButtonClick navDataArrange navDataChange
navHeaderButtonClick navPopupAction navSelectItem onApplyFilters
onCreate onDelete onDisplayHandler onEndModalHandler
onGrabHandler onPopupAction onRefreshContents onReleaseHandler
onSerialize onStartModalHandler ondisabledHandler onloadHandler
onresizeHandler onunloadHandler onupdateHandler printSVGContent
processAppMessage raiseEventHandler refreshContents removeChild
removeWindowChrome render renderContents renderCoverplate
renderHeader renderResize renderSVG resetOverrides
resetWindowChrome resize restoreGeometry restoreState
saveGeometry selectWidget setAppLogo setBodyStyle
setCenterLayout setCloseIcon setContractIcon setExpandIcon
setHeaderLayout setHeaderStyle setHidden setIcon
setMaximizeIcon setMinimizeIcon setOpacity setOverlayMode
setProperty setPropertyAll setToolbarProperty showBreakdown
showDimensions showGeoListing showListing startDrag
startProgressBar stopProgressBar syncObject verifyHeaderGeometry


• method %CreateController(pGroup As %ZEN.Component.abstractGroup, Output pController As %ZEN.Auxiliary.abstractController) as %Status
If this widget has a data source, create a data controller that will serve this data to the client.
The controller's id is "controller" (within the scope of this widget).
• classmethod %GetCatalogInfo(Output pInfo As %List, Output pSubtypeList As %List) as %Status
Return information used to list this widget within the "widget catalog".
• classmethod %GetWidgetPropertyInfo(pSubtype As %String, Output pInfo As %List, ByRef pSettings) as %Status
Return information on additional "properties" supported by this widget for the given subtype.
• method %OnCreateControls(pGroup As %ZEN.Component.group) as %Status
This callback is called just before controls are added to the top of the widget. pGroup is the header in which new Zen control can be added.
• method %OnCreateWidget(pGroup As %ZEN.Component.group) as %Status
This callback is responsible for creating the contents of the widget.
• method adjustContentSize(load, width, height) [ Language = javascript ]
Called when page is loaded or widget is resized.
• method exportExcel() [ Language = javascript ]
Export current query to excel
• method exportPDF() [ Language = javascript ]
Export current query to pdf. If we are in chart mode, export the chart.
• method getDataController() [ Language = javascript ]
If this widget contains a data controller, return it. This allows for generic capabilities in this base class.
• method onApplyFilters(refresh) [ Language = javascript ]
Notification that a filter has changed.