DocBook|Search
Class Reference
%DeepSee.Report.UI.BuilderCore
   
Server:basexml
Instance:SOAXML
User:UnknownUser
 
-
  [BASEXML] >  [%DeepSee] >  [Report] >  [UI] >  [BuilderCore]
Private  Storage  

class %DeepSee.Report.UI.BuilderCore extends %ZEN.Portal.standardPage

DeepSee Report Builder page. Core implementation of ReportBuilder.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 4 32


Summary

This is a Zen Page class. It belongs to the application %ZEN.Portal.Application.

Properties
%condition %import %includeFiles %model
%page %resource StdTitle aboutPage
align aux backgroundTimerInterval cellAlign
cellSize cellStyle cellVAlign children
composite containerStyle cssLevel currSortMode
currStep currViewMode dataSource disabled
dragAndDrop dragEnabled dropEnabled enclosingClass
enclosingStyle error groupClass groupStyle
height hidden hint hintClass
hintStyle homePage id index
label labelClass labelDisabledClass labelPosition
labelStyle layout name onafterdrag
onbeforedrag onclick ondrag ondrop
onhide onrefresh onshow onupdate
pageModified parent reportName searchKey
selectedDataField showLabel slice title
tuple useSVG useSoftModals valign
visible 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 %EnclosingDivId
%EndBackgroundMethod %EndScript %Eval %Extends
%ForceClientRender %GetChildIndex %GetComponent %GetComponentById
%GetComponentByName %GetEventHandlers %GetLinks %GetLocatorLinks
%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 %OnGetPageName
%OnGetProductName %OnGetSmallMenu %OnGetTitle %OnMonitorBackgroundTask
%OnMutateChildren %OnObjectSynch %OnPreHTTP %OnSubmit
%OnUseSoftModals %OnZENDeserialize %OriginalNamespace %PackageName
%QuoteValue %QuoteValueL10N %Register %RemoveChild
%RemoveChildren %RemoveComponent %RemoveFromSaveSet %RunBackgroundMethod
%Self %SerializeObject %SetBackgroundMethodStatus %SetErrorById
%SetErrorByName %SetModified %SetValueById %SetValueByName
%SetValuesByName %StartScript %ValidateObject %ZENVersion
BuildMenu ConvertParameter Decrypt DoLogout
DrawDataSourceHeader DrawLayoutListHeader DrawLocator DrawPropertyTableHeader
DrawRibbon DrawTitle Encrypt EscapeHTML
EscapeURL GetCSPURL GetContextLinks GetDataSourceInfo
GetDocPage GetNewURL GetQuickLinks GetReportDefinition
HyperEventBody HyperEventCall HyperEventFrame HyperEventHead
Include InsertHiddenField InsertHiddenFields IsPrivate
Link OnDrawRibbon OnGetRibbonInfo OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
RewriteURL ShowError StartTimer StopTimer
SubmitReport ThrowError UnescapeHTML UnescapeURL
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore addDataField
adjustSizes cancelPopup changeDataSource changePassword
childrenMutated correctIELayering createComponent createComponentNS
dataPropertyTableDropHandler deleteComponent dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
endModal exposeComponent findElement fireOnLoadEvent
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent firePopupAction
getChildIndex getComponent getComponentById getEnclosingDiv
getHidden getHintElement getLabelElement getOpener
getProperty getReportModel getSettings getTitleAreaHeight
getType goHome goMenu gotoNamespace
gotoPage invokeSuper isOfType launchPopupWindow
logout makeId navigate newReport
onCreate onDelete onDisplayHandler onEndModalHandler
onPopupAction onRefreshContents onSerialize onServerMethodCall
onServerMethodError onServerMethodReturn onStartModalHandler ondisabledHandler
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler openReport popupActionHandler preview
refreshContents removeChild render renderAll
renderContents renderDataPropertyTable renderLayoutEditor renderSVG
save searchBlur searchBoxHandler searchFocus
searchKeyDown searchKeyPress setComponentId setDataSource
setHidden setModified setOverlayMode setProperty
setPropertyAll setSortMode setSortModeHandler setTraceOption
setViewMode setViewModeHandler showAbout showHelp
startModal startProgressBar stopProgressBar switchNamespace
treeDoubleClick updateLayoutList

Subclasses
%DeepSee.Report.UI.Builder

Parameters

• parameter DEFAULTVIEWMODE = "data";
If this page has multiple views, this is its initial display mode. Options are "data","layout"
• parameter PAGENAME = "DeepSee Report Builder";
Displayed name of this page.

Properties

• property %model as %DeepSee.Report.Model.Report;
Local copy of report model object.
• property dataSource as %ZEN.Datatype.string;
Data source. This is a copy of the value in the report model.
• property reportName as %ZEN.Datatype.string(ZENURL="CUBE");
Name of Report being viewed.
• property selectedDataField as %ZEN.Datatype.integer;
Index (0-based) of selected data field (if any).

Methods

• method %GetLocatorLinks(Output pLink) as %Status
Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
• method %OnAfterCreatePage() as %Status
This class method callback is called just before the server-side page object is created.
• method %OnGetPageName() as %String
Get the (localized) name of the page.
• method %OnGetProductName() as %String
Get the product name for the page.
• method %OnGetTitle() as %String
Get the (localized) title string for the page. This should be implemented in a subclass.
• method DrawDataSourceHeader(pSeed As %String) as %Status
Draw the contents of the DataSource Header (the region above the DataSource tree).
• method DrawLayoutListHeader(pSeed As %String) as %Status
Draw the contents of the LayoutList Header (the region above the Layout view property list).
• method DrawPropertyTableHeader(pSeed As %String) as %Status
Draw the contents of the PropertyTable Header (the region above the property table).
• classmethod GetDataSourceInfo(pRoot As %String, Output pTree, ByRef pParms) as %Status
Provide contents of the data source tree.
• method GetReportDefinition(ByRef pParms, Output pObject As %RegisteredObject) as %Status
Get Report definition for JSON provider.
• method OnDrawRibbon() as %Status
Draw additional stuff in the ribbon bar
• method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status
Get information to display in the ribbon bar.
• method SubmitReport(pCommand As %String, pProvider As %ZEN.Auxiliary.jsonProvider, pSubmitObject As %RegisteredObject, ByRef pResponseObject As %RegisteredObject) as %Status
Object submit handler JSON provider. This is called when the client submits the Report definition.
• method addDataField(field) [ Language = javascript ]
Add a new data field to the list of data fields. field is an object representing the data field.
• method adjustSizes() [ Language = javascript ]
Adjust sizes of components on the page.
• method changeDataSource() [ Language = javascript ]
Launch the data source dialog.
• method dataPropertyTableDropHandler(dragData) [ Language = javascript ]
Data drop on data property table.
• method getReportModel() [ Language = javascript ]
Return the report definition object.
• method newReport() [ Language = javascript ]
Invoke dialog to create a new report.
• 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 onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
• method onunloadHandler() [ Language = javascript ]
Check if user really wants to exit if they have not saved changes
• method openReport() [ Language = javascript ]
Invoke dialog to open a report.
• method preview() [ Language = javascript ]
Show a preview.
• method renderAll() [ Language = javascript ]
Render contents of dynamic elements.
• method renderDataPropertyTable() [ Language = javascript ]
Render contents of the dataPropertyTable.
• method renderLayoutEditor() [ Language = javascript ]
Render contents of the layout editor.
• method save() [ Language = javascript ]
Save the report.
• method setDataSource(cls) [ Language = javascript ]
Set the dataSource for the report.
• method setViewModeHandler(mode) [ Language = javascript ]
Do the actual work of updating the view to match the current view mode.
• method treeDoubleClick(tree) [ Language = javascript ]
User has double-clicked on an element in the (data source) tree control.
• method updateLayoutList() [ Language = javascript ]
Update the list of fields in the layout field list.