Home > Class Reference > %SYS namespace > %ZHSLIB.PackageManager.Developer.Extension.PackageManager.UI.LocalizationDocWizard

%ZHSLIB.PackageManager.Developer.Extension.PackageManager.UI.LocalizationDocWizard

class %ZHSLIB.PackageManager.Developer.Extension.PackageManager.UI.LocalizationDocWizard extends %ZHSLIB.PackageManager.Developer.Extension.UI.templatePage

This page allows user to create or edit a Localization (LOC) file

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter CSSINCLUDES = bootstrap-3-3-5/dist/css/bootstrap.min.css,bootstrap-table/bootstrap-table.css,//rawgit.com/vitalets/x-editable/master/dist/bootstrap3-editable/css/bootstrap-editable.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 HELPID = GHSPM_localization_document_wizard;
Inherited description: DOCBOOK Topic Id that offers help for this template.
parameter TEMPLATEDESCRIPTION = Create or Edit a Localization Document;
Inherited description: Short description of the template to show in Studio.
If DOMAIN is defined this will be localized.
parameter TEMPLATEGROUP = General;
Inherited description: If this is a TEMPLATEMODE="new" then this is the name of the tab in Studio this template is dispayed on. If none specified then it displays on 'Custom' tab.
parameter TEMPLATEMODE = new;
What type of template.
parameter TEMPLATENAME = Localization Document Wizard;
Inherited description: Name of the template to show in Studio.
If DOMAIN is defined this will be localized.
parameter TEMPLATETITLE = Package Manager - Localization Document Wizard;
Inherited description: Title of the template to show in the template window.
parameter TEMPLATETYPE = XML;
Inherited description: 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 (Including Private)

property InternalName as %ZEN.Datatype.string (ZENURL = "InternalName");
Property methods: InternalNameDisplayToLogical(), InternalNameGet(), InternalNameIsValid(), InternalNameLogicalToDisplay(), InternalNameLogicalToOdbc(), InternalNameNormalize(), InternalNameSet()
property WizardTitle as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Localization Document Wizard") ];
Property methods: WizardTitleDisplayToLogical(), WizardTitleGet(), WizardTitleIsValid(), WizardTitleLogicalToDisplay(), WizardTitleLogicalToOdbc(), WizardTitleNormalize(), WizardTitleSet()

Methods (Including Private)

private method %OnGetJSResources(ByRef pResources As %String) as %Status [ Language = objectscript ]
Inherited description: Pages can implement this callback method in order to define a set of client-side resources: javascript strings that have been localized.
This method should fill in the array pResources with a set of localized strings, indexed by resource id:
   Set pResources("MyId") = $$$Text("Some string")
Javascript methods can refer to these resources using the helper function zenGetResource: 
 alert(zenText('MyId'));
Zen defines a set of built-in resource strings using this mechanism. These have a "zen" prefix to keep them seperate from user ids.
You can also override the same callback method within your %ZEN.application class if you wish to share resources across an application. In this case, the application-wide callback is invoked first.
method %OnTemplateAction() as %Status [ Language = objectscript ]
Inherited description: This method is called when the template is complete. Any output to the principal device is returned to the Studio. This is implemented by subclasses.
method GetLanguageList(ByRef pParms, Output pObject As %RegisteredObject) as %Status [ Language = objectscript ]
method GetMessageFile(ByRef pParms, Output pObject As %RegisteredObject) as %Status [ Language = objectscript ]
classmethod Submit(pInternalName As %String, pDocName As %String, pJSONString As %String) as %Boolean [ Language = objectscript, ZenMethod ]
Save or Create File. If InternalName exists then this is an edit. Else create XML.
clientmethod addItem() [ Language = javascript ]
user clicked Add to add a new item. Show the text fields.
clientmethod findLanguage(languages, languageValue) [ Language = javascript ]
input language value, output language text
clientmethod loadBootstrapTable() [ Language = javascript ]
clientmethod loadDomainDropdown(domains) [ Language = javascript ]
The Domain dropdown list is populated when loading the table.
clientmethod loadLanguageDropdown() [ Language = javascript ]
clientmethod loadLocalizedStrings() [ Language = javascript ]
clientmethod loadMessageFileTable() [ Language = javascript ]
clientmethod onfinishHandler() [ Language = javascript ]
Inherited description: This is called when the template is finished;
clientmethod onloadHandler() [ Language = javascript ]
Inherited description: This client event, if present, is fired when the page is loaded.
clientmethod saveNew(closeModal) [ Language = javascript ]
user clicked Save to add a new item.
clientmethod toggleAdd() [ Language = javascript ]
enable Add button only if Domain is not null (language is never null)

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)