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

class %ZEN.Template.ZENChartWizard extends %ZEN.Template.studioTemplate

Studio Template:
Inserts a new chart definition within an XData definition.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
7 21


Summary

This is a Zen Page class. 

Properties
%condition %import %includeFiles %page
%resource DocumentName DocumentNamespace Language
Namespace Project SelectedText User
align aux backgroundTimerInterval cellAlign
cellSize cellStyle cellVAlign children
composite containerStyle cssLevel disabled
dragAndDrop dragEnabled dropEnabled 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 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 %GetDescHTML2 %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 Decrypt
Encrypt EscapeHTML EscapeURL HyperEventBody
HyperEventCall HyperEventFrame HyperEventHead Include
InsertHiddenField InsertHiddenFields IsEnabled IsPrivate
IsValidClassName Link LocalizeName OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
RewriteURL SerializeChart ShowError StartTimer
StopTimer ThrowError UnescapeHTML UnescapeURL
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore adjustSize
canFinish canGoBack canGoNext cancelPopup
cancelTemplate changeChart chartTypeChange childrenMutated
correctIELayering createComponent createComponentNS deleteComponent
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
dropHandler dropStartHandler editProperty endModal
exposeComponent findElement finishTemplate fireOnLoadEvent
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent firePopupAction
formValidationHandler getChartData getChildIndex getComponent
getComponentById getEnclosingDiv getHidden getHintElement
getLabelElement getOpener getProperty getSettings
getType gotoPage hasMultiplePages inspectElement
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 startModal
startProgressBar stopProgressBar tabChange updateState


Parameters

• parameter DOMAIN = "%ZEN";
Domain used for localization.
• parameter HELPID = "GZEN_chart_wizard";
DOCBOOK Topic Id that offers help for this template.
• parameter TEMPLATEDESCRIPTION = "Inserts a Zen chart definition 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 Chart Wizard";
Name of the template to show in Studio.
If DOMAIN is defined this will be localized.
• parameter TEMPLATETITLE = "Zen Chart 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.

Methods

• method %GetDescHTML(pSeed As %String) as %Status
Provide contents of description component.
• method %GetDescHTML2(pSeed As %String) as %Status
Provide contents of description 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.
• classmethod SerializeChart(pChart As %ZEN.SVGComponent.chart) as %String [ ZenMethod ]
Convert chart to xml representation.
• 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 changeChart(chartType) [ Language = javascript ]
Create and display the specified chart type.
• method chartTypeChange(cb) [ Language = javascript ]
Notification that the chart type has changed.
• method editProperty() [ Language = javascript ]
User has pressed edit button in the objectInspector.
• method formValidationHandler() [ Language = javascript ]
Validation handler for form built-into template.
• method getChartData(series) [ Language = javascript ]
Callback to provide random data for chart.
• 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 inspectElement(name) [ Language = javascript ]
Point object inspector to given component.
• 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 onfinishHandler() [ Language = javascript ]
This is called when the template is finished;
• method onlayoutHandler(load) [ Language = javascript ]
This client event, if present, is fired when the page is first loaded or whenever it is resized.
• 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 tabChange(tabGroup) [ Language = javascript ]
Notification that a new tab was selected.