IRISLIB database
FileMan Class Reference

Zen page for System Management Portal - FileMan wizard. More...

Inheritance diagram for FileMan:
Collaboration diagram for FileMan:

Public Member Functions

_.Library.Status DrawResult (_.Library.String seed)
 Actually write out result. More...
 
_.Library.Status OnGetRibbonInfo (_.Library.Boolean pDisplay, _.Library.List pViewIcons, _.Library.List pSortOptions, _.Library.Boolean pSearchBox, _.Library.String pRibbonTitle, _.Library.List pCommands)
 Get information to display in the ribbon bar.
 
 arrowClick (from, to)
 Moving a list item from one box to the next, then remove it from the original box.
 
 arrowClickAll (from, to)
 Moving the entire list from one box to the next, then remove it from the original box.
 
 arrowMoved (thisObj)
 User double clicked one of the listboxes. More...
 
 displayResult (ok)
 After running action, display error message or refresh page.
 
 doAddCart ()
 Add selected FileNumber to cart. More...
 
 doCancel ()
 User clicked Cancel. More...
 
 doDelete ()
 Delete one selection from tree. More...
 
 doDeleteAll ()
 User clicked "Clear Cart". More...
 
 doFinish (isFinish)
 User clicked "Finish". More...
 
 doMapAll ()
 User clicked "Map All". More...
 
 doNext (page)
 User clicked "Next" or "Back". More...
 
 doSearch ()
 User clicked "Search". More...
 
 doSelAll ()
 User clicked "Select All". More...
 
 doSelect (id)
 User clicked "Select". More...
 
 expandNode (node)
 Show or hide tree.
 
 onkeydownHandler (evt)
 Examine if user hit the Return key. More...
 
 showResult (text)
 Update action result. More...
 
 toggleDelete (flag)
 show or hide image and link Delete for presentation context
 
 toggleMapAll (flag)
 disable or enable buttons for MapAll and SelectAll
 
 treeCount ()
 check total Abstract Syntax tree count for presentation context. More...
 
 treeLoad ()
 load tree
 
- Public Member Functions inherited from UtilsNav
 navMaxRowsChanged (value)
 Maybe overriden by subclass.
 
 navPageSizeChanged (value)
 Maybe overriden by subclass.
 

Static Public Member Functions

_.Library.Boolean ClearCart ()
 Clear cart completely.
 
_.Library.Status CreateClasses (_.Library.String pParms, _.Library.String pItems)
 Final call from the background job to create classes.
 
_.Library.Status GetTreeInfo (_.Library.String pRoot, pTree, pParms)
 Build tree for cart. More...
 
_.Library.String MapSelected (_.ZEN.proxyObject proxy, isFinish, filename)
 Start background job to map one of the following: More...
 
_.Library.String RemoveCart (pid)
 Remove a selection from cart.
 
 SaveToCart (pid, pSelected)
 If pSelected is null, then map all fields. More...
 
_.Library.String SelectAll (_.Library.String filename)
 Select all files based on partial filename match.
 
_.Library.Boolean UpdateDetails (pid)
 Load fields into Available/Selected list boxes.
 
- Static Public Member Functions inherited from UtilsNav
 UpdateTableNavState (_.Library.String pFilter, _.Library.Integer pPageSize, _.Library.Integer pMaxRows)
 Used to Save TableNavigatorBar Values.
 

Public Attributes

 DefaultLogFile
   More...
 
 LogsPage
   More...
 
 TasksPage
   More...
 
 msgConfirmCancel
   More...
 
 msgMapAll
   More...
 
 msgSelectAll
   More...
 
- Public Attributes inherited from UtilsNav
 Filter
 Filter value user entered into the "Filter" field in the table navigator. More...
 
 TableMaxRows
 Max rows value user entered into the "Max rows" field in the table navigator. More...
 
 TablePageSize
 Page size value user entered into the "Page size" field in the table navigator. More...
 

Static Public Attributes

 AUTONS = None
 Switch namespace for this page.
 
 PAGENAME = None
 Displayed name of this page.
 
 PARENTPAGE = None
 Cancel return to this parent page.
 
 RESOURCE = None
 Security requirement.
 

Private Member Functions

_.Library.Status OnAfterCreatePage ()
 Set Locator bar and determine whether to show change password option.
 

Detailed Description

Zen page for System Management Portal - FileMan wizard.

Note: The FileMan toolset is available and fully supported in InterSystems IRIS for existing FileMan users. InterSystems recommends against starting new development projects using FileMan.

Member Function Documentation

◆ DrawResult()

_.Library.Status DrawResult ( _.Library.String  seed)

Actually write out result.

When the page is first opened, seed is null. When it's called from Prepare, seed = action^the selected locale.

◆ GetTreeInfo()

_.Library.Status GetTreeInfo ( _.Library.String  pRoot,
  pTree,
  pParms 
)
static

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

◆ MapSelected()

_.Library.String MapSelected ( _.ZEN.proxyObject  proxy,
  isFinish,
  filename 
)
static

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).

◆ SaveToCart()

SaveToCart (   pid,
  pSelected 
)
static

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.

◆ arrowMoved()

arrowMoved (   thisObj)

User double clicked one of the listboxes.

Update imply message.

◆ doAddCart()

doAddCart ( )

Add selected FileNumber to cart.

Check to see if User unselected any to not to map. If yes, then save the selected fields.

◆ doCancel()

doCancel ( )

User clicked Cancel.

Check if user has selected any files. If yes, prompt user

whether they want to keep the selection.

◆ doDelete()

doDelete ( )

Delete one selection from tree.

If no selections left then go back to previous page.

◆ doDeleteAll()

doDeleteAll ( )

User clicked "Clear Cart".

Clear all items in the cart and return to previous page.

◆ doFinish()

doFinish (   isFinish)

User clicked "Finish".

Map selected items in the cart - call server method to job off in the background.

◆ doMapAll()

doMapAll ( )

User clicked "Map All".

Map All that are shown in the current table.

◆ doNext()

doNext (   page)

User clicked "Next" or "Back".

page number pass in is the target page number.

◆ doSearch()

doSearch ( )

User clicked "Search".

Get user file name (partial is okay) and refresh table.

◆ doSelAll()

doSelAll ( )

User clicked "Select All".

Add all that are shown in the current table to the cart.

◆ doSelect()

doSelect (   id)

User clicked "Select".

Show Fields for the selected File Number.

◆ onkeydownHandler()

onkeydownHandler (   evt)

Examine if user hit the Return key.

If yes, start the search.

This method handles all keydown events on the window.

◆ showResult()

showResult (   text)

Update action result.

If text is passed in, show it. Otherwise set it to nothing.

◆ treeCount()

treeCount ( )

check total Abstract Syntax tree count for presentation context.

this method is triggled from onupdate from the tree control.

Member Data Documentation

◆ DefaultLogFile

DefaultLogFile

 

 

◆ LogsPage

LogsPage

 

 

◆ TasksPage

TasksPage

 

 

◆ msgConfirmCancel

msgConfirmCancel

 

 

◆ msgMapAll

msgMapAll

 

 

◆ msgSelectAll

msgSelectAll