%ZHSLIB.PackageManager.Developer.Extension.UI.templatePage
class %ZHSLIB.PackageManager.Developer.Extension.UI.templatePage extends %ZEN.Template.studioTemplate
Package Manager UI template pageProperty Inventory (Including Private)
Method Inventory (Including Private)
- %DrawFooter()
- %DrawTitle()
- %OnGetSubtitle()
- %OnGetTitle()
- CheckDirectoryContents()
- GetCommonLocalization()
- GetModuleListSQL()
- GetSnapshotModuleListSQL()
- cancelTemplate()
- confirmCancel()
- isModified()
- loadDropdown()
- setErrorMessage()
Parameters
parameter APPLICATION = %ZHSLIB.PackageManager.Developer.Extension.UI.Application;
Class name of application this page belongs to.
parameter CSPURL = "/isc/studio/templates/"_$classname()_".cls";
Lock down access to this class to the /isc/studio/templates/ web application.
parameter CSSINCLUDES = bootstrap-3-3-5/dist/css/bootstrap.min.css;
Inherited description: Comma-separated list of additional CSS include files for the page.
If this page is using CSS3 then the CSS3INCLUDES parameter is used (if defined).
parameter DOMAIN = HSPM;
Domain used for localization.
parameter JSINCLUDES = jquery-1.11.3.min.js,bootstrap-3-3-5/dist/js/bootstrap.min.js;
Inherited description: Comma-separated list of additional JS include files for the page.
parameter PAGENAME = Package Manager templatePage;
Displayed name of this page.
parameter SECURITYRESOURCE = %Development:USE;
All CSP/Zen pages in the package manager require USE permissions on the %Development resource.
Properties (Including Private)
property Namespace as %ZEN.Datatype.string (ZENURL = "$NAMESPACE");
Inherited description: Current namespace within Studio.
Property methods: NamespaceDisplayToLogical(), NamespaceGet(), NamespaceIsValid(), NamespaceLogicalToDisplay(), NamespaceLogicalToOdbc(), NamespaceNormalize(), NamespaceSet()
property Page as %ZEN.Datatype.string;
Property methods: Page(), PageDisplayToLogical(), PageGet(), PageIsValid(), PageLogicalToDisplay(), PageLogicalToOdbc(), PageNormalize(), PageSet()
property SelectModuleNameTitle as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("(Select a Module name)") ];
Property methods: SelectModuleNameTitleDisplayToLogical(), SelectModuleNameTitleGet(), SelectModuleNameTitleIsValid(), SelectModuleNameTitleLogicalToDisplay(), SelectModuleNameTitleLogicalToOdbc(), SelectModuleNameTitleNormalize(), SelectModuleNameTitleSet()
property SelectOne as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("(select one)") ];
Property methods: SelectOneDisplayToLogical(), SelectOneGet(), SelectOneIsValid(), SelectOneLogicalToDisplay(), SelectOneLogicalToOdbc(), SelectOneNormalize(), SelectOneSet()
property lblErrorPrefix as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Error!", "HSPM") ];
Property methods: lblErrorPrefixDisplayToLogical(), lblErrorPrefixGet(), lblErrorPrefixIsValid(), lblErrorPrefixLogicalToDisplay(), lblErrorPrefixLogicalToOdbc(), lblErrorPrefixNormalize(), lblErrorPrefixSet()
property pageModified as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
True if the contents of this page need to be saved.
Property methods: pageModifiedDisplayToLogical(), pageModifiedGet(), pageModifiedIsValid(), pageModifiedLogicalToDisplay(), pageModifiedLogicalToOdbc(), pageModifiedLogicalToXSD(), pageModifiedNormalize(), pageModifiedSet(), pageModifiedXSDToLogical()
Methods (Including Private)
Provide HTML for html footer box.
Default implementation displays the standard Cancel button.
Default implementation displays the standard Cancel button.
Provide HTML for html title box.
Default implementation displays the standard Package Manager title bar.
Default implementation displays the standard Package Manager title bar.
method %OnGetSubtitle() as %String [ Language = objectscript ]
Get the (localized) subtitle string for the page.
This may be implemented in a subclass.
method %OnGetTitle() as %String [ Language = objectscript ]
Get the (localized) title string for the page.
This may be implemented in a subclass.
classmethod CheckDirectoryContents(pPath As %String, pExpectedModuleName As %String, Output pMessage As %String) as %Status [ Language = objectscript ]
method GetCommonLocalization(ByRef pResources As %String) [ Language = objectscript ]
Commonly used localization strings. (please enter in alphabetical order)
method GetModuleListSQL(ByRef pParms As %String, ByRef pSQL As %String, pCriteria As %ZEN.proxyObject, ByRef pPagingInfo As %String) as %Status [ Language = objectscript ]
Method to return Module list used by multiple templates.
method GetSnapshotModuleListSQL(ByRef pParms As %String, ByRef pSQL As %String, pCriteria As %ZEN.proxyObject, ByRef pPagingInfo As %String) as %Status [ Language = objectscript ]
Method to return list of installed snapshot modules
clientmethod cancelTemplate() [ Language = javascript ]
Close the template window.
clientmethod confirmCancel() [ Language = javascript ]
Check before Cancel out. If user has unsaved changes, prompt to save.
clientmethod isModified() [ Language = javascript ]
clientmethod loadDropdown(id, dataSource, valueProperty, descProperty, allowEmpty) [ Language = javascript ]
Generic method to load a bootstrap style dropdown.
id: input text field id for the dropdown
dataSource: jsonProvider id
valueProperty: Value property name
descProperty (optional): Description property name. If not passed in, valueProperty will be used
allowEmpty (optional): if 1 is passed in, then build an empty selection
example: this.loadDropdown('InstallerClass','jsonInstallerClassList','Name','DisplayName');
clientmethod setErrorMessage(msg, ctrl) [ Language = javascript ]
Inherited Members
Inherited Properties (Including Private)
- %condition
- %import
- %includeFiles
- %page
- %resource
- DocumentName
- DocumentNamespace
- Language
- 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
Inherited Methods (Including Private)
- %AddChild()
- %AddChildAfter()
- %AddChildBefore()
- %AddComponent()
- %AddImportedComponents()
- %AddToProject()
- %AddToSaveSet()
- %AddToSourceControl()
- %ApplyURLParms()
- %Attr()
- %BindExport()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %ConstructCloneInit()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %DrawAutoLogout()
- %DrawClassDefinitions()
- %DrawComponentHTML()
- %DrawFrameSet()
- %DrawHTML()
- %DrawHTMLPage()
- %DrawJSResources()
- %DrawJSStrings()
- %DrawObjectDefinitions()
- %EnclosingDivId()
- %EndBackgroundMethod()
- %EndScript()
- %Eval()
- %EvalC()
- %Extends()
- %ForceClientRender()
- %GetChildIndex()
- %GetComponent()
- %GetComponentById()
- %GetComponentByName()
- %GetEventHandlers()
- %GetJSResources()
- %GetLinks()
- %GetPageName()
- %GetParameter()
- %GetValueById()
- %GetValueByName()
- %GetXMLName()
- %IsA()
- %IsModified()
- %LayoutChildren()
- %Link()
- %LinkCSS()
- %LinkScript()
- %MakeId()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OnAddToPageAfter()
- %OnAddToPageBefore()
- %OnAddToSaveSet()
- %OnAfterCreatePage()
- %OnBeforeCreatePage()
- %OnClose()
- %OnConstructClone()
- %OnCreateApplication()
- %OnCreatePage()
- %OnDetermineCSSLevel()
- %OnDrawEnclosingDiv()
- %OnDrawHTMLBody()
- %OnDrawHTMLHead()
- %OnDrawHTMLMeta()
- %OnDrawObjectProperties()
- %OnFinishBackgroundTask()
- %OnGetJSResources()
- %OnMonitorBackgroundTask()
- %OnMutateChildren()
- %OnNew()
- %OnObjectSynch()
- %OnPreHTTP()
- %OnSubmit()
- %OnTemplateAction()
- %OnUseSoftModals()
- %OnValidateObject()
- %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()
- HyperEventCall()
- HyperEventHead()
- Include()
- InsertHiddenField()
- InsertHiddenFields()
- IsEnabled()
- IsPrivate()
- IsValidClassName()
- JavaInstalled()
- 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()
- childrenMutated()
- correctIELayering()
- createComponent()
- createComponentNS()
- deleteComponent()
- dragFinishHandler()
- dragHandler()
- dragNotifyHandler()
- dragStartHandler()
- dropHandler()
- dropStartHandler()
- endModal()
- exposeComponent()
- findElement()
- finishTemplate()
- fireOnResizeEvent()
- fireOnUnloadEvent()
- fireOnUpdateEvent()
- firePopupAction()
- formValidationHandler()
- getChildIndex()
- getComponent()
- getComponentById()
- getEnclosingDiv()
- getHidden()
- getHintElement()
- getLabelElement()
- getOpener()
- getProperty()
- getSettings()
- getType()
- gotoPage()
- hasMultiplePages()
- 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()
- updateState()
Subclasses
- %ZHSLIB.PackageManager.Developer.Extension.PackageManager.UI.Configuration
- %ZHSLIB.PackageManager.Developer.Extension.PackageManager.UI.DependencyAnalyzer
- %ZHSLIB.PackageManager.Developer.Extension.PackageManager.UI.Index
- %ZHSLIB.PackageManager.Developer.Extension.PackageManager.UI.Lifecycle
- %ZHSLIB.PackageManager.Developer.Extension.PackageManager.UI.LoadNewModule
- %ZHSLIB.PackageManager.Developer.Extension.PackageManager.UI.LocalizationDocWizard
- %ZHSLIB.PackageManager.Developer.Extension.PackageManager.UI.ModuleWizard
- %ZHSLIB.PackageManager.Developer.Extension.SourceControl.ISC.MapModule
- %ZHSLIB.PackageManager.Developer.Extension.SourceControl.ISC.UI