Class Reference
%ZEN.Template.ZENElementInspector
Server:basexml
Instance:SOAXML
User:UnknownUser
 
-
  [BASEXML] >  [%ZEN] >  [Template] >  [ZENElementInspector]
Private  Storage

class %ZEN.Template.ZENElementInspector extends %ZEN.Template.studioTemplate

Studio Template:
Insert a new ZEN Element within an XData definition.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
7 7 20


Summary

This is a Zen Page class. 

Properties
%condition %import %includeFiles %page
%resource DocumentName DocumentNamespace Language
Namespace Project SelectedText User
align attrs aux backgroundTimerInterval
cellAlign cellSize cellStyle cellVAlign
children composite containerStyle cssLevel
currElementClass currElementName disabled dragAndDrop
dragEnabled dropEnabled editLabel elName
enclosingClass enclosingStyle error groupClass
groupStyle height helpId hidden
hint hintClass hintStyle id
index label labelClass labelDisabledClass
labelPosition labelStyle layout name
onafterdrag onbeforedrag onclick ondrag
ondrop onhide onrefresh onshow
onupdate parent postText preText
showLabel slice title tuple
useSVG useSoftModals valign visible
width window zenPersistentPopup

Methods
%%OIDGet %AddChild %AddChildAfter %AddChildBefore
%AddComponent %AddImportedComponents %AddToProject %AddToSaveSet
%AddToSourceControl %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 %Extends %ForceClientRender
%GetChildIndex %GetComponent %GetComponentById %GetComponentByName
%GetDescHTML %GetElementHelpHTML %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 %OnMonitorBackgroundTask
%OnMutateChildren %OnObjectSynch %OnPreHTTP %OnSubmit
%OnTemplateAction %OnUseSoftModals %OnZENDeserialize %OriginalNamespace
%PackageName %QuoteValue %QuoteValueL10N %RemoveChild
%RemoveChildren %RemoveComponent %RemoveFromSaveSet %RunBackgroundMethod
%Self %SerializeObject %SetBackgroundMethodStatus %SetClassName
%SetErrorById %SetErrorByName %SetModified %SetValueById
%SetValueByName %SetValuesByName %StartScript %TemplateHeader
%ValidateObject %ZENVersion ConvertParameter CreateElementRS
Decrypt Encrypt EscapeHTML EscapeURL
GetElementInfo HyperEventBody HyperEventCall HyperEventFrame
HyperEventHead Include InsertHiddenField InsertHiddenFields
IsEnabled IsPrivate IsValidClassName Link
LocalizeName OnHTTPHeader OnPage OnPageError
OnPostHTTP OnPostHyperEvent OnPreHTTP OnPreHyperEvent
Page QuoteJS RewriteURL ShowError
StartTimer StopTimer ThrowError UnescapeHTML
UnescapeURL XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType addChild addChildAfter addChildBefore
adjustSize canFinish canGoBack canGoNext
cancelPopup cancelTemplate childrenMutated computeGridValue
correctIELayering createComponent createComponentNS deleteComponent
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
drawPropCell dropHandler dropStartHandler elementChange
endModal exposeComponent findElement finishTemplate
fireOnLoadEvent fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent
firePopupAction formValidationHandler getChildIndex getComponent
getComponentById getEnclosingDiv getHidden getHintElement
getLabelElement getOpener getProperty getSettings
getType gotoPage hasMultiplePages htmlRefreshHandler
invokeSuper isOfType launchPopupWindow makeId
nextPage onCreate onDelete onDisplayHandler
onEndModalHandler onPopupAction onRefreshContents onSerialize
onServerMethodCall onServerMethodError onServerMethodReturn onStartModalHandler
ondisabledHandler onfinishHandler onkeydownHandler onkeyupHandler
onlayoutHandler onloadHandler onlogoutHandler onoverlayHandler
onresizeHandler onstartHandler onunloadHandler onupdateHandler
popupActionHandler previousPage refreshContents removeChild
render renderContents renderSVG setComponentId
setHidden setOverlayMode setProperty setPropertyAll
setTraceOption showDocumentation showHelp showValueEditor
startModal startProgressBar stopProgressBar tabChange
updateState


Parameters

• parameter DOMAIN = "%ZEN";
Domain used for localization.
• parameter HELPID = "GZEN_element_wizard";
DOCBOOK Topic Id that offers help for this template.
• parameter TEMPLATEDESCRIPTION = "Inserts a Zen XML element within a Contents document.";
Short description of the template to show in Studio.
If DOMAIN is defined this will be localized.
• parameter TEMPLATEMODE = "template";
What type of template.
• parameter TEMPLATENAME = "Zen Element Wizard";
Name of the template to show in Studio.
If DOMAIN is defined this will be localized.
• parameter TEMPLATETITLE = "Zen Element Wizard";
Title of the template to show in the template window.
• parameter TEMPLATETYPE = "cls";
Comma separated list of 'CSP', 'CSR', 'MAC', 'INT', 'INC', 'BAS', 'CLS' to say what type of code this template generates; CSP, CSR, Routine, or Class code. You can also specify '*' for all types.

Properties

• property attrs as array of %ZEN.Datatype.string;
Array of attributes and values from the target element.
• property currElementClass as %ZEN.Datatype.string;
Class name of selected element.
• property currElementName as %ZEN.Datatype.string;
Name of selected element.
• property editLabel as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Edit...") ];
Localized label for edit button.
• property elName as %ZEN.Datatype.string;
Name of the target element from selectedText.
• property postText as %ZEN.Datatype.string;
Portion of selected text *after* the target element.
• property preText as %ZEN.Datatype.string;
Portion of selected text *before* the target element.

Methods

• method %GetDescHTML(pSeed As %String) as %Status
Provide contents of description component.
• method %GetElementHelpHTML(pSeed As %String = "") as %Status
Provide contents of element help component.
• method %OnAfterCreatePage() as %Status
This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.
• method %OnTemplateAction() as %Status
This method is called when the template is complete. Any output to the principal device is returned to the Studio.
• method CreateElementRS(Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet
Create the result set used by the Element dataCombo.
• classmethod GetElementInfo(pClass As %String) as %String [ ZenMethod ]
Return csv-list of properties for the given element.
• method canGoBack() [ Language = javascript ]
Return true if this template can go to the previous page (i.e., enable the Back button).
• method canGoNext() [ Language = javascript ]
Return true if this template can go to the next page (i.e., enable the Next button).
• method computeGridValue(grid) [ Language = javascript ]
Convert the value within the property grid to something we can submit!
• method drawPropCell(grid, data) [ Language = javascript ]
called when cell is about to be drawn in dynaGrid
• method elementChange(cb) [ Language = javascript ]
Notification that the element combo has changed.
• method formValidationHandler() [ Language = javascript ]
Validation handler for form built-into template.
• method hasMultiplePages() [ Language = javascript ]
Return true if this template has more than one "page". This will display Back and Next buttons. This is implemented by subclasses.
• method htmlRefreshHandler() [ Language = javascript ]
htmlRefreshHandler This is called when the HTML help component is refreshed from the server.
• method nextPage() [ Language = javascript ]
Go to the next page of the template (if there is one).
• method onPopupAction(popupName, action, value) [ Language = javascript ]
This client event, if present, is fired when the a popup page launched from this page fires an action.
• method onstartHandler() [ Language = javascript ]
This is called when the template is first displayed; This provides a chance to set focus etc.
• method previousPage() [ Language = javascript ]
Go to the previous page of the template (if there is one).
• method showValueEditor(propNo) [ Language = javascript ]
Launch property editor. propNo is index of property in dataSet.
• method tabChange(tabGroup) [ Language = javascript ]
Notification that a new tab was selected.