Class Reference
%CSP.UI.Portal.NLS
Server:basexml
Instance:SOAXML
User:UnknownUser
 
-
  [BASEXML] >  [%CSP] >  [UI] >  [Portal] >  [NLS]
Private  Storage

class %CSP.UI.Portal.NLS extends %CSP.UI.Portal.Template

Zen page for System Management Portal - NLS Locale Definition

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 7 38


Summary

This is a Zen Page class. It belongs to the application %CSP.UI.Portal.Application.

Properties
%condition %import %includeFiles %page
%resource EditURL HelpAddress ISREADONLY
LocatorHeader ParentURL StdTitle aboutPage
align aux backgroundTimerInterval cellAlign
cellSize cellStyle cellVAlign children
composite containerStyle cssLevel currSortMode
currStep currViewMode disabled dragAndDrop
dragEnabled dropEnabled enclosingClass enclosingStyle
error groupClass groupStyle height
hidden hint hintClass hintStyle
home homePage id index
label labelClass labelDisabledClass labelPosition
labelStyle layout lblTitle msgConfirmDelete
msgConfirmInstall msgExportFileName msgSelectLocale msgSelectTable
msgSelectTableName name onafterdrag onbeforedrag
onclick ondrag ondrop onhide
onrefresh onshow onupdate pageModified
parent searchKey showLabel slice
title tuple useSVG useSoftModals
valign visible width window
zenPersistentPopup

Methods
%%OIDGet %AddChild %AddChildAfter %AddChildBefore
%AddComponent %AddImportedComponents %AddLocatorLinks %AddToSaveSet
%ApplyURLParms %Attr %BindExport %ClassIsLatestVersion
%ClassName %ConstructClone %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawAutoLogout %DrawClassDefinitions %DrawComponentHTML
%DrawHTML %DrawHTMLPage %DrawJSStrings %DrawObjectDefinitions
%EnclosingDivId %EndBackgroundMethod %EndScript %Eval
%Extends %ForceClientRender %GetChildIndex %GetComponent
%GetComponentById %GetComponentByName %GetEventHandlers %GetHomePage
%GetHomeParam %GetLinks %GetLocatorLinks %GetPageName
%GetParameter %GetProductName %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 %OnGetPageName
%OnGetProductName %OnGetSmallMenu %OnGetTitle %OnMonitorBackgroundTask
%OnMutateChildren %OnObjectSynch %OnPreHTTP %OnSubmit
%OnUseSoftModals %OnZENDeserialize %OriginalNamespace %PackageName
%QuoteValue %QuoteValueL10N %Register %RemoveChild
%RemoveChildren %RemoveComponent %RemoveFromSaveSet %RunBackgroundMethod
%Self %SerializeObject %SetBackgroundMethodStatus %SetErrorById
%SetErrorByName %SetModified %SetValueById %SetValueByName
%SetValuesByName %StartScript %ValidateObject %ZENVersion
BuildMenu CheckAllBlanks ConvertParameter CopyDescription
CopyNow Decrypt DeleteNow DoLogout
DrawLocator DrawResult DrawRibbon DrawTableNames
DrawTitle Encrypt EscapeHTML EscapeURL
ExecuteRS ExportDescription ExportNow GetCSPURL
GetContextLinks GetDocPage GetHomePage GetLocaleDesc
GetLocaleDescription GetNewURL GetQuickLinks HyperEventBody
HyperEventCall HyperEventFrame HyperEventHead Include
InsertHiddenField InsertHiddenFields InstallNow IsPrivate
Link LoadTableNow OnDrawRibbon OnGetRibbonInfo
OnHTTPHeader OnPage OnPageError OnPostHTTP
OnPostHyperEvent OnPreHTTP OnPreHyperEvent Page
QuoteJS RegisterRecent ReloadDefault RewriteURL
ShowError StartTimer StopTimer ThrowError
UnescapeHTML UnescapeURL ValidateInstall XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType ZStripW
addChild addChildAfter addChildBefore browseSelect
cancelPopup changePassword changedDefault changedLocale
childrenMutated copyLocale correctIELayering createComponent
createComponentNS deleteComponent deleteLocale displayResult
doCancel doCopy doExport doInstall
doLoadTable dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler edit
endModal exportLocale exposeComponent findElement
fireOnLoadEvent fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent
firePopupAction getChildIndex getComponent getComponentById
getEnclosingDiv getHidden getHintElement getLabelElement
getLocale getOpener getProperty getSettings
getTitleAreaHeight getType goHome goMenu
gotoNamespace gotoPage hideFlds installLocale
invokeSuper isOfType launchPopupWindow loadTable
logout makeId navigate onCreate
onDelete onDisplayHandler onEndModalHandler onPopupAction
onRefreshContents onSerialize onServerMethodCall onServerMethodError
onServerMethodReturn onStartModalHandler ondisabledHandler onkeydownHandler
onkeyupHandler onlayoutHandler onloadHandler onlogoutHandler
onoverlayHandler onresizeHandler onunloadHandler onupdateHandler
popupActionHandler refreshContents removeChild render
renderContents renderSVG resetMsg searchBlur
searchBoxHandler searchFocus searchKeyDown searchKeyPress
setComponentId setHidden setModified setOverlayMode
setProperty setPropertyAll setSortMode setSortModeHandler
setTraceOption setViewMode setViewModeHandler showAbout
showDocumentation showHelp showMsg startModal
startProgressBar stopProgressBar switchNamespace tablenameChanged
tabletypeChanged validateLocale


Parameters

• parameter AUTONS = 0;
Do not switch namespace for this page: it needs to stay in %SYS
• parameter CSPURL = "/csp/sys/mgr/%CSP.UI.Portal.NLS.cls";
This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.
• parameter PAGENAME = "Locale Definitions";
Displayed name of this page.
• parameter PARENTPAGE = "%CSP.Portal.Home.cls";
This parameter defines the parent page for this page.
If the name ends in .csp, then the parent is assumed to be an autopage-enabled CSP page.
If the name ends in .cls, then the parent is assumed to be a Zen page.
This is used to automate the construction of the locator bar for this page and to build the index between portal pages and documentation.
The %GetLocatorInfo method is used to get this information.
• parameter RESOURCE = "%Admin_Manage";
Security requirement

Properties

• property EditURL as %ZEN.Datatype.string;
• property msgConfirmDelete as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Are you sure you want to delete this locale?") ];
• property msgConfirmInstall as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Are you sure you want to make this locale your current locale?") ];
• property msgExportFileName as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Please enter a valid file name.") ];
• property msgSelectLocale as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Please select the locale you want to edit.") ];
• property msgSelectTable as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Please select a table type.") ];
• property msgSelectTableName as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Please select a table name.") ];

Methods

• method %OnAfterCreatePage() as %Status
Set Locator bar and determine whether to show change password option.
• classmethod %OnSubmit(pSubmit As %ZEN.Submit) as %Status
This callback is called when a form on this page is submitted. pSubmit is a %ZEN.Submit object containing details of the form submit.
Subclasses override this method.
• classmethod CopyDescription(locale As %String) as %String [ ZenMethod ]
Return default copy description
• classmethod CopyNow(sLoc, sNew, Description) as %String [ ZenMethod ]
Copy selected locale
• classmethod DeleteNow(locale) as %String [ ZenMethod ]
Delete selected locale.
• method DrawResult(seed As %String) as %Status
Actually write out result. When the page is first opened, seed is null. When it's called from Prepare, seed = action^the selected locale.
• classmethod DrawTableNames(locale, table As %String) as %String [ ZenMethod ]
Load Table Names drop-down list based on user selected table type. Build temp array Properties which contains the table names for this table type.
• method ExecuteRS(pRS As %Library.ResultSet, Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %Boolean
This method is called when the query is run for the locale list.
• classmethod ExportDescription(locale As %String) as %String [ ZenMethod ]
Return default export file
• classmethod ExportNow(locale, FileName) as %String [ ZenMethod ]
Export selected locale.
• classmethod GetLocaleDesc(pSeed As %String) as %String [ ZenMethod ]
Return an updated title description
• classmethod GetLocaleDescription(locale) as %String
Given any locale, return locale Description
• classmethod InstallNow(locale) as %String [ ZenMethod ]
Install selected locale. Validation is already done before coming here.
• classmethod LoadTableNow(locale, tabletype, tablename) as %String [ ZenMethod ]
Load locale table.
• classmethod ReloadDefault(locale As %String, defaultFormat As %Integer) [ ZenMethod ]
Save "Use locale date/time/number formats for current locale" and then reload.
• classmethod ValidateInstall(locale As %String) as %String [ ZenMethod ]
Validate if the locale is installable Return 1 if ok; 0 if there are errors; 2 if there are warnings Error message or warnings will be set to message fields.
• method browseSelect(name, wildcard) [ Language = javascript ]
User clicked one of the Browse buttons. Save the name of the textfield so that when you return you know which textfield to update.
• method changedDefault(thisObj) [ Language = javascript ]
User changed default. Call server method to reload.
• method changedLocale() [ Language = javascript ]
User changed a locale. If it's null, then disable buttons
• method copyLocale() [ Language = javascript ]
User clicked "Copy" button. Show Copy fields.
• method deleteLocale() [ Language = javascript ]
User clicked "Delete" button.
• method displayResult(ok) [ Language = javascript ]
After running action, display error message or refresh page.
• method doCancel() [ Language = javascript ]
User clicked Cancel. Hide sub form.
• method doCopy() [ Language = javascript ]
User clicked OK for Copy. Set seed, show and redraw the content.
• method doExport() [ Language = javascript ]
User clicked OK for Export. Process Export.
• method doInstall() [ Language = javascript ]
User clicked Install Now for Installing a new locale. Process Install.
• method doLoadTable() [ Language = javascript ]
User clicked OK for Load Table. Process Load Table.
• method edit() [ Language = javascript ]
• method exportLocale() [ Language = javascript ]
User clicked "Export" button. Show Export fields.
• method getLocale() as %String [ Language = javascript ]
• method hideFlds() [ Language = javascript ]
hide all fields
• method installLocale() [ Language = javascript ]
User clicked "Install" button. Show Install fields.
• method loadTable() [ Language = javascript ]
User clicked "Load Table" button. Show Load Table fields.
• 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 onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method tablenameChanged() [ Language = javascript ]
User changed a character set table name.
• method tabletypeChanged() [ Language = javascript ]
User changed a table type. Load table names based on the table type selected.
• method validateLocale() [ Language = javascript ]
User clicked Validate. Set seed, show and redraw the content.