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

class %DeepSee.Report.UI.CreateDCR extends %DeepSee.UI.standardPage

DeepSee Report DCR Builder page.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 5 38


Summary

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

Properties
%condition %import %includeFiles %page
%resource StdTitle aboutPage align
aux backgroundTimerInterval cellAlign cellSize
cellStyle cellVAlign children composite
containerStyle cssLevel currSortMode currStep
currViewMode dataSelect dataSource disabled
docbookId dragAndDrop dragEnabled dropEnabled
enclosingClass enclosingStyle error groupClass
groupStyle height hidden hint
hintClass hintStyle homePage id
index isModified label labelClass
labelDisabledClass labelPosition labelStyle layout
name nameSpace 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
DrawLocator DrawRibbon DrawTitle Encrypt
EscapeHTML EscapeURL GetCSPURL GetClassQueries
GetContextLinks GetDocPage GetNewURL GetQueryInfo
GetQuickLinks GetSQLTableName HyperEventBody HyperEventCall
HyperEventFrame HyperEventHead Include InsertHiddenField
InsertHiddenFields IsPrivate Link OnDrawRibbon
OnGetRibbonInfo 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
adjustSizes backupCurrentModel cancelPopup changeDataSource
changePassword childrenMutated correctIELayering createComponent
createComponentNS deleteComponent dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
endModal exposeComponent findElement fireOnLoadEvent
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent firePopupAction
getChildIndex getComponent getComponentById getDataPropertiesWidget
getDataSourceWidget getEnclosingDiv getHidden getHintElement
getLabelElement getMethodEditorWidget getModelServer getOpener
getProperty getReportPropertiesWidget getSchemaTableWidget getSettings
getTitleAreaHeight getType getWhereClauseWidget goHome
goMenu gotoNamespace gotoPage invokeSuper
isOfType launchPopupWindow logout makeId
navigate newDCR onCreate onDelete
onDisplayHandler onEndModalHandler onPopupAction onRefreshContents
onSerialize onServerMethodCall onServerMethodError onServerMethodReturn
onStartModalHandler ondisabledHandler onkeydownHandler onkeyupHandler
onlayoutHandler onloadHandler onlogoutHandler onoverlayHandler
onresizeHandler onunloadHandler onupdateHandler openDCR
popupActionHandler refreshContents removeChild render
renderContents renderSVG resetDCR restoreCurrentBackup
restoreDCR saveDCR scanForFieldNames scanForSorters
schemaTableDropHandler searchBlur searchBoxHandler searchFocus
searchKeyDown searchKeyPress setComponentId setDataSource
setHidden setModified setOverlayMode setProperty
setPropertyAll setRibbonTitle setSortMode setSortModeHandler
setTraceOption setViewMode setViewModeHandler showAbout
showHelp startModal startProgressBar stopProgressBar
switchNamespace updateBaseSQL updateModelFromEditors updateOrderByClause


Parameters

• parameter DOMAIN = "%DeepSee";
Set this to the correct domain.
• parameter FAVORITEICON = "portal/deepsee.ico";
DeepSee favorite icon.
• parameter JSINCLUDES = "zenCSLM.js,zenESVG.js";
Comma-separated list of additional JS include files for the page.
• parameter PAGENAME = "DeepSee Visual Reporting Data Collector Builder";
Displayed name of this page.
• parameter USERPACKAGES = "%DeepSee.Report.UI";
Comma-separated list of User class packages whose HTML class and style definitions are in pre-generated include files.

Properties

• property dataSelect as %ZEN.Datatype.string [ InitialExpression = "ByField" ];
Data selection type. This sets the editor's mode of operation To either select individual data fields (ByField) and create an SQL statement, or to use a predefined class query and skip a lot of low level stuff in favor of some quick defaults (ByQuery).
• property dataSource as %ZEN.Datatype.string;
Data source. This is a copy of the value in the report model.
• property nameSpace as %ZEN.Datatype.string(ZENURL="NAMESPACE");
Name of the currently active default namespace
• property reportName as %ZEN.Datatype.string(ZENURL="CLS");
Name of Report being viewed.
• property selectedDataField as %ZEN.Datatype.integer;
Local copy of report model object. 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.
• method GetClassQueries(className As %String) as %ZEN.Datatype.string [ ZenMethod ]
Return a JSON string in the form of an array of function names where the named functions are all queries associated with the given class If the class cannot be openned the string ERROR will be returned. If the class has no defined queries the string "[]" will be returned.
• method GetQueryInfo(queryClass As %String, queryName As %String) as %ZEN.Datatype.string [ ZenMethod ]
Given a class and query method name, return a JSON string for an object with two fields. "data" is an array of objects where each object has a name, type and caption field and represents a returned column from the query. "arg" is an array of objects where each object has a name and type and represents a parameter of the query function (in order of passing). If the class cannot be read, the query returns the string "$$$NoJoy"
• method GetSQLTableName(classname As %ZEN.Datatype.string) as %ZEN.Datatype.string [ ZenMethod ]
• 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 adjustSizes(dnr) [ Language = javascript ]
Adjust sizes of components on the page.
• method backupCurrentModel() [ Language = javascript ]
Create a temporary backup of the active client-side model for 'undo' purposes
• method changeDataSource() [ Language = javascript ]
Launch the data source dialog.
• method getDataPropertiesWidget() [ Language = javascript ]
• method getDataSourceWidget() [ Language = javascript ]
• method getMethodEditorWidget() [ Language = javascript ]
• method getModelServer() [ Language = javascript ]
• method getReportPropertiesWidget() [ Language = javascript ]
• method getSchemaTableWidget() [ Language = javascript ]
• method getWhereClauseWidget() [ Language = javascript ]
• method newDCR() [ 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 onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method onunloadHandler() [ Language = javascript ]
Check if user really wants to exit if they have not saved changes
• method openDCR() [ Language = javascript ]
Invoke dialog to open a report.
• method resetDCR() [ Language = javascript ]
reset the active editors
• method restoreCurrentBackup() [ Language = javascript ]
Reset the model to a previous locally-stored state
• method restoreDCR(m) [ Language = javascript ]
Restore UI settings based on a freshly loaded model
• method saveDCR() [ Language = javascript ]
Save the report.
• method scanForFieldNames(n, a) [ Language = javascript ]
• method scanForSorters(n, l) [ Language = javascript ]
• method schemaTableDropHandler(dragData) [ Language = javascript ]
Data drop on data property table.
• method setDataSource(cls) [ Language = javascript ]
Set the dataSource for the report.
• method setRibbonTitle(str) [ Language = javascript ]
• method setViewModeHandler(mode) [ Language = javascript ]
Do the actual work of updating the view to match the current view mode.
• method updateBaseSQL() [ Language = javascript ]
• method updateModelFromEditors() [ Language = javascript ]
• method updateOrderByClause() [ Language = javascript ]