InterSystems IRIS Data Platform 2020.4 > Class Reference > ENSLIB namespace > EnsPortal.RuleEditor


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

Property Inventory

Method Inventory


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


property %rule as Ens.Rule.Model.ruleDefinition;
Property methods: %ruleGet(), %ruleGetSwizzled(), %ruleIsValid(), %ruleNewObject(), %ruleSet()
property BOXHEIGHT as %Integer [ InitialExpression = 22 ];
height of the text box
Property methods: BOXHEIGHTDisplayToLogical(), BOXHEIGHTGet(), BOXHEIGHTIsValid(), BOXHEIGHTLogicalToDisplay(), BOXHEIGHTNormalize(), BOXHEIGHTSet(), BOXHEIGHTXSDToLogical()
property CONDITION as %String;
The condition to be parsed
Property methods: CONDITIONDisplayToLogical(), CONDITIONGet(), CONDITIONIsValid(), CONDITIONLogicalToDisplay(), CONDITIONLogicalToOdbc(), CONDITIONNormalize(), CONDITIONSet()
property DOTRADIUS as %Integer [ InitialExpression = 7 ];
radius of the delete and insert circles
Property methods: DOTRADIUSDisplayToLogical(), DOTRADIUSGet(), DOTRADIUSIsValid(), DOTRADIUSLogicalToDisplay(), DOTRADIUSNormalize(), DOTRADIUSSet(), DOTRADIUSXSDToLogical()
property FOCUSPATH as %String (ZENURL = "PATH");
Property methods: FOCUSPATHDisplayToLogical(), FOCUSPATHGet(), FOCUSPATHIsValid(), FOCUSPATHLogicalToDisplay(), FOCUSPATHLogicalToOdbc(), FOCUSPATHNormalize(), FOCUSPATHSet()
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 methods: HCINDENTDisplayToLogical(), HCINDENTGet(), HCINDENTIsValid(), HCINDENTLogicalToDisplay(), HCINDENTNormalize(), HCINDENTSet(), HCINDENTXSDToLogical()
property HINDENT as %Integer [ InitialExpression = 40 ];
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 NEW as %Boolean (ZENURL = "NEW") [ InitialExpression = 0 ];
Page invoked to create new rule
Property methods: NEWDisplayToLogical(), NEWGet(), NEWIsValid(), NEWLogicalToDisplay(), NEWLogicalToXSD(), NEWNormalize(), NEWSet(), NEWXSDToLogical()
property PROD as %String (ZENURL = "PROD");
The name of the default production name
Property methods: PRODDisplayToLogical(), PRODGet(), PRODIsValid(), PRODLogicalToDisplay(), PRODLogicalToOdbc(), PRODNormalize(), PRODSet()
property RADIUS as %Integer [ InitialExpression = 6 ];
radius of the rounded corners
Property methods: RADIUSDisplayToLogical(), RADIUSGet(), RADIUSIsValid(), RADIUSLogicalToDisplay(), RADIUSNormalize(), RADIUSSet(), RADIUSXSDToLogical()
property RULE as %String (ZENURL = "RULE");
The name of the rule to open
Property methods: RULEDisplayToLogical(), RULEGet(), RULEIsValid(), RULELogicalToDisplay(), RULELogicalToOdbc(), RULENormalize(), RULESETDisplayToLogical(), RULESETGet(), RULESETIsValid(), RULESETLogicalToDisplay(), RULESETLogicalToOdbc(), RULESETNormalize(), RULESETSet(), RULESet()
property RULESET as %String (ZENURL = "RULESET");
Property methods: RULESETDisplayToLogical(), RULESETGet(), RULESETIsValid(), RULESETLogicalToDisplay(), RULESETLogicalToOdbc(), RULESETNormalize(), RULESETSet()
property SPACING as %Integer [ InitialExpression = 15 ];
spacing between boxes
Property methods: SPACINGDisplayToLogical(), SPACINGGet(), SPACINGIsValid(), SPACINGLogicalToDisplay(), SPACINGNormalize(), SPACINGSet(), SPACINGXSDToLogical()
property TABAREAHEIGHT as %Integer [ InitialExpression = 32 ];
height of the total tab header
property TABHEIGHT as %Integer [ InitialExpression = 26 ];
height of the tabs
Property methods: TABHEIGHTDisplayToLogical(), TABHEIGHTGet(), TABHEIGHTIsValid(), TABHEIGHTLogicalToDisplay(), TABHEIGHTNormalize(), TABHEIGHTSet(), TABHEIGHTXSDToLogical()
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 methods: TABOVERLAPDisplayToLogical(), TABOVERLAPGet(), TABOVERLAPIsValid(), TABOVERLAPLogicalToDisplay(), TABOVERLAPNormalize(), TABOVERLAPSet(), TABOVERLAPXSDToLogical()
property TABRADIUS as %Integer [ InitialExpression = 20 ];
the radius of the tab side curve
Property methods: TABRADIUSDisplayToLogical(), TABRADIUSGet(), TABRADIUSIsValid(), TABRADIUSLogicalToDisplay(), TABRADIUSNormalize(), TABRADIUSSet(), TABRADIUSXSDToLogical()
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 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 canTestRules as %ZEN.Datatype.boolean;
Flag to indicate whether the user is permitted to test
Property methods: canTestRulesDisplayToLogical(), canTestRulesGet(), canTestRulesIsValid(), canTestRulesLogicalToDisplay(), canTestRulesLogicalToOdbc(), canTestRulesLogicalToXSD(), canTestRulesNormalize(), canTestRulesSet(), canTestRulesXSDToLogical()
property canViewContents as %ZEN.Datatype.boolean;
Flag to indicate whether the user is permitted to view body contents of stored data.
Property methods: canViewContentsDisplayToLogical(), canViewContentsGet(), canViewContentsIsValid(), canViewContentsLogicalToDisplay(), canViewContentsLogicalToOdbc(), canViewContentsLogicalToXSD(), canViewContentsNormalize(), canViewContentsSet(), canViewContentsXSDToLogical()
property canViewRuleLogs as %ZEN.Datatype.boolean;
Flag to indicate whether the user is permitted to view Rule logs for testing
Property methods: canViewRuleLogsDisplayToLogical(), canViewRuleLogsGet(), canViewRuleLogsIsValid(), canViewRuleLogsLogicalToDisplay(), canViewRuleLogsLogicalToOdbc(), canViewRuleLogsLogicalToXSD(), canViewRuleLogsNormalize(), canViewRuleLogsSet(), canViewRuleLogsXSDToLogical()
property contextSerialized as %String);
User entered message data serialized
Property methods: contextSerializedDisplayToLogical(), contextSerializedGet(), contextSerializedIsValid(), contextSerializedLogicalToDisplay(), contextSerializedLogicalToOdbc(), contextSerializedNormalize(), contextSerializedSet()
property contextSource as %String;
Where to find test data - Header, Body or Paste
Property methods: contextSourceDisplayToLogical(), contextSourceGet(), contextSourceIsValid(), contextSourceLogicalToDisplay(), contextSourceLogicalToOdbc(), contextSourceNormalize(), contextSourceSet()
property currentTab as %Integer [ InitialExpression = 0 ];
Property methods: currentTabDisplayToLogical(), currentTabGet(), currentTabIsValid(), currentTabLogicalToDisplay(), currentTabNormalize(), currentTabSet(), currentTabXSDToLogical()
property docClass as %String;
This is the class used for data - either the context class or the Document class is a routing rule
Property methods: docClassDisplayToLogical(), docClassGet(), docClassIsValid(), docClassLogicalToDisplay(), docClassLogicalToOdbc(), docClassNormalize(), docClassSet()
property docHeader as %String;
If source of data is from a message header's message body
Property methods: docHeaderDisplayToLogical(), docHeaderGet(), docHeaderIsValid(), docHeaderLogicalToDisplay(), docHeaderLogicalToOdbc(), docHeaderNormalize(), docHeaderSet()
property docId as %String;
Id of message body used for data source
Property methods: docIdDisplayToLogical(), docIdGet(), docIdIsValid(), docIdLogicalToDisplay(), docIdLogicalToOdbc(), docIdNormalize(), docIdSet()
property drawHPathElbow as %Boolean [ InitialExpression = 1 ];
Property methods: drawHPathElbowDisplayToLogical(), drawHPathElbowGet(), drawHPathElbowIsValid(), drawHPathElbowLogicalToDisplay(), drawHPathElbowLogicalToXSD(), drawHPathElbowNormalize(), drawHPathElbowSet(), drawHPathElbowXSDToLogical()
property helpVisible as %Boolean [ InitialExpression = 1 ];
Property methods: helpVisibleDisplayToLogical(), helpVisibleGet(), helpVisibleIsValid(), helpVisibleLogicalToDisplay(), helpVisibleLogicalToXSD(), helpVisibleNormalize(), helpVisibleSet(), helpVisibleXSDToLogical()
property isRuleClass as %Boolean [ InitialExpression = 1 ];
Property methods: isRuleClassDisplayToLogical(), isRuleClassGet(), isRuleClassIsValid(), isRuleClassLogicalToDisplay(), isRuleClassLogicalToXSD(), isRuleClassNormalize(), isRuleClassSet(), isRuleClassXSDToLogical()
property msgDocReadOnly as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("This rule is read only") ];
Property methods: msgDocReadOnlyDisplayToLogical(), msgDocReadOnlyGet(), msgDocReadOnlyIsValid(), msgDocReadOnlyLogicalToDisplay(), msgDocReadOnlyLogicalToOdbc(), msgDocReadOnlyNormalize(), msgDocReadOnlySet()
property msgRuleAssistant as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Rule Assistant") ];
Property methods: msgRuleAssistantDisplayToLogical(), msgRuleAssistantGet(), msgRuleAssistantIsValid(), msgRuleAssistantLogicalToDisplay(), msgRuleAssistantLogicalToOdbc(), msgRuleAssistantNormalize(), msgRuleAssistantSet()
property openNewWindow as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Property methods: openNewWindowDisplayToLogical(), openNewWindowGet(), openNewWindowIsValid(), openNewWindowLogicalToDisplay(), openNewWindowLogicalToOdbc(), openNewWindowLogicalToXSD(), openNewWindowNormalize(), openNewWindowSet(), openNewWindowXSDToLogical()
property optionDrawIfElse as %Boolean (ZENURL = "oIfElse") [ InitialExpression = 0 ];
Property methods: optionDrawIfElseDisplayToLogical(), optionDrawIfElseGet(), optionDrawIfElseIsValid(), optionDrawIfElseLogicalToDisplay(), optionDrawIfElseLogicalToXSD(), optionDrawIfElseNormalize(), optionDrawIfElseSet(), optionDrawIfElseXSDToLogical()
property ruleStates as %String);
Comma-delimited list of states (1/true=contracted, 0/""/false=expanded=default) of rules in the ruleSet
Property methods: ruleStatesDisplayToLogical(), ruleStatesGet(), ruleStatesIsValid(), ruleStatesLogicalToDisplay(), ruleStatesLogicalToOdbc(), ruleStatesNormalize(), ruleStatesSet()
property showProperty as %Boolean [ InitialExpression = 1 ];
Property methods: showPropertyDisplayToLogical(), showPropertyGet(), showPropertyIsValid(), showPropertyLogicalToDisplay(), showPropertyLogicalToXSD(), showPropertyNormalize(), showPropertySet(), showPropertyXSDToLogical()
property showTestMessage as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Flag to show message contents or not
Property methods: showTestMessageDisplayToLogical(), showTestMessageGet(), showTestMessageIsValid(), showTestMessageLogicalToDisplay(), showTestMessageLogicalToOdbc(), showTestMessageLogicalToXSD(), showTestMessageNormalize(), showTestMessageSet(), showTestMessageXSDToLogical()
property testError as %String);
test Result error message As %String
Property methods: testErrorDisplayToLogical(), testErrorGet(), testErrorIsValid(), testErrorLogicalToDisplay(), testErrorLogicalToOdbc(), testErrorNormalize(), testErrorSet()
property testIsRoutingRule as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Flag to indicate if a routing rule
Property methods: testIsRoutingRuleDisplayToLogical(), testIsRoutingRuleGet(), testIsRoutingRuleIsValid(), testIsRoutingRuleLogicalToDisplay(), testIsRoutingRuleLogicalToOdbc(), testIsRoutingRuleLogicalToXSD(), testIsRoutingRuleNormalize(), testIsRoutingRuleSet(), testIsRoutingRuleXSDToLogical()
property testMessageHTML as %String);
HTML rendition of the test message contents
Property methods: testMessageHTMLDisplayToLogical(), testMessageHTMLGet(), testMessageHTMLIsValid(), testMessageHTMLLogicalToDisplay(), testMessageHTMLLogicalToOdbc(), testMessageHTMLNormalize(), testMessageHTMLSet()
property testMessageNeedsEscaping as %Boolean [ InitialExpression = 1 ];
Indicate if test message needs HTML escaping before writing to current device
Property methods: testMessageNeedsEscapingDisplayToLogical(), testMessageNeedsEscapingGet(), testMessageNeedsEscapingIsValid(), testMessageNeedsEscapingLogicalToDisplay(), testMessageNeedsEscapingLogicalToXSD(), testMessageNeedsEscapingNormalize(), testMessageNeedsEscapingSet(), testMessageNeedsEscapingXSDToLogical()
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 methods: testRanOKDisplayToLogical(), testRanOKGet(), testRanOKIsValid(), testRanOKLogicalToDisplay(), testRanOKLogicalToOdbc(), testRanOKLogicalToXSD(), testRanOKNormalize(), testRanOKSet(), testRanOKXSDToLogical()
property testResultJSON as %String);
test Result as JSON
Property methods: testResultJSONDisplayToLogical(), testResultJSONGet(), testResultJSONIsValid(), testResultJSONLogicalToDisplay(), testResultJSONLogicalToOdbc(), testResultJSONNormalize(), testResultJSONSet()
property testSource as %String (MAXLEN = 128);
User entered production source item for the test
Property methods: testSourceDisplayToLogical(), testSourceGet(), testSourceIsValid(), testSourceLogicalToDisplay(), testSourceLogicalToOdbc(), testSourceLookup(), testSourceNormalize(), testSourceSet()
property tipContractAll as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Contract Rules on the diagram") ];
Property methods: tipContractAllDisplayToLogical(), tipContractAllGet(), tipContractAllIsValid(), tipContractAllLogicalToDisplay(), tipContractAllLogicalToOdbc(), tipContractAllNormalize(), tipContractAllSet()
property tipExpandAll as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Expand Rules on the diagram") ];
Property methods: tipExpandAllDisplayToLogical(), tipExpandAllGet(), tipExpandAllIsValid(), tipExpandAllLogicalToDisplay(), tipExpandAllLogicalToOdbc(), tipExpandAllNormalize(), tipExpandAllSet()
property tipNew as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Create a new Rule") ];
Property methods: tipNewDisplayToLogical(), tipNewGet(), tipNewIsValid(), tipNewLogicalToDisplay(), tipNewLogicalToOdbc(), tipNewNormalize(), tipNewSet()
property tipOpen as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Load an existing Rule") ];
Property methods: tipOpenDisplayToLogical(), tipOpenGet(), tipOpenIsValid(), tipOpenLogicalToDisplay(), tipOpenLogicalToOdbc(), tipOpenNormalize(), tipOpenSet()
property tipSave as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Save this Rule") ];
Property methods: tipSaveAsDisplayToLogical(), tipSaveAsGet(), tipSaveAsIsValid(), tipSaveAsLogicalToDisplay(), tipSaveAsLogicalToOdbc(), tipSaveAsNormalize(), tipSaveAsSet(), tipSaveDisplayToLogical(), tipSaveGet(), tipSaveIsValid(), tipSaveLogicalToDisplay(), tipSaveLogicalToOdbc(), tipSaveNormalize(), tipSaveSet()
property tipSaveAs as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Save this Rule with a new name") ];
Property methods: tipSaveAsDisplayToLogical(), tipSaveAsGet(), tipSaveAsIsValid(), tipSaveAsLogicalToDisplay(), tipSaveAsLogicalToOdbc(), tipSaveAsNormalize(), tipSaveAsSet()


Inherited description: Return the array of links to show in the locator bar.
method %OnAfterCreatePage() as %Status [ Language = objectscript ]
Ensure the timestamp for the current BPL is loaded and sent out to the client.
method %OnDrawHTMLHead() as %Status [ Language = objectscript ]
Inherited description: Add the EnsException error handling on the client.
method %OnGetPageName() as %String [ Language = objectscript ]
Get the (localized) name of the page.
method %OnGetTitle() as %String [ Language = objectscript ]
Get the (localized) title string for the page.
classmethod CreateRuleClass(pClassName As %String) as %Status [ Language = objectscript, ZenMethod ]
Create a new Rule class.
method DrawErrorResult(pSeed As %String) as %Status [ Language = objectscript ]
Method to draw any error of results.
method DrawMessageHTML(pShowTestMessage As %String) as %Status [ Language = objectscript ]
Method to draw the Message
method DrawRuleDebugLog(pSeed As %String) as %Status [ Language = objectscript ]
Method to draw the Rule Debug
method DrawRuleLog(pIsRoutingRule As %String) as %Status [ Language = objectscript ]
Method to draw the Rule log
method GetConditionObject(ByRef Params, Output pObject As %RegisteredObject) as %Status [ Language = objectscript ]
classmethod GetHyperEventResources(pMethod As %String = "") as %String [ Language = objectscript ]
Inherited description: 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 [ Language = objectscript ]
Return the internal name of the current document.
method GetObjectEntryURL() as %String [ Language = objectscript, ZenMethod ]
classmethod GetRuleAssistInfo(pClassname) as %String [ Language = objectscript, ZenMethod ]
classmethod GetRuleAssistList(ByRef pParameters As %String, Output pObject) as %Status [ Language = objectscript ]
classmethod GetRuleAssistShortDisplay(pClass As %String, pProxy As %ZEN.proxyObject) as %String [ Language = objectscript, ZenMethod ]
method GetRuleDefinitionObject(ByRef Params, Output pObject As %RegisteredObject) as %Status [ Language = objectscript ]
method InitializeServer(ByRef Params, Output pObject As %RegisteredObject) as %Status [ Language = objectscript ]
method LoadRuleDefinition() as %Status [ Language = objectscript ]
method OnDrawRibbon() as %Status [ Language = objectscript ]
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 %Library.Boolean, Output pViewIcons As %Library.List, Output pSortOptions As %Library.List, Output pSearchBox As %Library.Boolean, Output pRibbonTitle As %Library.String, Output pCommands As %Library.List) as %Status [ Language = objectscript ]
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 [ Language = objectscript ]
classmethod ServerGetPropertyList(proxy As %ZEN.proxyObject, pBase As %String) as %String [ Language = objectscript, ZenMethod ]
classmethod ValidateAlias(pClassName, pAlias) as %String [ Language = objectscript, ZenMethod ]
clientmethod addClassToElement(elem, classToAdd) [ Language = javascript ]
clientmethod backgroundClicked() [ Language = javascript ]
clientmethod btnEnterData() [ Language = javascript ]
clientmethod btnTest() [ Language = javascript ]
clientmethod buildConstraintCache() [ Language = javascript ]
clientmethod buttonAddClicked() [ Language = javascript ]
clientmethod buttonAddMouseDown() [ Language = javascript ]
clientmethod buttonDeleteClicked() [ Language = javascript ]
clientmethod buttonDetailClicked() [ Language = javascript ]
clientmethod buttonDownClicked() [ Language = javascript ]
clientmethod buttonUpClicked() [ Language = javascript ]
clientmethod buttonViewClicked(showProperty) [ Language = javascript ]
method canTestIfRunning(Output pErrorText As %String = "") as %Boolean [ Language = objectscript ]
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
clientmethod centerFocusedObject() [ Language = javascript ]
clientmethod changeContextSource() [ Language = javascript ]
What to do when the user selects a new testContextSource value.
clientmethod changeImage(imageId, enabled) [ Language = javascript ]
clientmethod chooseSCMenu(menuName, commandName, saveFlags) [ Language = javascript ]
Handle a source control menu selection.
clientmethod clearConstraintCache() [ Language = javascript ]
clientmethod clone(obj, focused) [ Language = javascript ]
clientmethod collapseOrExpandAll(isCollapse) [ Language = javascript ]
Collapse (if argument is true) or expand (if argument is false) all rules of first level
clientmethod collapseOrExpandAll2(isCollapse) [ Language = javascript ]
Collapse (if argument is true) or expand (if argument is false) all rules of first level
clientmethod collapseOrExpandAllContd(isCollapse) [ Language = javascript ]
clientmethod collapseOrExpandAllContd2(isCollapse) [ Language = javascript ]
clientmethod collapseRule(objectId) [ Language = javascript ]
Collapse or expand a rule (flip state)
clientmethod collapseRuleContd(objectId) [ Language = javascript ]
clientmethod collapseRuleObject2(jObject) [ Language = javascript ]
Collapse a rule
method configureTestTab() [ Language = objectscript ]
Used to configure test data entry pane
clientmethod constraintGetDisplay(rule) [ Language = javascript ]
clientmethod debugClicked() [ Language = javascript ]
clientmethod deferredComboUpdate() [ Language = javascript ]
clientmethod deferredEscapeAction() [ Language = javascript ]
classmethod deleteUncompiledRule(pClassName As %String) as %Status [ Language = objectscript, ZenMethod ]
Delete the class definition for a Rule that the user exited without saving first
clientmethod doOwnerDrawMain() [ Language = javascript ]
clientmethod doOwnerDrawTable() [ Language = javascript ]
clientmethod doOwnerDrawTabs() [ Language = javascript ]
clientmethod doScroll(delta) [ Language = javascript ]
clientmethod drawCondition(svg, groupParent, x, y, pData) [ Language = javascript ]
clientmethod drawConditionTextBox(svg, groupParent, x, y, jsonObject, jsonProperty, jsonParentObject, jsonParentArrayObject, jsonParentArrayIndex, jsonChildrenArrayObject) [ Language = javascript ]
clientmethod drawData(svg, isEnabled, x, y, pObject, pRuleObject, pParentObject, pParentArrayObject, pParentArrayIndex, pParentLoop) [ 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, disabled) [ Language = javascript ]
clientmethod drawHPath(svg, x1, x2, y) [ Language = javascript ]
draw horizontal path, with a rounded elbow
clientmethod drawLine(svg, x1, y1, x2, y2, drawInFront) [ Language = javascript ]
clientmethod drawOneTab(index, tabwidth, isActive) [ Language = javascript ]
clientmethod drawPlusMinus(svg, cx, cy, object) [ Language = javascript ]
draw the plus or minus for rule collapsing
clientmethod drawRuleDefinition() [ Language = javascript ]
clientmethod drawRuleHeader() [ Language = javascript ]
clientmethod drawRuleSet(skipLoseFocus) [ Language = javascript ]
clientmethod drawRuleSetsTable() [ Language = javascript ]
clientmethod drawRuleType() [ 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 drawTableCell(count, x, y, width, height, caption, classsuffix, focusable, dragable) [ Language = javascript ]
clientmethod drawTableRow(count, width, name, begin, end) [ Language = javascript ]
clientmethod drawTabs() [ Language = javascript ]
clientmethod drawTestPanel(show) [ Language = javascript ]
clientmethod drawTextBox(svg, isEnabled, x, y, jsonObject, jsonProperty, jsonRuleObject, jsonParentObject, jsonParentArrayObject, jsonParentArrayIndex, jsonChildrenArrayObject, jsonParentLoopObject) [ Language = javascript ]
method encounteredError(pHTMLText As %String = "") as %Boolean [ Language = objectscript ]
classmethod evaluateRule(pContext As %RegisteredObject, pRuleName As %String, Output pRuleLogData As %String = "", pDebugFlags As %String = "crd", pSelectMode As %Integer = 2) as %Status [ Language = objectscript ]
Given a context object evaluate the rule and create result output as JSON
clientmethod expandRuleObject2(jObject) [ Language = javascript ]
Expand a rule
clientmethod findRuleNo(object) [ Language = javascript ]
clientmethod getClientModel() [ Language = javascript ]
Get the JSON model on the client.
clientmethod getCurrentName() [ Language = javascript ]
Return the current name of the class/object being modified
clientmethod getFocus(id) [ Language = javascript ]
clientmethod getPropertyErrorText(jsonObject, jsonProperty) [ Language = javascript ]
clientmethod getRuleContext(context) [ Language = javascript ]
clientmethod getSegment(pathString) [ Language = javascript ]
clientmethod getSelection(ctrl) [ Language = javascript ]
clientmethod headerPopulateComboBoxes() [ Language = javascript ]
clientmethod hideAllHelpPanelActions(imagesToo) [ Language = javascript ]
clientmethod initialize() [ Language = javascript ]
clientmethod insertMainMap(svgRectObject, svgTextObject, jsonObject, jsonProperty, jsonRuleObject, jsonParentObject, jsonParentArrayObject, jsonParentArrayIndex, jsonChildrenArrayObject, jsonParentLoopObject) [ Language = javascript ]
clientmethod isRuleCollapsed(object) [ Language = javascript ]
Return true if rule state is collapsed
clientmethod isRuleCollapsed2(object) [ Language = javascript ]
clientmethod jsonNewObject(type) [ Language = javascript ]
clientmethod loseFocus() [ 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 newObject(objType) [ Language = javascript ]
clientmethod newRule(ruleName) [ Language = javascript ]
clientmethod objectClicked(event, isDoubleClick) [ Language = javascript ]
clientmethod onDocumentReload(reason) [ Language = javascript ]
Ensure we redraw the diagram if a reload was requested
clientmethod onDocumentSaveComplete(contentUpdated) [ Language = javascript ]
Ensure we redraw the diagram if the model was updated.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
clientmethod onlayoutHandler(load) [ Language = javascript ]
Inherited description: 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.
clientmethod onmousedown(event) [ Language = javascript ]
clientmethod onmousemove(event) [ Language = javascript ]
clientmethod onmouseout(event) [ Language = javascript ]
clientmethod onmouseup(event) [ Language = javascript ]
clientmethod onunloadHandler() [ Language = javascript ]
Inherited description: This client event, if present, is fired when the page is unloaded. If this method returns a string value, then that is used as the return value of the HTML page's onbeforeunload handler (if more than one component returns a string, the first one encountered is used).
clientmethod openRule() [ Language = javascript ]
clientmethod point(x, y) [ Language = javascript ]
clientmethod populateMenuAddAction(prefix) [ Language = javascript ]
clientmethod populateMenuAddForEach(prefix) [ Language = javascript ]
clientmethod populateMenuAddWhen(prefix, isFirst, includeOtherwise) [ Language = javascript ]
clientmethod removeClassFromElement(elem, classToRemove) [ Language = javascript ]
clientmethod ruleAssistClassChanged() [ Language = javascript ]
clientmethod ruleTypeChanged() [ Language = javascript ]
classmethod ruleUncompiled(pClassName As %String) as %Boolean [ Language = objectscript, ZenMethod ]
method runTest() as %Boolean [ Language = objectscript, ZenMethod ]
run the test. Returns 1 if OK and 0 if not OK via encounteredError()
clientmethod saveRule(showDialog, oldName) [ Language = javascript ]
clientmethod selectContextClass() [ Language = javascript ]
method serializeMessageAsHTML(pMessageObject As %RegisteredObject, Output pSC As %Status = $$$OK, Output pNeedsHTMLEscaping As %Boolean = 1) as %Stream.TmpCharacter [ Language = objectscript ]
Given an object create an HTML serialization of the object.
clientmethod setComboOptions(combo, options, insertBlank) [ Language = javascript ]
clientmethod setComboValue(combo, value) [ Language = javascript ]
clientmethod setReadOnly(readOnly) [ Language = javascript ]
Inherited description: 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.
clientmethod setSelection(ctrl, pos1, pos2) [ Language = javascript ]
clientmethod showMsgBox(pShow) [ Language = javascript ]
Show or hide message box.
clientmethod 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()().
clientmethod stopDrag() [ Language = javascript ]
method sufficientTestData(Output pErrorText As %String = "") as %Boolean [ Language = objectscript ]
clientmethod tabClicked(index) [ Language = javascript ]
clientmethod testSourceLookup() [ Language = javascript ]
clientmethod textEditorKeypress() [ Language = javascript ]
clientmethod textOKClicked() [ Language = javascript ]
clientmethod toggleHelp() [ Language = javascript ]
Hide/show assist panel.
clientmethod toggleMessageDiv(show) [ Language = javascript ]
clientmethod 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'.
clientmethod transferEditorData() [ Language = javascript ]
clientmethod undoStackInit() [ Language = javascript ]
clientmethod undoStackPop() [ Language = javascript ]
clientmethod undoStackPush(dataChanged) [ Language = javascript ]
clientmethod undoStackRedo() [ Language = javascript ]
clientmethod undoStackResetModified() [ Language = javascript ]
clientmethod updateButtons() [ Language = javascript ]
clientmethod updateHelpPanel() [ Language = javascript ]
clientmethod updateMenuAdd() [ Language = javascript ]
clientmethod validateRule() [ Language = javascript ]
clientmethod variablesChanged(newlist) [ 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