This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > EnsPortal.ExpressionEditor

EnsPortal.ExpressionEditor

class EnsPortal.ExpressionEditor extends EnsPortal.Dialog.standardDialog, EnsPortal.Util.RuleSVGCommon

Property Inventory

Method Inventory

Parameters

parameter APPLYBUTTON = 0;
Inherited description: If true, then this dialog displays an Apply button.
parameter EDITRESOURCE = %Ens_Rules:WRITE,%Ens_RoutingRules:WRITE,%Ens_BusinessRules:WRITE,%Ens_Code:WRITE;
User needs WRITE permissions on one of the following resources to make changes on this page: %Ens_Rules, %Ens_RoutingRules, %Ens_BusinessRules or %Ens_Code
parameter JSINCLUDES = zenCSLM.js;
Comma-separated list of additional JS include files for the page.
parameter RESOURCE = %Ens_Rules:READ,%Ens_RoutingRules:READ,%Ens_BusinessRules:READ,%Ens_Code:READ;
User needs READ permissions on one of the following resources to view this page: %Ens_Rules, %Ens_RoutingRules, %Ens_BusinessRules or %Ens_Code

Properties

property BOXHEIGHT as %Integer [ InitialExpression = 22 ];
height of the text box
Property methods: BOXHEIGHTDisplayToLogical(), BOXHEIGHTGet(), BOXHEIGHTIsValid(), BOXHEIGHTLogicalToDisplay(), BOXHEIGHTNormalize(), BOXHEIGHTSet(), BOXHEIGHTXSDToLogical()
property EXP as %String);
the expression string to be parsed
Property methods: EXPDisplayToLogical(), EXPGet(), EXPIsValid(), EXPLogicalToDisplay(), EXPLogicalToOdbc(), EXPNormalize(), EXPSet()
property HINDENT as %Integer [ InitialExpression = 30 ];
distance of the horizontal indentation
Property methods: HINDENTDisplayToLogical(), HINDENTGet(), HINDENTIsValid(), HINDENTLogicalToDisplay(), HINDENTNormalize(), HINDENTSet(), HINDENTXSDToLogical()
property HLINELENGTH as %Integer [ InitialExpression = 20 ];
length of the horizontal connecting lines
Property methods: HLINELENGTHDisplayToLogical(), HLINELENGTHGet(), HLINELENGTHIsValid(), HLINELENGTHLogicalToDisplay(), HLINELENGTHNormalize(), HLINELENGTHSet(), HLINELENGTHXSDToLogical()
property MODE as %String) [ InitialExpression = "expression" ];
the editing mode, either logical or expression
Property methods: MODEDisplayToLogical(), MODEGet(), MODEIsValid(), MODELogicalToDisplay(), MODELogicalToOdbc(), MODENormalize(), MODESet()
property RADIUS as %Integer [ InitialExpression = 6 ];
radius of the rounded corners
Property methods: RADIUSDisplayToLogical(), RADIUSGet(), RADIUSIsValid(), RADIUSLogicalToDisplay(), RADIUSNormalize(), RADIUSSet(), RADIUSXSDToLogical()
property SPACING as %Integer [ InitialExpression = 15 ];
spacing between boxes
Property methods: SPACINGDisplayToLogical(), SPACINGGet(), SPACINGIsValid(), SPACINGLogicalToDisplay(), SPACINGNormalize(), SPACINGSet(), SPACINGXSDToLogical()
property TEXTMARGIN as %Integer [ InitialExpression = 10 ];
size of the margin of the text inside the text box
Property methods: TEXTMARGINDisplayToLogical(), TEXTMARGINGet(), TEXTMARGINIsValid(), TEXTMARGINLogicalToDisplay(), TEXTMARGINNormalize(), TEXTMARGINSet(), TEXTMARGINXSDToLogical()
property TEXTVOFFSET as %Integer [ InitialExpression = 16 ];
distance of the vertical offset for the text y-attribute
Property methods: TEXTVOFFSETDisplayToLogical(), TEXTVOFFSETGet(), TEXTVOFFSETIsValid(), TEXTVOFFSETLogicalToDisplay(), TEXTVOFFSETNormalize(), TEXTVOFFSETSet(), TEXTVOFFSETXSDToLogical()
property VIEWEXPANDED as %String) [ InitialExpression = 0 ];
when the editing mode is logical, this sets the default checkbox state
Property methods: VIEWEXPANDEDDisplayToLogical(), VIEWEXPANDEDGet(), VIEWEXPANDEDIsValid(), VIEWEXPANDEDLogicalToDisplay(), VIEWEXPANDEDLogicalToOdbc(), VIEWEXPANDEDNormalize(), VIEWEXPANDEDSet()
property readOnly as %ZEN.Datatype.boolean (ZENURL = "READONLY") [ InitialExpression = 0 ];
Flag to indicate whether the main rule is open in ReadOnly mode, which should also apply here.
Property methods: readOnlyDisplayToLogical(), readOnlyGet(), readOnlyIsValid(), readOnlyLogicalToDisplay(), readOnlyLogicalToOdbc(), readOnlyLogicalToXSD(), readOnlyNormalize(), readOnlySet(), readOnlyXSDToLogical()

Methods

method %OnAfterCreatePage() as %Status
Disable components if the user doesn't have permissions to edit the expression.
method %OnDrawHTMLMeta() as %Status
Ensure that we force Internet Explorer to use its most recent rendering engine. *** Overriden in this dialog because rendering of the dropdown control had become broken.
method %OnGetSubtitle() as %String
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
method %OnGetTitle() as %String
Inherited description: Get the (localized) title string for the dialog. This should be implemented in a subclass.
classmethod GetContentObject(ByRef Params, Output pObject As %RegisteredObject) as %Status
classmethod GetFunctions(ByRef pParameters) as %Status
method PutContentObject(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 Cube definition.
classmethod ServerGetPropertyList(proxy As %ZEN.proxyObject, pBase As %String) as %String [ ZenMethod ]
classmethod ServerGetTableList() as %String [ ZenMethod ]
Get a list of lookup tables for use as suggested text when function is EXISTS or LOOKUP
clientmethod adjustSize() [ Language = javascript ]
Prevent feedback loops in resize logic, primarily on IE8.
clientmethod backgroundClicked() [ Language = javascript ]
clientmethod buttonAddClicked() [ Language = javascript ]
clientmethod buttonDeleteClicked() [ Language = javascript ]
clientmethod buttonDownClicked() [ Language = javascript ]
clientmethod buttonFunctionMouseDown() [ Language = javascript ]
clientmethod buttonLeftClicked() [ Language = javascript ]
clientmethod buttonOperatorMouseDown() [ Language = javascript ]
clientmethod buttonUpClicked() [ Language = javascript ]
clientmethod changeImage(imageId, enabled) [ Language = javascript ]
clientmethod checkOperandDefaultVals(jsonObject) [ Language = javascript ]
clientmethod checkOperandRange(jsonObject) [ Language = javascript ]
clientmethod checkViewExpandedChanged() [ Language = javascript ]
clientmethod comboOperatorChanged() [ Language = javascript ]
clientmethod comboTypeChanged(noCheck) [ Language = javascript ]
clientmethod debugClicked() [ Language = javascript ]
clientmethod deferredComboUpdate() [ Language = javascript ]
clientmethod deferredEscapeAction() [ Language = javascript ]
clientmethod doOwnerDraw() [ Language = javascript ]
clientmethod doScroll(delta) [ Language = javascript ]
clientmethod drawData(x, y, pData, pParentObject, pParentArrayObject, pParentArrayIndex) [ Language = javascript ]
clientmethod drawElbowLine(svg, x1, y1, x2, y2) [ Language = javascript ]
draw an elbow line between (x1,y1) and (x2,y2) we assume x1
clientmethod drawFrameBox(svg, x, y, width, height) [ Language = javascript ]
clientmethod drawLine(svg, x1, y1, x2, y2) [ Language = javascript ]
clientmethod drawScreen() [ Language = javascript ]
clientmethod drawSpiderLine(svg, xbase, ybase, width, height, xtarget, ytarget) [ Language = javascript ]
we draw a connect line from a box to the target the starting points can be the middle-top, middle-bottom or the right-middle
clientmethod drawTextBox(svg, x, y, jsonObject, jsonProperty, jsonParentObject, jsonParentArrayObject, jsonParentArrayIndex, jsonChildrenArrayObject) [ Language = javascript ]
clientmethod getDialogValue() [ Language = javascript ]
Inherited description: Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
clientmethod getFocus(id) [ Language = javascript ]
clientmethod getFunctionList() [ Language = javascript ]
Helper method to get the object tree of defined functions.
clientmethod getFunctionSelections() [ Language = javascript ]
clientmethod getOperatorOperandRange(operator) [ Language = javascript ]
clientmethod getRuleContext(context) [ Language = javascript ]
clientmethod getSelection(ctrl) [ Language = javascript ]
clientmethod insertMainMap(svgRectObject, svgTextObject, jsonObject, jsonProperty, jsonParentObject, jsonParentArrayObject, jsonParentArrayIndex, jsonChildrenArrayObject) [ Language = javascript ]
clientmethod jsonIsMultiary(operator) [ Language = javascript ]
clientmethod jsonNewExpression(type, value) [ Language = javascript ]
clientmethod jsonNewLogical(operator, operand1, operand2) [ Language = javascript ]
clientmethod jsonType(object) [ Language = javascript ]
clientmethod logicalEditorChanged() [ Language = javascript ]
clientmethod loseFocus(attemptRefocusOnNextDraw) [ Language = javascript ]
clientmethod mouseDown(event, image) [ Language = javascript ]
clientmethod mouseOut(image) [ Language = javascript ]
clientmethod mouseOver(image) [ Language = javascript ]
clientmethod mouseUp(event, image) [ Language = javascript ]
clientmethod objectClicked(event, isDoubleClick) [ Language = javascript ]
clientmethod ondialogFinish(action) [ Language = javascript ]
This callback, if defined, is called when the user presses the OK or Apply action buttons. If this returns false, then the action is cancelled.
clientmethod ondialogStart() [ Language = javascript ]
Inherited description: This callback, if defined, is called when the dialog page is loaded.
clientmethod onresizeHandler() [ Language = javascript ]
This client event, if present, is fired when the page is resized.
clientmethod point(x, y) [ Language = javascript ]
clientmethod reparse(updateJsonObject) [ Language = javascript ]
clientmethod reverseOperator(operator) [ Language = javascript ]
clientmethod setComboOptions(combo, options, insertBlank, optionsDisplay) [ Language = javascript ]
clientmethod setComboValue(combo, value) [ Language = javascript ]
clientmethod setSelection(ctrl, pos1, pos2) [ Language = javascript ]
clientmethod transferEditorData() [ Language = javascript ]
clientmethod updateButtons() [ Language = javascript ]
clientmethod xyzDoAction() [ Language = javascript ]
clientmethod xyzEditorKeyPressed(event) [ Language = javascript ]
clientmethod xyzEditorLostFocus() [ Language = javascript ]
clientmethod xyzEditorOnBlur(event) [ Language = javascript ]
clientmethod xyzGrayTextGotFocus(event) [ Language = javascript ]
clientmethod xyzLoadData(xyzBase) [ Language = javascript ]
clientmethod xyzOKClicked() [ Language = javascript ]
clientmethod xyzSelectorChanged() [ Language = javascript ]
clientmethod xyzSelectorDblClicked() [ Language = javascript ]
clientmethod xyzSelectorFocused() [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new window