Home > Class Reference > ENSLIB namespace > %CSP.UI.Portal.NLSEdit
Private  Storage   

%CSP.UI.Portal.NLSEdit


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

Zen page for System Management Portal - NLS Local Properties

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
8 11 25


Summary


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

Properties
%condition %import %includeFiles %page
%resource CharacterSet FirstFailed HelpAddress
ISREADONLY InvalidParam IsEMSReadOnly IsEditForm
LocatorHeader OnclickArray PID ParentURL
StdTitle ValidationErrorMsg aboutPage align
aux backgroundTimerInterval cellAlign cellSize
cellStyle cellVAlign children cmbLocale
composite contactPage containerStyle cssLevel
currSortMode currStep currViewMode disabled
dragAndDrop dragEnabled dropEnabled enableAutoRefresh
enclosingClass enclosingStyle error groupClass
groupStyle height hidden hint
hintClass hintStyle home homePage
id index label labelClass
labelDisabledClass labelPosition labelStyle layout
lblTitle limitPopups msgCollationTables msgConfirmIOTable
msgIOTableInput msgIOTableName msgIOTableOutput msgIdenTables
msgPatternTables msgSaved msgXYTables 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
%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 %EvalC
%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
ArrayToString BuildMenu CheckAllBlanks CheckContextLinks
CheckEnterpriseManager ConvertParameter Decrypt DoLogout
DrawIntTables DrawLocale DrawLocator DrawProperties
DrawRibbon DrawTitle EditIOTable Encrypt
EscapeHTML EscapeURL EvalResult ExecuteInputFrom
ExecuteOutputTo GetCSPURL GetContextLinks GetDocURL
GetHomePage GetNewURL GetQuickLinks HyperEventCall
HyperEventHead Include InsertHiddenField InsertHiddenFields
IsPrivate Link OnDrawRibbon OnGetRibbonInfo
OnHTTPHeader OnPage OnPageError OnPostHTTP
OnPostHyperEvent OnPreHTTP OnPreHyperEvent Page
QuoteJS RegisterRecent RemoveIOTables RewriteURL
SaveBasics SaveFormats SaveIODefaults SaveIOTables
SaveIntTables SaveInternalDefaults SaveStrings ShowError
StartTimer StopTimer ThrowError UnescapeHTML
UnescapeURL XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType addChild addChildAfter addChildBefore
afterSave afterValidate arrowClick cancelPopup
changePassword childrenMutated correctIELayering createComponent
createComponentNS deleteComponent disableCommandButton doCancel
doModified dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler enableCommandButton
endModal exposeComponent findElement fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction getChildIndex
getComponent getComponentById getEnclosingDiv getHidden
getHintElement getLabelElement getOpener getPageTitle
getProperty getSettings getTitleAreaHeight getType
goHome goMenu gotoNamespace gotoPage
hideCommandButton invokeSuper isButtonDisabled isOfType
launchPopupWindow logout makeId navigate
newIOTable onCreate onDelete onDisplayHandler
onEndModalHandler onPopupAction onRefreshContents onSerialize
onServerMethodCall onServerMethodError onServerMethodReturn onStartModalHandler
ondisabledHandler onkeydownHandler onkeyupHandler onlayoutHandler
onloadHandler onlogoutHandler onoverlayHandler onresizeHandler
onunloadHandler onupdateHandler popupActionHandler refreshContents
removeChild removeIOTable render renderContents
renderSVG resetMsg save saveIOTable
searchBlur searchBoxHandler searchFocus searchKeyDown
searchKeyPress selectIOTables selectMenu setComponentId
setConnectivityStatusMsg setHidden setModified setOverlayMode
setPageTitle setProperty setPropertyAll setSortMode
setSortModeHandler setTraceOption setViewMode setViewModeHandler
showAbout showCommandButton showContact showDocumentation
showHelp showMsg startModal startProgressBar
stopProgressBar switchNamespace trimSpace validateRequired


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.NLSEdit.zen";
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 EMSSERVICE = "Config";
• parameter HELPADDRESS = "Home,Configuration,Locale Definitions";
Each SMP page should set this link which points to the documentation anchor name.
• parameter PAGENAME = "NLS Edit";
Displayed name of this page.
• parameter PARENTPAGE = "/csp/sys/mgr/%CSP.UI.Portal.NLS.zen";
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 RECENT = 0;
If true, register visits to this page in the recent list.
• parameter RESOURCE = "%Admin_Manage";
Security requirement

Properties


• property CharacterSet as %ZEN.Datatype.string;
• property cmbLocale as %ZEN.Datatype.string(ZENURL="cmbLocale");
• property msgCollationTables as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Please select at least one Collation table.") ];
• property msgConfirmIOTable as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Are you sure you want to remove this table from this locale?") ];
• property msgIOTableInput as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Please enter a value for Input.") ];
• property msgIOTableName as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Please enter a table name.") ];
• property msgIOTableOutput as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Please enter a value for Output.") ];
• property msgIdenTables as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Please select at least one Identifier table.") ];
• property msgPatternTables as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Please select at least one Pattern match table.") ];
• property msgSaved as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Change has been saved.") ];
• property msgXYTables as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Please select at least one $X/$Y action table.") ];

Methods


• method %GetLocatorLinks(Output pLink) as %Status
Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
• method %OnAfterCreatePage() as %Status
Set Locator bar and determine whether to show change password option.
• method %OnGetPageName() as %String
Get the (localized) name of the page.
• classmethod ArrayToString(name As %String, def As %String, ByRef LocProps As %String, delim As %String = ", ") as %String
Return additional tables from array. Used by DrawProperties. name = table name, e.g. PatternTables, CollationTables def = default, e.g. LocProps("CollationTable") LocProps = array containing all current settings
• method DrawIntTables()
Load Default Internal Tables
• method DrawLocale(pSeed As %String) as %Status
• method DrawProperties(pSeed As %String) as %Status
Draw All Properties of a Locale
• classmethod EditIOTable(table, tablename) as %ZEN.proxyObject [ ZenMethod ]
Load I/O table details
• method ExecuteInputFrom(pRS As %Library.ResultSet, Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %Boolean
Method for loading I/O Tables Input from field.
• method ExecuteOutputTo(pRS As %Library.ResultSet, Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %Boolean
Method for loading I/O Tables Output to field.
• classmethod RemoveIOTables(pProxy As %ZEN.proxyObject) as %String [ ZenMethod ]
Remove an existing IO table from locale
• classmethod SaveBasics(pProxy As %ZEN.proxyObject) as %String [ ZenMethod ]
Save values to Basics properties
• classmethod SaveFormats(pProxy As %ZEN.proxyObject) as %String [ ZenMethod ]
Save values to Date, Time, Number Formats
• classmethod SaveIODefaults(pProxy As %ZEN.proxyObject) as %String [ ZenMethod ]
Save values to Defaults for Input/Output (IODefaults)
• classmethod SaveIOTables(pProxy As %ZEN.proxyObject) as %String [ ZenMethod ]
Validate and Save values to Input/Output Tables.
• classmethod SaveIntTables(pProxy As %ZEN.proxyObject) as %String [ ZenMethod ]
• classmethod SaveInternalDefaults(pProxy As %ZEN.proxyObject) as %String [ ZenMethod ]
Save values to Defaults for Internal Tables (InternalDefaults)
• classmethod SaveStrings(pProxy As %ZEN.proxyObject) as %String [ ZenMethod ]
Save values to Defaults for Input/Output (IODefaults)
• method arrowClick(from, to) [ Language = javascript ]
------------------ Utility Methods for Moving between lstboxes ------------------ /// Moving a list item from one box to the next, then remove it from the original box ///
• method newIOTable() [ Language = javascript ]
Reset the form programmatically
• method removeIOTable() [ Language = javascript ]
User clicked the Remove button for IO table
• method save(menu) [ Language = javascript ]
User clicked a Save button
• method saveIOTable() [ Language = javascript ]
User clicked the Save button for IO table
• method selectIOTables(comp) [ Language = javascript ]
User selected a Input/Output table. Fill in edit fields.
• method selectMenu(menu) [ Language = javascript ]
User clicked a menu. menu=0 means to return to Local Properties.