Home > Class Reference > ENSLIB namespace > %DeepSee.Report.UI.supplementalCodeEditor
Private  Storage   

%DeepSee.Report.UI.supplementalCodeEditor


class %DeepSee.Report.UI.supplementalCodeEditor extends %ZEN.Component.composite

Supplemental Code Editor This is the master display panel for the code editors that allows the user to inject server side code into generated DeepSee report data collector classes

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 12


Summary


Properties
%condition %import %includeFiles %page
%resource align aux cellAlign
cellSize cellStyle cellVAlign children
childrenCreated composite containerStyle disabled
dragEnabled dropEnabled enclosingClass enclosingStyle
error groupClass groupStyle height
hidden hint hintClass hintStyle
id index label labelClass
labelDisabledClass labelPosition labelStyle layout
name onafterdrag onbeforedrag onclick
ondrag ondrop onhide onrefresh
onshow onupdate parent showLabel
slice title tuple valign
visible width window

Methods
%AddChild %AddChildAfter %AddChildBefore %AddToSaveSet
%Attr %BindExport %ClassIsLatestVersion %ClassName
%ConstructClone %CreateComposite %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawComponentHTML %DrawHTML %DrawJSStrings
%EnclosingDivId %Eval %EvalC %Extends
%ForceClientRender %GetChildById %GetChildIndex %GetEventHandlers
%GetPaneContents %GetParameter %GetXMLName %IsA
%IsModified %MakeId %New %NormalizeObject
%ObjectModified %OnAddToPageAfter %OnAddToPageBefore %OnAfterCreateComposite
%OnDrawEnclosingDiv %OnDrawObjectProperties %OnMutateChildren %OnObjectSynch
%OnSubmit %OnZENDeserialize %OriginalNamespace %PackageName
%QuoteValue %QuoteValueL10N %RemoveChild %RemoveChildren
%RemoveFromSaveSet %Self %SerializeObject %SetModified
%ValidateObject DrawSupplementalCodeHeader XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType addChild addChildAfter
addChildBefore addNewMethod adjustLayout childrenMutated
deconflictMethodName deleteMethod dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
exposeComponent findElement fireOnUpdateEvent getChildById
getChildIndex getEnclosingDiv getHidden getHintElement
getLabelElement getModel getNewMethodPanel getProperty
getSettings getType invokeSuper isOfType
isUniqueMethodName makeId onCreate onDelete
onDisplayHandler onEndModalHandler onPopupAction onRefreshContents
onSerialize onStartModalHandler ondisabledHandler onloadHandler
onunloadHandler onupdateHandler populatePanel refreshContents
removeChild render renderContents renderSVG
reset restoreModel setHidden setOverlayMode
setProperty setPropertyAll startProgressBar stopProgressBar


Parameters


• parameter INCLUDEFILES = "zenCSLM.js,zenCEM.js";
CSV list of additional include files (either .js or .css) that should be included when this component is used on a page.
By default, the file extension (.js or .css) is used to determine whether an item in the list is a script include or a style include. You can override this behavior by adding the terms "script:" or "style:" to the beginning of the file name or names. This prefix is not used as part of the include filename.

Methods


• method DrawSupplementalCodeHeader(pSeed As %String) as %Status
Draw the contents of the Supplemental Code Header (the region above the list of known code blocks).
• method addNewMethod() [ Language = javascript ]
Add a new method to the set
• method adjustLayout() [ Language = javascript ]
Correct the layout of the screen to account for the current window size
• method deconflictMethodName(n) [ Language = javascript ]
Given a proposed method name, deconflict it with all existing method names in the model by appending a numeric suffix
• method deleteMethod(editorIdx, modelIdx) [ Language = javascript ]
Delete a given method from the model and update the screen accoridngly
• method getModel() [ Language = javascript ]
• method getNewMethodPanel() [ Language = javascript ]
• method isUniqueMethodName(n) [ Language = javascript ]
Given a proposed method name, return true is the method name is unique with respect to the other method names in the model
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method populatePanel(panelIdx, methodIdx) [ Language = javascript ]
After the creation of a new Method Definition Panel, populate it with the appropriate data based on the methods of the class being edited.
• method reset() [ Language = javascript ]
Remove any active method panels from this screen
• method restoreModel(m) [ Language = javascript ]
Set underlying model of the widget and update the screen accordingly The model object is an array of JSON method objects A methodObj has the following properties
n: (string) The method name
t: (string) The return type
l: (string) The language used (currently only ObjectScript is supported)
a: (array) A list of argument objects
b: (long string) The body of the method

Each entry of the args array is an argObj, and looks like:
n: (string) The name of the parameter t: (string) The parameter type d: (string) The default value of the parameter