Home > Class Reference > %SYS namespace > %DeepSee.Report.UI.whereClauseEditor

%DeepSee.Report.UI.whereClauseEditor

class %DeepSee.Report.UI.whereClauseEditor extends %ZEN.Component.composite

Where Clause Editor This is the master display panel for the where clause editor that allows the user to inject filter selections the generated DeepSee report data collector classes at run time

Property Inventory

Method Inventory

Parameters

parameter INCLUDEFILES = zenCSLM.js;
Inherited description: CSV list of additional include files (either .js or .css) that should be included when this component is used on a page.
By default, the file extension (.js or .css) is used to determine whether an item in the list is a script include or a style include. You can override this behavior by adding the terms "script:" or "style:" to the beginning of the file name or names. This prefix is not used as part of the include filename.

Properties

property helpMsg as %ZEN.Datatype.caption [ InitialExpression = "Question marks (?) should not be used as a placeholder on this screen, use #( _exp_ )# syntax instead." ];
Property methods: helpMsgDisplayToLogical(), helpMsgGet(), helpMsgIsValid(), helpMsgLogicalToDisplay(), helpMsgLogicalToOdbc(), helpMsgNormalize(), helpMsgSet()

Methods

method DrawEmptyWhereClause(pSeed As %String) as %Status [ Language = objectscript ]
Draw the contents of the Where Clause Header (the region above the table of known properties).
method DrawWhereClauseHeader(pSeed As %String) as %Status [ Language = objectscript ]
Draw the contents of the Where Clause Header (the region above the table of known properties).
clientmethod addNewClause() [ Language = javascript ]
Add a new property edit line to the table
clientmethod clear() [ Language = javascript ]
Reset the table
clientmethod filterKeystroke(e) [ Language = javascript ]
Users should not enter questions marks as parameter placeholders on this screen. Trap the event if it happens and alert the user to the correct syntax
clientmethod getModel() [ Language = javascript ]
Get the current model
clientmethod makeQuotedWhereStatement(pObj) [ Language = javascript ]
Return a doctored WHERE clause where the parameters are embedded in the text as using a '#(' whatever ')#' notation
clientmethod onloadHandler() [ Language = javascript ]
Inherited description: This client event, if present, is fired when the page is loaded.
clientmethod parseQuotedWhereStatement(str) [ Language = javascript ]
clientmethod populatePane(pObj) [ Language = javascript ]
Add the base fields to the screen and pre-poplate them from a model object
clientmethod restoreModel(m) [ Language = javascript ]
Populate the pane with data from the given model
clientmethod syncModel() [ Language = javascript ]
Synchronize the underlying model with the currently displayed values

Inherited Methods