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

EnsPortal.ComplexRecordMapper

class EnsPortal.ComplexRecordMapper extends EnsPortal.Template.devPage

Property Inventory

Method Inventory

Parameters

parameter EDITRESOURCE = %Ens_Code:WRITE,%Ens_RecordMap:WRITE;
User needs WRITE permissions on either the %Ens_Code or the %Ens_RecordMap resource to make changes on this page.
parameter JSINCLUDES = zenCSLM.js;
Include zenCSLM.
parameter PAGENAME = Complex Record Mapper;
Displayed name of this page.
parameter RESOURCE = %Ens_Code:READ,%Ens_RecordMap:READ;
User needs READ permissions on either the %Ens_Code or the %Ens_RecordMap resource to view this page.

Properties

property %tempMap as EnsLib.RecordMap.Model.ComplexBatch;
Property methods: %tempMapGet(), %tempMapGetSwizzled(), %tempMapIsValid(), %tempMapNewObject(), %tempMapSet()
property complexMap as %ZEN.Datatype.string (ZENURL = "COMPLEXMAP");
Name of ComplexMap being viewed.
Property methods: complexMapAsNameDisplayToLogical(), complexMapAsNameGet(), complexMapAsNameIsValid(), complexMapAsNameLogicalToDisplay(), complexMapAsNameLogicalToOdbc(), complexMapAsNameNormalize(), complexMapAsNameSet(), complexMapDisplayToLogical(), complexMapGet(), complexMapIsValid(), complexMapLogicalToDisplay(), complexMapLogicalToOdbc(), complexMapNormalize(), complexMapSet()
property complexMapAsName as %ZEN.Datatype.string;
Property methods: complexMapAsNameDisplayToLogical(), complexMapAsNameGet(), complexMapAsNameIsValid(), complexMapAsNameLogicalToDisplay(), complexMapAsNameLogicalToOdbc(), complexMapAsNameNormalize(), complexMapAsNameSet()
property currItem as %ZEN.Datatype.integer [ InitialExpression = -1 ];
ID (index number, 0-based) of current selected item.
Property methods: currItemDisplayToLogical(), currItemGet(), currItemIsValid(), currItemLogicalToDisplay(), currItemLogicalToOdbc(), currItemNormalize(), currItemSet()
property lastLoc as %ZEN.Datatype.string (ZENURL = "LOC");
CSV-string used to remember last location across page redraws, especially involving popups.
Property methods: lastLocDisplayToLogical(), lastLocGet(), lastLocIsValid(), lastLocLogicalToDisplay(), lastLocLogicalToOdbc(), lastLocNormalize(), lastLocSet()
property msgDocReadOnly as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("This complex record map is read only.") ];
Property methods: msgDocReadOnlyDisplayToLogical(), msgDocReadOnlyGet(), msgDocReadOnlyIsValid(), msgDocReadOnlyLogicalToDisplay(), msgDocReadOnlyLogicalToOdbc(), msgDocReadOnlyNormalize(), msgDocReadOnlySet()
property tipDelete as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Delete the current Complex RecordMap") ];
Property methods: tipDeleteDisplayToLogical(), tipDeleteGet(), tipDeleteIsValid(), tipDeleteLogicalToDisplay(), tipDeleteLogicalToOdbc(), tipDeleteNormalize(), tipDeleteSet()
property tipGen as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Save this Complex RecordMap and generate classes") ];
Property methods: tipGenDisplayToLogical(), tipGenGet(), tipGenIsValid(), tipGenLogicalToDisplay(), tipGenLogicalToOdbc(), tipGenNormalize(), tipGenSet()
property tipNew as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Create a new Complex RecordMap") ];
Property methods: tipNewDisplayToLogical(), tipNewGet(), tipNewIsValid(), tipNewLogicalToDisplay(), tipNewLogicalToOdbc(), tipNewNormalize(), tipNewSet()
property tipOpen as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Open a saved Complex RecordMap") ];
Property methods: tipOpenDisplayToLogical(), tipOpenGet(), tipOpenIsValid(), tipOpenLogicalToDisplay(), tipOpenLogicalToOdbc(), tipOpenNormalize(), tipOpenSet()
property tipSave as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Save this Complex RecordMap") ];
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 Complex RecordMap with a new name") ];
Property methods: tipSaveAsDisplayToLogical(), tipSaveAsGet(), tipSaveAsIsValid(), tipSaveAsLogicalToDisplay(), tipSaveAsLogicalToOdbc(), tipSaveAsNormalize(), tipSaveAsSet()

Methods

method %OnAfterCreatePage() as %Status [ Language = objectscript ]
Inherited description: Determine whether source control is enabled and ensure we don't write out the session cookie if we are running in Studio mode.
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.
method GetInternalName() as %String [ Language = objectscript ]
Inherited description: Return the internal name of the current document, including the three letter extension in upper-case. For example, MyPackage.MyClass.CLS would be the internal name for the class MyPackage.MyClass. Subclasses MUST override this method.
classmethod GetLastMap() as %String [ Language = objectscript ]
method GetMapObject(ByRef pParms, Output pObject As %RegisteredObject) as %Status [ Language = objectscript ]
Get ComplexBatch object for the JSON provider.
method OnDrawRibbon() as %Status [ Language = objectscript ]
Inherited description: Use %DrawSourceControlCommands()() to render the extra source control options in the tool ribbon.
method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status [ Language = objectscript ]
Get information to display in the ribbon bar.
classmethod SetLastMap(pMapName As %String = "") [ Language = objectscript, ZenMethod ]
method SubmitMapObject(pCommand As %String, pProvider As %ZEN.Auxiliary.jsonProvider, ByRef pObject As %RegisteredObject, Output pResponse As %RegisteredObject) as %Status [ Language = objectscript ]
Process submitted JSON content based on the object created
clientmethod addItem(parentIndex, evt) [ Language = javascript ]
clientmethod addToNameIndex(element, index) [ Language = javascript ]
clientmethod addUndoAction(setModified) [ Language = javascript ]
Remember the current state in the undo buffer.
clientmethod applyChanges() [ Language = javascript ]
clientmethod buildPropIndex() [ Language = javascript ]
clientmethod canUndo() [ Language = javascript ]
Return true if it is possible to undo an action
clientmethod changeElementName(newName) [ Language = javascript ]
clientmethod changeElementType() [ Language = javascript ]
clientmethod changeTargetClassname(newMapName) [ Language = javascript ]
Check that the Target Classname is changed along with the ComplexMap name
clientmethod chooseSCMenu(menuName, commandName, saveFlags) [ Language = javascript ]
Handle a source control menu selection.
clientmethod clearUndoBuffer() [ Language = javascript ]
Clear the undo buffer.
clientmethod cloneObject(obj, clone) [ Language = javascript ]
Create a clone of the given object.
clientmethod deleteMap() [ Language = javascript ]
clientmethod drawElementHTML(element, parent, parentIndex, parentContracted, html, path, first, last, depth) [ Language = javascript ]
clientmethod drawHeaderTrailerHTML(complexMap, property, html) [ Language = javascript ]
clientmethod drawTable() [ Language = javascript ]
clientmethod generateMap() [ Language = javascript ]
clientmethod getClientModel() [ Language = javascript ]
Inherited description: Get the jsonProvider object on the client. Subclasses MUST override this method to return the jsonProvider.
clientmethod getComplexMap() [ Language = javascript ]
clientmethod getCurrentLocation() [ Language = javascript ]
Returns the index of the currently selected item and the offsets of the main window in a comma separated list. It returns the empty string "" if no item is selected.
clientmethod getCurrentName() [ Language = javascript ]
Return the current name of the class/object being modified
clientmethod getElementDetails(element) [ Language = javascript ]
clientmethod getElementType(element) [ Language = javascript ]
clientmethod getElementUserType(elementType, elementClass) [ Language = javascript ]
clientmethod getNextRecordName() [ Language = javascript ]
clientmethod loadEditor(complexMapName, location, newMap, renamed) [ Language = javascript ]
Load the page for the specified RecordMap.
clientmethod moveItem(index, direction, evt) [ Language = javascript ]
clientmethod newMap() [ Language = javascript ]
Create a new ComplexMap.
clientmethod onDocumentReload(reason) [ Language = javascript ]
Ensure we redraw the diagram if the model was updated.
clientmethod onDocumentSaveComplete(contentUpdated) [ Language = javascript ]
Ensure we redraw the table if the model was updated.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
Returning from popups
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 openMap() [ Language = javascript ]
Launch the finder dialog to select a ComplexMap.
clientmethod removeHeaderTrailer(which) [ Language = javascript ]
clientmethod removeItem(index, evt) [ Language = javascript ]
clientmethod rowMouseOut(evt, row) [ Language = javascript ]
clientmethod rowMouseOver(evt, row) [ Language = javascript ]
clientmethod saveMap(force, suppressOKMessage) [ Language = javascript ]
Method to save the Complex RecordMap to disk without generating any classes.
clientmethod saveMapAs() [ Language = javascript ]
clientmethod selectItem(index, force) [ Language = javascript ]
clientmethod setDescription(desc) [ Language = javascript ]
Update the description (annotation) of this record map.
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 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 toggleExpandingElement(index) [ Language = javascript ]
clientmethod toggleRepeating(index, getFromForm) [ Language = javascript ]
clientmethod undo() [ Language = javascript ]
Undo the most recent change.
clientmethod updateUndoButton() [ Language = javascript ]
clientmethod validateElement(element, rowIndex, errors) [ Language = javascript ]
clientmethod validateMap(reportErrors) [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

Feedback