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

class EnsPortal.RuleEditor extends EnsPortal.Template.devPage, EnsPortal.Util.RuleSVGCommon

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 65 177


Summary

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

Properties
%condition %controller %import %includeFiles
%page %resource %rule BOXHEIGHT
CONDITION DOTRADIUS FOCUSPATH FRAMEMARGIN
HCINDENT HINDENT HLINELENGTH HelpAddress
ISREADONLY LocatorHeader NEW PROD
ParentURL RADIUS RULE RULELCP
RULESET SPACING StdTitle TABAREAHEIGHT
TABHEIGHT TABLECOLWIDTH TABLEHEADCOLMINWIDTH TABLEROWHEIGHT
TABLETEXTVOFFSET TABLEXMARGIN TABLEXPADDING TABLEXSPACING
TABLEYSPACING TABMAXWIDTH TABOVERLAP TABRADIUS
TABTEXTMARGIN TABTOPREDUCTION TEXTMARGIN TEXTVOFFSET
aboutPage align aux backgroundTimerInterval
canEdit canTestRules canViewContents canViewRuleLogs
cellAlign cellSize cellStyle cellVAlign
children composite contactPage containerStyle
contextSerialized contextSource controller controllerId
cssLevel currSortMode currStep currViewMode
currentNamespace currentProject currentTab currentUser
disabled docClass docHeader docId
dragAndDrop dragEnabled drawHPathElbow dropEnabled
enableAutoRefresh enclosingClass enclosingStyle error
groupClass groupStyle hasSCOutput height
helpVisible hidden hint hintClass
hintStyle home homePage id
index isRuleClass keepAliveInterval label
labelClass labelDisabledClass labelPosition labelStyle
layout lblTitle limitPopups msgDocReadOnly
msgNotPermitted msgRuleAssistant name needProject
onafterdrag onbeforedrag onclick ondrag
ondrop onhide onnotifyView onrefresh
onshow onupdate openNewWindow optionDrawIfElse
pageModified parent readOnly readOnlyReason
renamed ruleStates searchKey showLabel
showProperty showTestMessage slice sourceControlEnabled
sourceControlManagerDialog sourceControlNewlineFormat sourceControlOutputDialog sourceControlVisible
studioMode testError testIsRoutingRule testMessageHTML
testMessageNeedsEscaping testRanOK testResultJSON testSource
tipCSVWizard tipCompile tipContractAll tipDelete
tipExpandAll tipExport tipGen tipImport
tipImportLegacy tipNew tipOpen tipSave
tipSaveAs title tuple useSVG
useSoftModals valign visible width
window zenPersistentPopup

Methods
%AddCSPShareHyperevents %AddChild %AddChildAfter %AddChildBefore
%AddComponent %AddEnsExceptionHandler %AddImportedComponents %AddLocatorLinks
%AddToSaveSet %ApplyURLParms %Attr %BindExport
%ClassIsLatestVersion %ClassName %ConstructClone %DispatchClassMethod
%DispatchGetModified %DispatchGetProperty %DispatchMethod %DispatchSetModified
%DispatchSetMultidimProperty %DispatchSetProperty %DrawAutoLogout %DrawClassDefinitions
%DrawComponentHTML %DrawHTML %DrawHTMLPage %DrawJSStrings
%DrawObjectDefinitions %DrawSourceControlCommands %DrawSourceControlHead %DrawSourceControlJS
%DrawSourceControlStyle %EnclosingDivId %EndBackgroundMethod %EndScript
%Eval %EvalC %Extends %ForceClientRender
%GetChildIndex %GetComponent %GetComponentById %GetComponentByName
%GetEventHandlers %GetHomePage %GetHomeParam %GetLinks
%GetLocatorLinks %GetPageName %GetParameter %GetProductName
%GetRootLink %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 AfterUserAction
AppendSourceControlOutput BuildMenu CheckAllBlanks CheckContextLinks
CheckEnterpriseManager ClearSourceControlOutput ConvertParameter CreateProject
CreateRuleClass CreateSourceControl Decrypt DoLogout
DocumentLoad DocumentSave DrawErrorResult DrawLocator
DrawMessageHTML DrawRibbon DrawRuleDebugLog DrawRuleLog
DrawTitle Encrypt EscapeHTML EscapeURL
EvalResult GetCSPURL GetConditionObject GetContextLinks
GetCurrentProject GetDocURL GetFullProjectName GetHomePage
GetHyperEventResources GetInternalName GetNewURL GetObjectEntryURL
GetQuickLinks GetRuleAssistInfo GetRuleAssistList GetRuleAssistShortDisplay
GetRuleDefinitionObject GetSourceControlClass GetSourceControlCommands GetTimestamp
HaveSourceControlOutput HyperEventCall HyperEventHead Include
InitializeServer InsertHiddenField InsertHiddenFields IsDocReadOnly
IsEnabled IsPrivate IsProjectRequired IsSourceControlReadOnly
JavaInstalled Link LoadProject LoadRuleDefinition
OnDrawRibbon OnGetRibbonInfo OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent OnPreHTTP
OnPreHyperEvent Page QuoteJS RegisterRecent
RewriteURL SaveRuleDefinitionObject ServerGetPropertyList SetCurrentProject
SetProjectRequired ShowError SimpleKeepAlive StartTimer
StopTimer ThrowError UnescapeHTML UnescapeURL
UpdateSCMenus UserAction ValidateAlias XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType addChild
addChildAfter addChildBefore addClassToElement addClickHandler
addPopupSuffix appendServerOutput arrowClick backgroundClicked
btnEnterData btnTest buildConstraintCache buttonAddClicked
buttonAddMouseDown buttonDeleteClicked buttonDetailClicked buttonDownClicked
buttonUpClicked buttonViewClicked canTestIfRunning canUserModify
cancelPopup centerFocusedObject changeContextSource changeImage
changePassword changeURLNamespace checkEdit checkStudioHyperEvents
checkTextControls childrenMutated chooseSCMenu chooseSCProject
clearConstraintCache clearSCOutput clientKeepAlive clone
collapseOrExpandAll collapseOrExpandAll2 collapseOrExpandAllContd collapseOrExpandAllContd2
collapseRule collapseRuleContd collapseRuleObject2 configureTestTab
constraintGetDisplay correctIELayering createComponent createComponentNS
createSCMenuItem createSCProject createSCSubMenu createTimeWarning
debugClicked deferredComboUpdate deferredEscapeAction deleteComponent
deleteUncompiledRule disableCommandButton displayCountDown doOwnerDrawMain
doOwnerDrawTable doOwnerDrawTabs doScroll dragFinishHandler
dragHandler dragNotifyHandler dragStartHandler drawCondition
drawConditionTextBox drawData drawElbowLine drawFrameBox
drawHPath drawLine drawOneTab drawPlusMinus
drawRuleDefinition drawRuleHeader drawRuleSet drawRuleSetsTable
drawRuleType drawSpiderLine drawTableCell drawTableRow
drawTabs drawTestPanel drawTextBox dropHandler
dropStartHandler enableCommandButton encounteredError endModal
escapeCData evaluateRule expandRuleObject2 exposeComponent
findElement findRuleNo fireOnResizeEvent fireOnUnloadEvent
fireOnUpdateEvent firePopupAction fixDocumentTitle getChildIndex
getClientModel getComponent getComponentById getController
getCurrentExtension getCurrentName getEnclosingDiv getFocus
getHidden getHintElement getIsReadOnly getLabelElement
getOpener getPageTitle getProperty getPropertyErrorText
getReadOnlyReason getRuleContext getSaveAction getSegment
getSelection getSettings getTitleAreaHeight getType
goHome goMenu gotoNamespace gotoPage
grayOutButtons headerPopulateComboBoxes hideAllHelpPanelActions hideCommandButton
hideTimeoutWarning hideWarnContinue inResizeLoop initPopupSuffix
initialize initializeSourceControl initializeTextMonitor insertMainMap
invokeAfterUserAction invokeSourceControl invokeSuper isOfType
isRuleCollapsed isRuleCollapsed2 jsonNewObject launchPopupWindow
loadDocument logout loseFocus makeId
manualKeepAlive menuAddClear menuAddInsertPick menuAddInsertSeparator
menuAddSelected menuAddUpdateGeometry menuHide menuOnClose
menuShow menuZoomChanged mouseDown mouseOut
mouseOver mouseUp navigate newObject
newRule objectClicked onCreate onDelete
onDisplayHandler onDocumentLoad onDocumentLoadComplete onDocumentReload
onDocumentSave onDocumentSaveComplete onEndModalHandler onPopupAction
onRefreshContents onSerialize onServerMethodCall onServerMethodError
onServerMethodReturn onStartModalHandler ondisabledHandler onhandleAutoLogoutWarn
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onmousedown onmousemove onmouseout
onmouseup onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler openRule point populateMenuAddAction
populateMenuAddForEach populateMenuAddWhen popupActionHandler raiseEvent
refreshContents reloadDocument removeChild removeClassFromElement
removePopupSuffix render renderContents renderSVG
ruleAssistClassChanged ruleTypeChanged runTest saveDocument
saveRule searchBlur searchBoxHandler searchFocus
searchKeyDown searchKeyPress selectContextClass sendEventToController
serializeMessageAsHTML setComboOptions setComboValue setComponentId
setConnectivityStatusMsg setControllerId setHidden setModified
setOverlayMode setPageTitle setProperty setPropertyAll
setReadOnly setResultsDiv setSCProject setSelection
setSortMode setSortModeHandler setTraceOption setViewMode
setViewModeHandler setWarnInnerHTML showAbout showCommandButton
showContact showDocumentation showHelp showMsgBox
showSCMenu showSCOutput showTimeoutWarning startKeepAlive
startModal startProgressBar stopDrag stopKeepAlive
stopProgressBar sufficientTestData switchNamespace tabClicked
testSourceLookup textControlKeyDown textControlKeyUp textEditorKeypress
textOKClicked toggleHelp toggleMessageDiv toggleReadOnly
toggleSVGElements transferEditorData undoStackInit undoStackPop
undoStackPush undoStackRedo undoStackResetModified updateBrowserFlags
updateButtons updateDocumentState updateHelpPanel updateJSONSCReadOnly
updateMenuAdd updateSCIndicator validateRule variablesChanged
warnclickListener xyzDoAction xyzEditorKeyPressed xyzEditorLostFocus
xyzEditorOnBlur xyzGrayTextGotFocus xyzLoadData xyzOKClicked
xyzSelectorChanged xyzSelectorDblClicked xyzSelectorFocused


Parameters

• 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 PAGENAME = "Rule Editor";
Displayed name of this 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 %rule as Ens.Rule.Model.ruleDefinition;
• property BOXHEIGHT as %Integer [ InitialExpression = 22 ];
height of the text box
• property CONDITION as %String;
The condition to be parsed
• property DOTRADIUS as %Integer [ InitialExpression = 7 ];
radius of the delete and insert circles
• property FOCUSPATH as %String(ZENURL="PATH");
• property FRAMEMARGIN as %Integer [ InitialExpression = 0 ];
margin spacing for the frame box. if FRAMEMARGIN is 0, no frame box is drawn
• property HCINDENT as %Integer [ InitialExpression = 20 ];
distance of the horizontal indentation for condition graph
• property HINDENT as %Integer [ InitialExpression = 40 ];
distance of the horizontal indentation
• property HLINELENGTH as %Integer [ InitialExpression = 20 ];
length of the horizontal connecting lines
• property NEW as %Boolean(ZENURL="NEW") [ InitialExpression = 0 ];
Page invoked to create new rule
• property PROD as %String(ZENURL="PROD");
The name of the default production name
• property RADIUS as %Integer [ InitialExpression = 6 ];
radius of the rounded corners
• property RULE as %String(ZENURL="RULE");
The name of the rule to open
• property RULELCP as %String(ZENURL="rule");
• property RULESET as %String(ZENURL="RULESET");
• property SPACING as %Integer [ InitialExpression = 15 ];
spacing between boxes
• property TABAREAHEIGHT as %Integer [ InitialExpression = 32 ];
height of the total tab header
• property TABHEIGHT as %Integer [ InitialExpression = 26 ];
height of the tabs
• property TABLECOLWIDTH as %Integer [ InitialExpression = 180 ];
the column width of the ruleSetTable
• property TABLEHEADCOLMINWIDTH as %Integer [ InitialExpression = 60 ];
the minimum first column width of the ruleSetTable
• property TABLEROWHEIGHT as %Integer [ InitialExpression = 22 ];
the row height of the ruleSetTable
• property TABLETEXTVOFFSET as %Integer [ InitialExpression = 16 ];
the row height of the ruleSetTable
• property TABLEXMARGIN as %Integer [ InitialExpression = 6 ];
the x-margin of the ruleSetTable
• property TABLEXPADDING as %Integer [ InitialExpression = 6 ];
the x-cellpadding of the ruleSetTable
• property TABLEXSPACING as %Integer [ InitialExpression = 4 ];
the x-cellspacing of the ruleSetTable
• property TABLEYSPACING as %Integer [ InitialExpression = 6 ];
the y-cellspacing of the ruleSetTable
• property TABMAXWIDTH as %Integer [ InitialExpression = 200 ];
the maximum width of the tabs (from bottom to bottom)
• property TABOVERLAP as %Integer [ InitialExpression = 12 ];
the amount the top tab covers the bottom tab
• property TABRADIUS as %Integer [ InitialExpression = 20 ];
the radius of the tab side curve
• property TABTEXTMARGIN as %Integer [ InitialExpression = 20 ];
the margin of tha tab text
• property TABTOPREDUCTION as %Integer [ InitialExpression = 28 ];
The amout the tab top width is smaller than the bottom width
• 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 canTestRules as %ZEN.Datatype.boolean;
Flag to indicate whether the user is permitted to test
• property canViewContents as %ZEN.Datatype.boolean;
Flag to indicate whether the user is permitted to view body contents of stored data.
• property canViewRuleLogs as %ZEN.Datatype.boolean;
Flag to indicate whether the user is permitted to view Rule logs for testing
• property contextSerialized as %String(MAXLEN="");
User entered message data serialized
• property contextSource as %String;
Where to find test data - Header, Body or Paste
• property currentTab as %Integer [ InitialExpression = 0 ];
• property docClass as %String;
This is the class used for data - either the context class or the Document class is a routing rule
• property docHeader as %String;
If source of data is from a message header's message body
• property docId as %String;
Id of message body used for data source
• property drawHPathElbow as %Boolean [ InitialExpression = 1 ];
• property helpVisible as %Boolean [ InitialExpression = 1 ];
• property isRuleClass as %Boolean [ InitialExpression = 1 ];
• property msgDocReadOnly as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("This rule is read only") ];
• property msgRuleAssistant as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Rule Assistant") ];
• property openNewWindow as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
• property optionDrawIfElse as %Boolean(ZENURL="oIfElse") [ InitialExpression = 0 ];
• property ruleStates as %String(MAXLEN="");
Comma-delimited list of states (1/true=contracted, 0/""/false=expanded=default) of rules in the ruleSet
• property showProperty as %Boolean [ InitialExpression = 1 ];
• property showTestMessage as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Flag to show message contents or not
• property testError as %String(MAXLEN="");
test Result error message As %String
• property testIsRoutingRule as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Flag to indicate if a routing rule
• property testMessageHTML as %String(MAXLEN="");
HTML rendition of the test message contents
• property testMessageNeedsEscaping as %Boolean [ InitialExpression = 1 ];
Indicate if test message needs HTML escaping before writing to current device
• property testRanOK as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Indicates if the test ran without an error (an error in the Rule counts as OK)
• property testResultJSON as %String(MAXLEN="");
test Result as JSON
• property testSource as %String(MAXLEN=128);
User entered production source item for the test
• property tipContractAll as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Contract Rules on the diagram") ];
• property tipExpandAll as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Expand Rules on the diagram") ];
• property tipNew as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Create a new Rule") ];
• property tipOpen as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Load an existing Rule") ];
• property tipSave as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Save this Rule") ];
• property tipSaveAs as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Save this Rule with a new name") ];

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
Ensure the timestamp for the current BPL is loaded and sent out to the client.
• method %OnDrawHTMLHead() as %Status
Add the EnsException error handling on the client.
• method %OnGetPageName() as %String
Get the (localized) name of the page.
• method %OnGetTitle() as %String
Get the (localized) title string for the page.
• classmethod CreateRuleClass(pClassName As %String) as %Status [ ZenMethod ]
Create a new Rule class.
• method DrawErrorResult(pSeed As %String) as %Status
Method to draw any error of results.
• method DrawMessageHTML(pShowTestMessage As %String) as %Status
Method to draw the Message
• method DrawRuleDebugLog(pSeed As %String) as %Status
Method to draw the Rule Debug
• method DrawRuleLog(pIsRoutingRule As %String) as %Status
Method to draw the Rule log
• method GetConditionObject(ByRef Params, Output pObject As %RegisteredObject) as %Status
• classmethod GetHyperEventResources(pMethod As %String = "") as %String
Callback to return a list of resources required for a specific HyperEvent. The user must have sufficient privileges on one of the resource/permission pairs to be permitted to execute the hyperevent. An empty string implies the user already has sufficient privileges for the ZenMethod specified in pMethod.
• method GetInternalName() as %String
Return the internal name of the current document.
• method GetObjectEntryURL() as %String [ ZenMethod ]
• classmethod GetRuleAssistInfo(pClassname) as %String [ ZenMethod ]
• classmethod GetRuleAssistList(ByRef pParameters As %String, Output pObject) as %Status
• classmethod GetRuleAssistShortDisplay(pClass As %String, pProxy As %ZEN.proxyObject) as %String [ ZenMethod ]
• method GetRuleDefinitionObject(ByRef Params, Output pObject As %RegisteredObject) as %Status
• method InitializeServer(ByRef Params, Output pObject As %RegisteredObject) as %Status
• method LoadRuleDefinition() as %Status
• method OnDrawRibbon() as %Status
This is called in the middle of rendering the tool ribbon. Subclasses can inject their own content into the ribbon by writing it out in this method. This content should be wrapped within a td element.
• method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String) as %Status
Get information to display in the ribbon bar.
• method SaveRuleDefinitionObject(pCommand As %String, pProvider As %ZEN.Auxiliary.jsonProvider, pSubmitObject As %RegisteredObject, ByRef pResponseObject As %RegisteredObject) as %Status
• classmethod ServerGetPropertyList(proxy As %ZEN.proxyObject, pBase As %String) as %String [ ZenMethod ]
• classmethod ValidateAlias(pClassName, pAlias) as %String [ ZenMethod ]
• method addClassToElement(elem, classToAdd) [ Language = javascript ]
• method backgroundClicked() [ Language = javascript ]
• method btnEnterData() [ Language = javascript ]
• method btnTest() [ Language = javascript ]
• method buildConstraintCache() [ Language = javascript ]
• method buttonAddClicked() [ Language = javascript ]
• method buttonAddMouseDown() [ Language = javascript ]
• method buttonDeleteClicked() [ Language = javascript ]
• method buttonDetailClicked() [ Language = javascript ]
• method buttonDownClicked() [ Language = javascript ]
• method buttonUpClicked() [ Language = javascript ]
• method buttonViewClicked(showProperty) [ Language = javascript ]
• method canTestIfRunning(Output pErrorText As %String = "") as %Boolean
This returns 1 if a production is not running. Returns 2 if a production is running and testing enabled Returns 0 if a production is running and testing not enabled
• method centerFocusedObject() [ Language = javascript ]
• method changeContextSource() [ Language = javascript ]
What to do when the user selects a new testContextSource value.
• method changeImage(imageId, enabled) [ Language = javascript ]
• method chooseSCMenu(menuName, commandName, saveFlags) [ Language = javascript ]
Handle a source control menu selection.
• method clearConstraintCache() [ Language = javascript ]
• method clone(obj, focused) [ Language = javascript ]
• method collapseOrExpandAll(isCollapse) [ Language = javascript ]
Collapse (if argument is true) or expand (if argument is false) all rules of first level
• method collapseOrExpandAll2(isCollapse) [ Language = javascript ]
Collapse (if argument is true) or expand (if argument is false) all rules of first level
• method collapseOrExpandAllContd(isCollapse) [ Language = javascript ]
• method collapseOrExpandAllContd2(isCollapse) [ Language = javascript ]
• method collapseRule(objectId) [ Language = javascript ]
Collapse or expand a rule (flip state)
• method collapseRuleContd(objectId) [ Language = javascript ]
• method collapseRuleObject2(jObject) [ Language = javascript ]
Collapse a rule
• method configureTestTab()
Used to configure test data entry pane
• method constraintGetDisplay(rule) [ Language = javascript ]
• method debugClicked() [ Language = javascript ]
• method deferredComboUpdate() [ Language = javascript ]
• method deferredEscapeAction() [ Language = javascript ]
• classmethod deleteUncompiledRule(pClassName As %String) as %Status [ ZenMethod ]
Delete the class definition for a Rule that a user might have created with the New option, not saved and then renamed using Save As.
• method doOwnerDrawMain() [ Language = javascript ]
• method doOwnerDrawTable() [ Language = javascript ]
• method doOwnerDrawTabs() [ Language = javascript ]
• method doScroll(delta) [ Language = javascript ]
• method drawCondition(svg, groupParent, x, y, pData) [ Language = javascript ]
• method drawConditionTextBox(svg, groupParent, x, y, jsonObject, jsonProperty, jsonParentObject, jsonParentArrayObject, jsonParentArrayIndex, jsonChildrenArrayObject) [ Language = javascript ]
• method drawData(svg, isEnabled, x, y, pObject, pRuleObject, pParentObject, pParentArrayObject, pParentArrayIndex, pParentLoop) [ 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, disabled) [ Language = javascript ]
• method drawHPath(svg, x1, x2, y) [ Language = javascript ]
draw horizontal path, with a rounded elbow
• method drawLine(svg, x1, y1, x2, y2, drawInFront) [ Language = javascript ]
• method drawOneTab(index, tabwidth, isActive) [ Language = javascript ]
• method drawPlusMinus(svg, cx, cy, object) [ Language = javascript ]
draw the plus or minus for rule collapsing
• method drawRuleDefinition() [ Language = javascript ]
• method drawRuleHeader() [ Language = javascript ]
• method drawRuleSet(skipLoseFocus) [ Language = javascript ]
drawRule
• method drawRuleSetsTable() [ Language = javascript ]
• method drawRuleType() [ 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 drawTableCell(count, x, y, width, height, caption, classsuffix, focusable, dragable) [ Language = javascript ]
• method drawTableRow(count, width, name, begin, end) [ Language = javascript ]
• method drawTabs() [ Language = javascript ]
• method drawTestPanel(show) [ Language = javascript ]
• method drawTextBox(svg, isEnabled, x, y, jsonObject, jsonProperty, jsonRuleObject, jsonParentObject, jsonParentArrayObject, jsonParentArrayIndex, jsonChildrenArrayObject, jsonParentLoopObject) [ Language = javascript ]
• method encounteredError(pHTMLText As %String = "") as %Boolean
• classmethod evaluateRule(pContext As %RegisteredObject, pRuleName As %String, Output pRuleLogData As %String = "", pDebugFlags As %String = "crd", pSelectMode As %Integer = 2) as %Status
Given a context object evaluate the rule and create result output as JSON
• method expandRuleObject2(jObject) [ Language = javascript ]
Expand a rule
• method findRuleNo(object) [ Language = javascript ]
• method getClientModel() [ Language = javascript ]
Get the JSON model on the client.
• method getCurrentName() [ Language = javascript ]
Return the current name of the class/object being modified
• method getFocus(id) [ Language = javascript ]
• method getPropertyErrorText(jsonObject, jsonProperty) [ Language = javascript ]
• method getRuleContext(context) [ Language = javascript ]
• method getSegment(pathString) [ Language = javascript ]
• method getSelection(ctrl) [ Language = javascript ]
• method headerPopulateComboBoxes() [ Language = javascript ]
• method hideAllHelpPanelActions(imagesToo) [ Language = javascript ]
• method initialize() [ Language = javascript ]
• method insertMainMap(svgRectObject, svgTextObject, jsonObject, jsonProperty, jsonRuleObject, jsonParentObject, jsonParentArrayObject, jsonParentArrayIndex, jsonChildrenArrayObject, jsonParentLoopObject) [ Language = javascript ]
• method isRuleCollapsed(object) [ Language = javascript ]
Return true if rule state is collapsed
• method isRuleCollapsed2(object) [ Language = javascript ]
• method jsonNewObject(type) [ Language = javascript ]
• method loseFocus() [ Language = javascript ]
• method menuAddClear() [ Language = javascript ]
• method menuAddInsertPick(caption, keyword) [ Language = javascript ]
• method menuAddInsertSeparator() [ Language = javascript ]
• method menuAddSelected(menuSelection) [ Language = javascript ]
• method menuAddUpdateGeometry() [ Language = javascript ]
• method menuHide() [ Language = javascript ]
• method menuOnClose(event) [ Language = javascript ]
• method menuShow(menu, x, y) [ Language = javascript ]
• method menuZoomChanged(objMenu) [ 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 newObject(objType) [ Language = javascript ]
• method newRule(ruleName) [ Language = javascript ]
• method objectClicked(event, isDoubleClick) [ Language = javascript ]
• method onDocumentReload(reason) [ Language = javascript ]
Ensure we redraw the diagram if a reload was requested
• method onDocumentSaveComplete(contentUpdated) [ Language = javascript ]
Ensure we redraw the diagram if the model was updated.
• 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 ]
This client event, if present, is fired when the page is first loaded or whenever it is resized.
If this is called at load time, then load will be true.
• method onmousedown(event) [ Language = javascript ]
• method onmousemove(event) [ Language = javascript ]
• method onmouseout(event) [ Language = javascript ]
• method onmouseup(event) [ Language = javascript ]
• method openRule() [ Language = javascript ]
• method point(x, y) [ Language = javascript ]
• method populateMenuAddAction(prefix) [ Language = javascript ]
• method populateMenuAddForEach(prefix) [ Language = javascript ]
• method populateMenuAddWhen(prefix, isFirst, includeOtherwise) [ Language = javascript ]
• method removeClassFromElement(elem, classToRemove) [ Language = javascript ]
• method ruleAssistClassChanged() [ Language = javascript ]
• method ruleTypeChanged() [ Language = javascript ]
• method runTest() as %Boolean [ ZenMethod ]
run the test. Returns 1 if OK and 0 if not OK via encounteredError
• method saveRule(showDialog, oldName) [ Language = javascript ]
• method selectContextClass() [ Language = javascript ]
• method serializeMessageAsHTML(pMessageObject As %RegisteredObject, Output pSC As %Status = $$$OK, Output pNeedsHTMLEscaping As %Boolean = 1) as %Stream.TmpCharacter
Given an object create an HTML serialization of the object.
• method setComboOptions(combo, options, insertBlank) [ Language = javascript ]
• method setComboValue(combo, value) [ Language = javascript ]
• method setReadOnly(readOnly) [ Language = javascript ]
Set readOnly to the value of readOnly. Subclasses MUST implement this method to update the controls on the page so that the page's behaviour actually matches the value of the readOnly flag.
• method setSelection(ctrl, pos1, pos2) [ Language = javascript ]
• method showMsgBox(pShow) [ Language = javascript ]
Show or hide message box.
• method showSCMenu() [ Language = javascript ]
Call UpdateSCMenu() first in case the document has been modified elsewhere, then display the source control menu based on the contents of the _sourceControlMenu data created by UpdateSCMenu().
• method stopDrag() [ Language = javascript ]
• method sufficientTestData(Output pErrorText As %String = "") as %Boolean
• method tabClicked(index) [ Language = javascript ]
• method testSourceLookup() [ Language = javascript ]
• method textEditorKeypress() [ Language = javascript ]
• method textOKClicked() [ Language = javascript ]
• method toggleHelp() [ Language = javascript ]
Hide/show assist panel.
• method toggleMessageDiv(show) [ Language = javascript ]
• method toggleSVGElements(show) [ Language = javascript ]
Helper method to hide or show SVG elements when opening a popup. This is primarily to ensure that we don't run into issues with IE8 and the Adobe plugin when the popup window also uses SVG. The approach used to "hide" the SVG embed is to reduce its wrapping div to 1px by 1px during the modal. We use the wrapping div to avoid having the SVG re-rendered after we re-expand after the modal ends. We don't use style.display = 'none'/'block' as this makes the SVG non-interactive after the SVG is set back to 'block'.
• method transferEditorData() [ Language = javascript ]
• method undoStackInit() [ Language = javascript ]
• method undoStackPop() [ Language = javascript ]
• method undoStackPush(dataChanged) [ Language = javascript ]
• method undoStackRedo() [ Language = javascript ]
• method undoStackResetModified() [ Language = javascript ]
• method updateButtons() [ Language = javascript ]
• method updateHelpPanel() [ Language = javascript ]
• method updateMenuAdd() [ Language = javascript ]
• method validateRule() [ Language = javascript ]
• method variablesChanged(newlist) [ 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.