Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [EnsPortal] >  [ExpressionEditor]
Private  Storage   

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

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 11 83


Summary

This is a Zen Page class. It belongs to the application EnsPortal.Application.

Properties
%condition %import %includeFiles %page
%resource BOXHEIGHT EXP FirstFailed
HINDENT HLINELENGTH InvalidParam IsEMSReadOnly
MODE RADIUS SPACING TEXTMARGIN
TEXTVOFFSET VIEWEXPANDED ValidationErrorMsg align
aux backgroundTimerInterval canEdit cellAlign
cellSize cellStyle cellVAlign children
closeOnEnter closeOnEsc composite containerStyle
cssLevel dialogTitle disabled disabledStyle
dragAndDrop dragEnabled dropEnabled enclosingClass
enclosingStyle error groupClass groupStyle
hasButtons height hidden hideApplyButton
hideCancelButton hideOKButton hint hintClass
hintStyle id index keepAliveInterval
label labelClass labelDisabledClass labelPosition
labelStyle layout msgNotPermitted name
onafterdrag onbeforedrag onclick ondrag
ondrop onhide onrefresh onshow
onupdate parent readOnly showLabel
slice studioMode title tuple
useSVG useSoftModals valign visible
width window zenPersistentPopup

Methods
%AddCSPShareHyperevents %AddChild %AddChildAfter %AddChildBefore
%AddComponent %AddEnsExceptionHandler %AddImportedComponents %AddToSaveSet
%ApplyURLParms %Attr %BindExport %ClassIsLatestVersion
%ClassName %ConstructClone %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawAutoLogout %DrawClassDefinitions %DrawComponentHTML
%DrawHTML %DrawHTMLPage %DrawJSStrings %DrawObjectDefinitions
%DrawTitle %EnclosingDivId %EndBackgroundMethod %EndScript
%Eval %EvalC %Extends %ForceClientRender
%GetChildIndex %GetComponent %GetComponentById %GetComponentByName
%GetEventHandlers %GetLinks %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 %OnGetSubtitle %OnGetTitle %OnMonitorBackgroundTask
%OnMutateChildren %OnObjectSynch %OnPreHTTP %OnSubmit
%OnUseSoftModals %OnZENDeserialize %OriginalNamespace %PackageName
%QuoteValue %QuoteValueL10N %RemoveChild %RemoveChildren
%RemoveComponent %RemoveFromSaveSet %RunBackgroundMethod %Self
%SerializeObject %SetBackgroundMethodStatus %SetErrorById %SetErrorByName
%SetModified %SetValueById %SetValueByName %SetValuesByName
%StartScript %ValidateObject %ZENVersion ConvertParameter
Decrypt Encrypt EscapeHTML EscapeURL
EvalResult GetContentObject GetFunctions GetHyperEventResources
HyperEventCall HyperEventHead Include InsertHiddenField
InsertHiddenFields IsPrivate JavaInstalled Link
OnHTTPHeader OnPage OnPageError OnPostHTTP
OnPostHyperEvent OnPreHTTP OnPreHyperEvent Page
PutContentObject QuoteJS RewriteURL ServerGetPropertyList
ServerGetTableList ShowError SimpleKeepAlive StartTimer
StopTimer ThrowError UnescapeHTML UnescapeURL
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore addClickHandler
addPopupSuffix adjustSize backgroundClicked btnApply
btnOK buttonAddClicked buttonDeleteClicked buttonDownClicked
buttonFunctionMouseDown buttonLeftClicked buttonOperatorMouseDown buttonUpClicked
cancelPopup changeImage checkEdit checkOperandDefaultVals
checkOperandRange checkViewExpandedChanged childrenMutated clientKeepAlive
comboOperatorChanged comboTypeChanged correctIELayering createComponent
createComponentNS ctrlKeyDown debugClicked deferredComboUpdate
deferredEscapeAction deleteComponent dialogApply dialogCancel
dialogFinish dialogTitleGet disableButtons doOwnerDraw
doScroll dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler drawData drawElbowLine drawFrameBox
drawLine drawScreen drawSpiderLine drawTextBox
dropHandler dropStartHandler endModal exposeComponent
findElement fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent
firePopupAction getChildIndex getComponent getComponentById
getDialogValue getEnclosingDiv getFocus getFunctionList
getFunctionSelections getHidden getHintElement getLabelElement
getOpener getOperatorOperandRange getProperty getRuleContext
getSelection getSettings getType gotoPage
inResizeLoop initPopupSuffix insertMainMap invokeSuper
isOfType jsonIsMultiary jsonNewExpression jsonNewLogical
jsonType launchPopupWindow logicalEditorChanged loseFocus
makeId menuHide menuInsertItem menuOnClose
menuPopulate menuSelected menuShow menuUpdateGeometry
mouseDown mouseOut mouseOver mouseUp
objectClicked onCreate onDelete onDisplayHandler
onEndModalHandler onPopupAction onRefreshContents onSerialize
onServerMethodCall onServerMethodError onServerMethodReturn onStartModalHandler
ondialogCancel ondialogFinish ondialogStart ondisabledHandler
onhandleAutoLogoutWarn onkeydownHandler onkeyupHandler onlayoutHandler
onloadHandler onlogoutHandler onoverlayHandler onresizeHandler
onunloadHandler onupdateHandler point popupActionHandler
refreshContents removeChild removePopupSuffix render
renderContents renderSVG reparse resetMsg
reverseOperator setComboOptions setComboValue setComponentId
setHidden setOverlayMode setProperty setPropertyAll
setSelection setTraceOption showMsg startKeepAlive
startModal startProgressBar stopKeepAlive stopProgressBar
transferEditorData updateBrowserFlags updateButtons validateRequired
xyzDoAction xyzEditorKeyPressed xyzEditorLostFocus xyzEditorOnBlur
xyzGrayTextGotFocus xyzLoadData xyzOKClicked xyzSelectorChanged
xyzSelectorDblClicked xyzSelectorFocused


Parameters

• parameter APPLYBUTTON = 0;
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 EXP as %String(MAXLEN="",ZENURL="EXP");
the expression string to be parsed
• property HINDENT as %Integer [ InitialExpression = 30 ];
distance of the horizontal indentation
• property HLINELENGTH as %Integer [ InitialExpression = 20 ];
length of the horizontal connecting lines
• property MODE as %String(MAXLEN="",ZENURL="MODE") [ InitialExpression = "expression" ];
the editing mode, either logical or expression
• property RADIUS as %Integer [ InitialExpression = 6 ];
radius of the rounded corners
• property SPACING as %Integer [ InitialExpression = 15 ];
spacing between boxes
• property TEXTMARGIN as %Integer [ InitialExpression = 10 ];
size of the margin of the text inside the text box
• property TEXTVOFFSET as %Integer [ InitialExpression = 16 ];
distance of the vertical offset for the text y-attribute
• property VIEWEXPANDED as %String(MAXLEN="",ZENURL="VIEWEXPANDED") [ InitialExpression = 0 ];
when the editing mode is logical, this sets the default checkbox state
• 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.

Methods

• method %OnAfterCreatePage() as %Status
Disable components if the user doesn't have permissions to edit the expression.
• method %OnDrawHTMLMeta() as %Status
This callback is called at the start of the HTML HEAD section of the page (just after the title).
It allows a page to write out meta tags, if desired. The default implementation writes out an IE-specific meta tag to ensure that IE 9 and 10 don't fall back into Compatibility Mode when we are returning an HTML5 page (i.e. cssLevel is set to 3).
• method %OnGetSubtitle() as %String
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
• method %OnGetTitle() as %String
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
• method adjustSize() [ Language = javascript ]
Prevent feedback loops in resize logic, primarily on IE8.
• method backgroundClicked() [ Language = javascript ]
• method buttonAddClicked() [ Language = javascript ]
• method buttonDeleteClicked() [ Language = javascript ]
• method buttonDownClicked() [ Language = javascript ]
• method buttonFunctionMouseDown() [ Language = javascript ]
• method buttonLeftClicked() [ Language = javascript ]
• method buttonOperatorMouseDown() [ Language = javascript ]
• method buttonUpClicked() [ Language = javascript ]
• method changeImage(imageId, enabled) [ Language = javascript ]
• method checkOperandDefaultVals(jsonObject) [ Language = javascript ]
• method checkOperandRange(jsonObject) [ Language = javascript ]
• method checkViewExpandedChanged() [ Language = javascript ]
• method comboOperatorChanged() [ Language = javascript ]
• method comboTypeChanged(noCheck) [ Language = javascript ]
• method debugClicked() [ Language = javascript ]
• method deferredComboUpdate() [ Language = javascript ]
• method deferredEscapeAction() [ Language = javascript ]
• method doOwnerDraw() [ Language = javascript ]
• method doScroll(delta) [ Language = javascript ]
• method drawData(x, y, pData, pParentObject, pParentArrayObject, pParentArrayIndex) [ Language = javascript ]
• method drawElbowLine(svg, x1, y1, x2, y2) [ Language = javascript ]
draw an elbow line between (x1,y1) and (x2,y2) we assume x1 • method drawFrameBox(svg, x, y, width, height) [ Language = javascript ]
• method drawLine(svg, x1, y1, x2, y2) [ Language = javascript ]
• method drawScreen() [ Language = javascript ]
• method 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
• method drawTextBox(svg, x, y, jsonObject, jsonProperty, jsonParentObject, jsonParentArrayObject, jsonParentArrayIndex, jsonChildrenArrayObject) [ Language = javascript ]
• method getDialogValue() [ Language = javascript ]
Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
• method getFocus(id) [ Language = javascript ]
• method getFunctionList() [ Language = javascript ]
Helper method to get the object tree of defined functions.
• method getFunctionSelections() [ Language = javascript ]
• method getOperatorOperandRange(operator) [ Language = javascript ]
• method getRuleContext(context) [ Language = javascript ]
• method getSelection(ctrl) [ Language = javascript ]
• method insertMainMap(svgRectObject, svgTextObject, jsonObject, jsonProperty, jsonParentObject, jsonParentArrayObject, jsonParentArrayIndex, jsonChildrenArrayObject) [ Language = javascript ]
• method jsonIsMultiary(operator) [ Language = javascript ]
• method jsonNewExpression(type, value) [ Language = javascript ]
• method jsonNewLogical(operator, operand1, operand2) [ Language = javascript ]
• method jsonType(object) [ Language = javascript ]
• method logicalEditorChanged() [ Language = javascript ]
• method loseFocus(attemptRefocusOnNextDraw) [ Language = javascript ]
• method menuHide() [ Language = javascript ]
• method menuInsertItem(menuName, caption, logical) [ Language = javascript ]
• method menuOnClose(event) [ Language = javascript ]
• method menuPopulate() [ Language = javascript ]
• method menuSelected(menuSelection) [ Language = javascript ]
• method menuShow(menuName, x, y) [ Language = javascript ]
• method menuUpdateGeometry(menuName) [ Language = javascript ]
• method mouseDown(event, image) [ Language = javascript ]
• method mouseOut(image) [ Language = javascript ]
• method mouseOver(image) [ Language = javascript ]
• method mouseUp(event, image) [ Language = javascript ]
• method objectClicked(event, isDoubleClick) [ Language = javascript ]
• method 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.
• method ondialogStart() [ Language = javascript ]
This callback, if defined, is called when the dialog page is loaded.
• method onresizeHandler() [ Language = javascript ]
This client event, if present, is fired when the page is resized.
• method point(x, y) [ Language = javascript ]
• method reparse(updateJsonObject) [ Language = javascript ]
• method reverseOperator(operator) [ Language = javascript ]
• method setComboOptions(combo, options, insertBlank, optionsDisplay) [ Language = javascript ]
• method setComboValue(combo, value) [ Language = javascript ]
• method setSelection(ctrl, pos1, pos2) [ Language = javascript ]
• method transferEditorData() [ Language = javascript ]
• method updateButtons() [ Language = javascript ]
• method xyzDoAction() [ Language = javascript ]
• method xyzEditorKeyPressed(event) [ Language = javascript ]
• method xyzEditorLostFocus() [ Language = javascript ]
• method xyzEditorOnBlur(event) [ Language = javascript ]
• method xyzGrayTextGotFocus(event) [ Language = javascript ]
• method xyzLoadData(xyzBase) [ Language = javascript ]
• method xyzOKClicked() [ Language = javascript ]
• method xyzSelectorChanged() [ Language = javascript ]
• method xyzSelectorDblClicked() [ Language = javascript ]
• method xyzSelectorFocused() [ Language = javascript ]


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.