Class Reference
IRIS for UNIX 2019.4
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%DeepSee] >  [UI] >  [FolderManager]
Private  Storage   

class %DeepSee.UI.FolderManager extends %DeepSee.UI.standardPage

DeepSee Folder Manager page.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 5 48


Summary

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

Properties
%condition %import %includeFiles %page
%resource StdTitle aboutPage align
aux backgroundTimerInterval cellAlign cellSize
cellStyle cellVAlign children composite
contactPage containerStyle cssLevel currSortMode
currStep currViewMode directory disabled
docbookId dragAndDrop dragEnabled dropEnabled
enableAutoRefresh enclosingClass enclosingStyle error
folderName groupClass groupStyle height
hidden hint hintClass hintStyle
homePage id index label
labelClass labelDisabledClass labelPosition labelStyle
layout limitPopups name onafterdrag
onbeforedrag onclick ondrag ondrop
onhide onrefresh onshow onupdate
pageModified parent searchKey selectedFiles
selectedItems showLabel slice title
tuple useSVG useSoftModals valign
visible width window zenPersistentPopup

Methods
%AddChild %AddChildAfter %AddChildBefore %AddComponent
%AddImportedComponents %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 %GetLinks %GetLocatorLinks
%GetPageName %GetParameter %GetRootLink %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 CheckContextLinks CheckEnterpriseManager
ConvertParameter Decrypt DeleteItems DoLogout
DownloadStream DrawExportDirectory DrawFolders DrawHelp
DrawLocator DrawRibbon DrawTitle Encrypt
EscapeHTML EscapeURL ExportItems GetCSPURL
GetContextLinks GetDocURL GetItemDetails GetNewURL
GetQuickLinks GetTempFileName HyperEventCall HyperEventHead
ImportItems Include InsertHiddenField InsertHiddenFields
IsPrivate IsValidClassName Link OnDrawRibbon
OnGetRibbonInfo OnHTTPHeader OnPage OnPageError
OnPostHTTP OnPostHyperEvent OnPreHTTP OnPreHyperEvent
Page QuoteJS RewriteURL SaveFileImportToDisk
SaveFolderDetails SendItemToTrash ShowError StartTimer
StopTimer ThrowError UnescapeHTML UnescapeURL
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore adjustSizes
allClick browseSelect cancelPopup cbClick
changePassword checkUploadInformation childrenMutated correctIELayering
createComponent createComponentNS deleteComponent deleteFolder
deleteItem deleteSelected disableCommandButton doLocationChange
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
dropHandler dropStartHandler enableCommandButton endModal
exportThem exposeComponent findElement fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction getChildIndex
getComponent getComponentById getEnclosingDiv getHidden
getHintElement getLabelElement getOpener getPageTitle
getProperty getSelectedFiles getSelectedItems getSettings
getTitleAreaHeight getType goHome goMenu
gotoNamespace gotoPage hideCommandButton importThem
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 refreshFolders reloadPage removeChild
render renderContents renderSVG rowClick
saveFolder searchBlur searchBoxHandler searchFocus
searchKeyDown searchKeyPress selectAllFiles selectFile
setComponentId setConnectivityStatusMsg setExportDirectory setHidden
setModified setOverlayMode setPageTitle setProperty
setPropertyAll setSortMode setSortModeHandler setTraceOption
setViewMode setViewModeHandler shortcutToFileUpload showAbout
showCommandButton showContact showHelp startModal
startProgressBar stopProgressBar switchNamespace toggleContainer
toggleFolder updateDetails


Parameters

• parameter DOCBOOKID = "D2GS_uis_folder_manager";
Docbook ID for this page.
• parameter PAGENAME = "Folder Manager";
Name of this page.
• parameter RESOURCE = "%DeepSee_Admin";
All Analytics pages require %DeepSee_Portal USE.

Properties

• property directory as %ZEN.Datatype.string;
Export directory.
• property folderName as %ZEN.Datatype.string;
Current folder name.
• property selectedFiles as list of %ZEN.Datatype.string;
List of selected files.
• property selectedItems as list of %ZEN.Datatype.string;
List of selected items.

Methods

• method %OnAfterCreatePage() as %Status
Decorate the page.
• method %OnGetPageName() as %String
Get the (localized) name of the page.
• method %OnGetProductName() as %String
Get the product name for the page.
• method %OnGetTitle() as %String
Get the (localized) title string for the page. This should be implemented in a subclass.
• classmethod %OnPreHTTP() as %Boolean
Test for additional resources.
• 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.
• method DeleteItems() as %String [ ZenMethod ]
Delete the current selected list.
• classmethod DownloadStream(pFilename As %String, pDocName As %String, pCharSet As %String = "") [ ZenMethod ]
Stream a temporary file located on the server at pFileName and serve it to the current client %CSP.StreamServer.
• method DrawExportDirectory(pSeed As %String) as %Status
Draw contents of export directory.
• method DrawFolders(pSeed As %String) as %Status
Draw content of folders list.
• method DrawHelp(pSeed As %String) as %Status
Draw content of the help box.
• method ExportItems(pUseContainerClass As %Boolean, pContainerClassName As %String = "") as %String [ ZenMethod ]
Export the current selected list.
• classmethod GetItemDetails(pName As %String) as %ZEN.proxyObject [ ZenMethod ]
Get details on selected item.
• method GetTempFileName(pDocName) as %String [ ZenMethod ]
Create a temporary file name with the same extension as the current pDocName.
• method ImportItems() as %String [ ZenMethod ]
Import the current selected file list.
• classmethod IsValidClassName(pClassName As %String) as %Boolean [ ZenMethod ]
Test if the given class name is valid.
• 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 SaveFileImportToDisk(pSubmit As %ZEN.Submit) as %Status
Link to the stream of the file upload control and treanfer the stream contents to the server
• classmethod SaveFolderDetails(pName As %String, pResource As %String) as %String [ ZenMethod ]
Save folder information.
• method SendItemToTrash(pName As %String) as %String [ ZenMethod ]
Delete the given folder item.
• method adjustSizes() [ Language = javascript ]
Adjust sizes of components on the page.
• method allClick() [ Language = javascript ]
Click on all check box.
• method browseSelect() [ Language = javascript ]
User clicked the Browse button.
• method cbClick(cb) [ Language = javascript ]
Click on checkbox.
• method checkUploadInformation() [ Language = javascript ]
Check the error status of the fileUploadForm and the fileUploadCtrl. If present, alert the user to this information
• method deleteFolder(name) [ Language = javascript ]
Delete the given folder.
• method deleteItem(name) [ Language = javascript ]
Delete the given item.
• method deleteSelected() [ Language = javascript ]
Delete selected items.
• method doLocationChange(flag) [ Language = javascript ]
User changed to export file between Server or Browser
• method exportThem() [ Language = javascript ]
Export selected items.
• method getSelectedFiles() [ Language = javascript ]
Return an array of selected files in export directory.
• method getSelectedItems() [ Language = javascript ]
Return an array of selected folder items.
• method importThem() [ Language = javascript ]
Import selected items.
• method onPopupAction(popupName, action, value) [ Language = javascript ]
Subclass need to include the case "switchNamespace" if it is enabling "Switch" next to namespace.
• method onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method refreshFolders() [ Language = javascript ]
Reload the folder list.
• method rowClick(row) [ Language = javascript ]
Click on row.
• method saveFolder(name) [ Language = javascript ]
Save folder details.
• method searchBoxHandler(searchKey) [ Language = javascript ]
Change in search box value. Overridden by subclasses.
• method selectAllFiles() [ Language = javascript ]
Select all files in export directory.
• method selectFile(n, iscb) [ Language = javascript ]
Select a file in the export directory.
• method setExportDirectory(dir) [ Language = javascript ]
Set the export directory.
• method shortcutToFileUpload() [ Language = javascript ]
Provides a compact means of switching to the file upload form
• method toggleContainer(value) [ Language = javascript ]
Adjust the presentation to the user when the Container Class checkbox is checked.
• method toggleFolder(index) [ Language = javascript ]
Hide/show folders in list.
• method updateDetails() [ Language = javascript ]
Update the item details box.


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.