This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

%DeepSee.Report.UI.BuildLIDR

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

DeepSee Line Item Detail Report Builder page.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter AUTONS = 0;
Do NOT auto-switch namespace to whatever is passed in work in the user's current space.
parameter DOMAIN = %DeepSee;
Inherited description: Set this to the correct domain.
parameter FAVORITEICON = portal/deepsee.ico;
DeepSee favorite icon.
parameter PAGENAME = DeepSee Visual Reporting Line Item Report Builder;
Displayed name of this page.

Properties

property dataSource as %ZEN.Datatype.string;
Data source. This is a copy of the value in the report model.
Property methods: dataSourceDisplayToLogical(), dataSourceGet(), dataSourceIsValid(), dataSourceLogicalToDisplay(), dataSourceLogicalToOdbc(), dataSourceNormalize(), dataSourceSet()
property defaultRptName as %ZEN.Datatype.string [ InitialExpression = "UnnamedLIDR" ];
The placeholder name given to reports that have yet to be saved to disk
Property methods: defaultRptNameDisplayToLogical(), defaultRptNameGet(), defaultRptNameIsValid(), defaultRptNameLogicalToDisplay(), defaultRptNameLogicalToOdbc(), defaultRptNameNormalize(), defaultRptNameSet()
property nameSpace as %ZEN.Datatype.string (ZENURL = "NAMESPACE");
Name of the currently active default namespace
Property methods: nameSpaceDisplayToLogical(), nameSpaceGet(), nameSpaceIsValid(), nameSpaceLogicalToDisplay(), nameSpaceLogicalToOdbc(), nameSpaceNormalize(), nameSpaceSet()
property reportName as %ZEN.Datatype.string (ZENURL = "RPT");
Name of Report being viewed.
Property methods: reportNameDisplayToLogical(), reportNameGet(), reportNameIsValid(), reportNameLogicalToDisplay(), reportNameLogicalToOdbc(), reportNameNormalize(), reportNameSet()
property selectedDataField as %ZEN.Datatype.integer;
Local copy of report model object. Index (0-based) of selected data field (if any).
Property methods: selectedDataFieldDisplayToLogical(), selectedDataFieldGet(), selectedDataFieldIsValid(), selectedDataFieldLogicalToDisplay(), selectedDataFieldLogicalToOdbc(), selectedDataFieldNormalize(), selectedDataFieldSet()

Methods

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.
private method %OnGetJSResources(ByRef pResources As %String) as %Status
Inherited description: Pages can implement this callback method in order to define a set of client-side resources: javascript strings that have been localized.
This method should fill in the array pResources with a set of localized strings, indexed by resource id:
   Set pResources("MyId") = $$$Text("Some string")
  
Javascript methods can refer to these resources using the helper function zenGetResource:
 alert(zenText('MyId'));
Zen defines a set of built-in resource strings using this mechanism. These have a "zen" prefix to keep them seperate from user ids.
You can also override the same callback method within your %ZEN.application class if you wish to share resources across an application. In this case, the application-wide callback is invoked first.
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.
classmethod %OnUseSoftModals() as %Boolean
For the time being, do not use soft modals for the portal.
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.
clientmethod adjustSizes() [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod autoFillData() [ Language = javascript ]
clientmethod getLayoutEditor() [ Language = javascript ]
clientmethod getModelServer() [ Language = javascript ]
clientmethod getPageModel() [ Language = javascript ]
clientmethod getPreviewEngine() [ Language = javascript ]
clientmethod getSchemaServer() [ Language = javascript ]
clientmethod getUserImageURLSelection(cb) [ Language = javascript ]
clientmethod layoutEditorDropHandler(dragData) [ Language = javascript ]
Data drop on layout editor.
clientmethod logout() [ Language = javascript ]
End the current session.
clientmethod newLayout(dssClass) [ Language = javascript ]
clientmethod newReport() [ Language = javascript ]
Invoke dialog to create a new report.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
Returning from file select dialog and setting the value into the Filename field
clientmethod onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod onloadHandler() [ Language = javascript ]
Inherited description: This client event, if present, is fired when the page is loaded.
clientmethod onunloadHandler() [ Language = javascript ]
Check if user really wants to exit if they have not saved changes
clientmethod openReport() [ Language = javascript ]
Invoke dialog to open a report.
clientmethod pageSetup() [ Language = javascript ]
Page setup for report
clientmethod preview() [ Language = javascript ]
Show a preview.
clientmethod reallySaveLIDR() [ Language = javascript ]
Really save the report to server.
clientmethod resetCoverplates() [ Language = javascript ]
Remove any obsolete visual feedback as to where a given datum may be dropped
clientmethod resetLIDR() [ Language = javascript ]
reset the active editors
clientmethod restoreDPR(src) [ Language = javascript ]
clientmethod saveAsLIDR() [ Language = javascript ]
Rename this report and save it to disk.
clientmethod saveReport() [ Language = javascript ]
Request a save of the report.
clientmethod scopeDataDrag(prefix) [ Language = javascript ]
Give visual feedback as to where a given datum may be dropped
clientmethod setDataPoolFromDSSObject(obj, title) [ Language = javascript ]
clientmethod setRibbonTitle(str) [ Language = javascript ]
clientmethod showFileSelectionWindow() [ Language = javascript ]

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Feedback