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

class %CSP.UI.Portal.FileMan extends %CSP.UI.Portal.FileManTemplate

Zen page for System Management Portal - FileMan wizard

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 6 37


Summary

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

Properties
%condition %import %includeFiles %page
%resource DefaultLogFile HelpAddress ISREADONLY
LocatorHeader LogsPage ParentURL StdTitle
TasksPage 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 msgConfirmCancel msgMapAll msgSelectAll
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 ClearCart ConvertParameter
CreateClasses Decrypt DoLogout DrawLocator
DrawResult DrawRibbon DrawTitle Encrypt
EscapeHTML EscapeURL GetCSPURL GetContextLinks
GetDocPage GetHomePage GetNewURL GetQuickLinks
GetText GetTreeInfo HasSelection HyperEventBody
HyperEventCall HyperEventFrame HyperEventHead Include
InsertHiddenField InsertHiddenFields IsPrivate Link
LoadProperties MapSelected OnDrawRibbon OnGetRibbonInfo
OnHTTPHeader OnPage OnPageError OnPostHTTP
OnPostHyperEvent OnPreHTTP OnPreHyperEvent Page
QuoteJS RegisterRecent RemoveCart RewriteURL
SaveSettings SaveToCart SelectAll ShowError
StartTimer StopTimer ThrowError UnescapeHTML
UnescapeURL UpdateDetails XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType ZStripW addChild
addChildAfter addChildBefore arrowClick arrowClickAll
arrowClicked arrowMoved browseSelect cancelPopup
changePassword childrenMutated correctIELayering createComponent
createComponentNS deleteComponent displayResult doAddCart
doCancel doDelete doDeleteAll doFinish
doMapAll doNext doSaveDefault doSearch
doSelAll doSelect doView dragFinishHandler
dragHandler dragNotifyHandler dragStartHandler dropHandler
dropStartHandler endModal expandNode exposeComponent
findElement fireOnLoadEvent fireOnResizeEvent fireOnUnloadEvent
fireOnUpdateEvent firePopupAction getChildIndex getComponent
getComponentById getEnclosingDiv getHidden getHintElement
getLabelElement getOpener getParameters getProperty
getSettings getTitleAreaHeight getType goHome
goMenu gotoNamespace gotoPage invokeSuper
isOfType launchPopupWindow 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 showResult startModal startProgressBar
stopProgressBar switchNamespace toggleDelete toggleMapAll
treeCount treeLoad


Parameters

• parameter AUTONS = 1;
Switch namespace for this page
• parameter CSPURL = "/csp/sys/exp/%CSP.UI.Portal.FileMan.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 = "FileMan Wizard";
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 = "%Development";
Security requirement

Properties

• property DefaultLogFile as %ZEN.Datatype.string;
• property LogsPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/exp/UtilFileManLog.csp",,1) ];
• property TasksPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/UtilBackgroundTasks.csp") ];
• property msgConfirmCancel as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Do you want to keep your file selections in the cart for future use in this session? Click [OK] to keep or [Cancel] to discard selections.") ];
• property msgMapAll as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Are you sure you want to map all files shown in the current table to classes?") ];
• property msgSelectAll as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("All files shown in table added to cart.") ];

Methods

• method %GetLocatorLinks(Output pLink) as %Status
Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
Subclasses with extra layers of locator links or other than "Configuration" please override.
• method %OnAfterCreatePage() as %Status
Set Locator bar and determine whether to show change password option.
• classmethod ClearCart() as %Boolean [ ZenMethod ]
Clear cart completely.
• classmethod CreateClasses(ByRef pParms As %String, ByRef pItems As %String) as %Status
Final call from the background job to create classes.
• 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 GetText(pid) as %String [ ZenMethod ]
• classmethod GetTreeInfo(pRoot As %String, Output pTree, ByRef pParms) as %Status
Build tree for cart. If specific numbers are selected show them in sub tree. The first piece of %session.Data("FileMan",t) is NAME of the file
• classmethod HasSelection() as %Boolean [ ZenMethod ]
• classmethod MapSelected(proxy As %ZEN.proxyObject, isFinish, filename) as %String [ ZenMethod ]
Start background job to map one of the following: 1) user has specific file selections (isFinish=1); or 2) user clicked "Map All" to map all files in a particular (search) table (isFinish=0 and filename is not null).
• method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status
Get information to display in the ribbon bar.
• classmethod RemoveCart(pid) as %String [ ZenMethod ]
Remove a selection from cart.
• classmethod SaveToCart(pid, pSelected) [ ZenMethod ]
If pSelected is null, then map all fields. pSelected is a string with fields delimited by "^" with the first piece to be the NAME of the file.
• classmethod SelectAll(filename As %String) as %String [ ZenMethod ]
Select all files based on partial filename match.
• classmethod UpdateDetails(pid) as %Boolean [ ZenMethod ]
Load fields into Available/Selected list boxes.
• method arrowClick(from, to) [ Language = javascript ]
Moving a list item from one box to the next, then remove it from the original box
• method arrowClickAll(from, to) [ Language = javascript ]
Moving the entire list from one box to the next, then remove it from the original box
• method arrowClicked(id) [ Language = javascript ]
• method arrowMoved(thisObj) [ Language = javascript ]
User double clicked one of the listboxes. Update imply message.
• method displayResult(ok) [ Language = javascript ]
After running action, display error message or refresh page.
• method doAddCart() [ Language = javascript ]
Add selected FileNumber to cart. Check to see if User unselected any to not to map. If yes, then save the selected fields.
• method doCancel() [ Language = javascript ]
User clicked Cancel. Check if user has selected any files. If yes, prompt user whether they want to keep the selection.
• method doDelete() [ Language = javascript ]
Delete one selection from tree. If no selections left then go back to previous page.
• method doDeleteAll() [ Language = javascript ]
User clicked "Clear Cart". Clear all items in the cart and return to previous page.
• method doFinish(isFinish) [ Language = javascript ]
User clicked "Finish". Map selected items in the cart - call server method to job off in the background.
• method doMapAll() [ Language = javascript ]
User clicked "Map All". Map All that are shown in the current table.
• method doNext(page) [ Language = javascript ]
User clicked "Next" or "Back". page number pass in is the target page number.
• method doSearch() [ Language = javascript ]
User clicked "Search". Get user file name (partial is okay) and refresh table.
• method doSelAll() [ Language = javascript ]
User clicked "Select All". Add all that are shown in the current table to the cart.
• method doSelect(id) [ Language = javascript ]
User clicked "Select". Show Fields for the selected File Number.
• method doView(option) [ Language = javascript ]
• method expandNode(node) [ Language = javascript ]
Show or hide tree.
• method onkeydownHandler(evt) [ Language = javascript ]
Examine if user hit the Return key. If yes, start the search. This method handles all keydown events on the window. Works for both IE and NS.
• method showResult(text) [ Language = javascript ]
Update action result. If text is passed in, show it. Otherwise set it to nothing.
• method toggleDelete(flag) [ Language = javascript ]
show or hide image and link Delete for presentation context
• method toggleMapAll(flag) [ Language = javascript ]
disable or enable buttons for MapAll and SelectAll
• method treeCount() [ Language = javascript ]
check total Abstract Syntax tree count for presentation context. this method is triggled from onupdate from the tree control.
• method treeLoad() [ Language = javascript ]
load tree