eXept Software AG Logo

Smalltalk/X Webserver

Documentation of class 'FileSelectionBox':

Home

Documentation
www.exept.de
Everywhere
for:
[back]

Class: FileSelectionBox


Inheritance:

   Object
   |
   +--GraphicsMedium
      |
      +--DisplaySurface
         |
         +--SimpleView
            |
            +--View
               |
               +--TopView
                  |
                  +--StandardSystemView
                     |
                     +--ModalBox
                        |
                        +--DialogBox
                           |
                           +--EnterBox
                              |
                              +--ListSelectionBox
                                 |
                                 +--FileSelectionBox
                                    |
                                    +--FileSaveBox

Package:
stx:libwidg
Category:
Views-DialogBoxes
Version:
rev: 1.77 date: 2019/03/01 14:44:29
user: cg
file: FileSelectionBox.st directory: libwidg
module: stx stc-classLibrary: libwidg
Author:
Claus Gittinger

Description:


this class implements file selection boxes. Instances show a list of
files, and perform an action block with the selected pathname as
argument when ok is clicked. It is also possible, to open the box
without action and ask it afterward if it has been left with ok
(i.e. the ST-80 way, asking 'aBox accepted ifTrue:[...]')

There is an optional PatternField, which shows itself when a pattern
is defined (i.e. if there is no pattern, it is hidden). 
If there is a pattern, only files matching the pattern are shown in 
the list. Directories are not affected by the patternField.

In addition, there is an optional matchBlock (actually this is defined 
in the FileSelectionList). Only names for which this matchblock
returns true will be presented. The matchBlock affects both regular files
and names of directories. The argument passed to the matchBlock is the full
pathname.

All of the actual work is done in the fileList; see the documentation
of FileSelectionList for more options 
(you can access a boxes fileList via 'aBox>>listView' and get access to all
 of those fancy settings)
For example, by accessing the list, it is possible to hide all directories 
('aBox listView ignoreDirectories:true'), to hide the parentDirectory alone 
('aBox listView ignoreParentDirectory') and to turn off the marking 
of subdirectories ('aBox listView markSubdirectories:false').


Related information:

    DialogBox
    EnterBox2
    FilenameEnterBox
    YesNoBox
    ListSelectionBox
    FileSaveBox
    FileSelectionList
    SelectionInListView

Class protocol:

accessing
o  lastFileSelectionDirectory
return the name of the directory used in the previous
fileSelection dialog. This will be used as default for the next dialog,
if no explicit path is specified (see requestFileName:* methods)

o  lastFileSelectionDirectory: aDirectoryString
set the name of the directory used in the previous
fileSelection dialog. This will be used as default for the next dialog,
if no explicit path is specified (see requestFileName:* methods)

defaults
o  listViewType
return the type of listView - using a FileSelectionList here

menu specs
o  fileListMenu
This resource specification was automatically generated
by the MenuEditor of ST/X.

usage example(s):

     MenuEditor new openOnClass:FileSelectionBox andSelector:#fileListMenu
     (Menu new fromLiteralArrayEncoding:(FileSelectionBox fileListMenu)) startUp


Instance protocol:

accessing
o  allowMakeDirectory: aBoolean
allow or deny creation of new directories;
The default is to allow it.

o  contents
return the current entered value (i.e. the enterFields string).
redefined to return the full pathname.

o  directory
return the directory which is currently shown

o  directory: directoryName
change the directory shown in the list.

o  fileName
if some filename has been entered, return it (without the directory path)
otherwise, return nil

o  matchBlock: aBlock
set the matchBlock (in the selectionList). Only files
for which the block returns true are shown.
The matching is actually done in the fileSelectionList.

o  openOn: aPath
open the box showing files in aPath.
This is only a shortcut message - no new functionality.

o  pathName
same as contents - return the full pathname of the selected file,
or the pathname of the directory if nothing has been entered

o  pattern: aPattern
set the pattern - this also enables the PatternField
(if the pattern is non-nil) or hides it (if nil).

o  selectingDirectory: aBoolean
setup the box for directory selection (hides regular files).
Use this, to ask the user for a directories name

change & update
o  update: something with: argument from: changedObject
sent by fileNameEnterField, if a filename
completion was not possible due to multiple
matches.

initialization
o  createEnterField
if the (optional) class FilenameEditField is present, use
it, since it provides filename completion. Otherwise, we have
to live with the dumb (default) field ...

o  initialize
IncludingBorder

o  postRealize
if some default is present in the enterField,
scroll to make this one visible

menu
o  fileListMenu

o  fileListMenuNewFolder
self open

o  fileListMenuRemove

private
o  updateList

o  updateListWithoutScrolling

queries
o  computePreferredExtent
return my preferred extent
- that's the minimum size to make everything visible

user actions
o  directoryChanged

o  directorySelected
a directory was selected - show the new path in the inputField,
if we are in directory mode

o  doubleClick
(comment from inherited method)
doubleClick on an entry is select & ok

o  enterFieldChanged

o  okPressed
called for both on ok-press and on return-key

o  patternChanged

o  selectionChanged
(comment from inherited method)
selections in list get forwarded to enterfield


Examples:


simple standard queries (notice, that the receiver of those messages is Dialog - this should always be done for compatibility - although the real fileBox implementation is here). very simple:
      |name|

      name := Dialog requestFileName.
      Transcript showCR:name
simple:
      |name|

      name := FileSelectionBox requestFileName:'which file ?'.
      Transcript showCR:name
with initial selection:
      |name|

      name := FileSelectionBox requestFileName:'which file ?' default:'Make.proto'.
      Transcript showCR:name
more detailed setup setting title:
      |box|
      box := FileSelectionBox new.
      box title:'Which file ?'.
      box open.
      box accepted ifTrue:[
          Transcript showCR:'you selected: ' , box pathName
      ]
setting a matchpattern:
      |box|
      box := FileSelectionBox new.
      box title:'Which file ?'.
      box pattern:'*.rc'.
      box open
setting multiple patterns:
      |box|
      box := FileSelectionBox new.
      box title:'Which file ?'.
      box pattern:'*.rc;*.st'.
      box open
setting a matchblock:
      |box|
      box := FileSelectionBox new.
      box title:'Which file ?'.
      box directory:'/etc'.
      box pattern:'*'.
      box matchBlock:[:name | name asFilename baseName first between:$a and:$z].
      box open
both pattern and matchBlock:
      |box|
      box := FileSelectionBox new.
      box title:'Which directory ?'.
      box selectingDirectory:true.
      box pattern:'l*'.
      box matchBlock:[:name | OperatingSystem isDirectory:name].
      box action:[:fn | Transcript showCR:fn].
      box open
don't show the parent directory:
      |box|
      box := FileSelectionBox new.
      box title:'Which directory ?'.
      box listView ignoreParentDirectory:true.
      box open
don't show any directory:
      |box|
      box := FileSelectionBox new.
      box title:'Which file ?'.
      box listView ignoreDirectories:true.
      box open
don't show any directory or hidden file: (notice the basename extraction - we are not interested in the full pathName)
      |box|
      box := FileSelectionBox new.
      box title:'Which file ?'.
      box listView ignoreDirectories:true.
      box matchBlock:[:name | (name asFilename baseName startsWith:'.') not].
      box open
don't allow direct filename entry: (i.e. avoid the user choosing files from other directories)
      |box|
      box := FileSelectionBox new.
      box title:'Which one ?'.
      box enterField beInvisible.
      box open.
      box accepted ifTrue:[
          Transcript showCR:'path is ' , box pathName
      ].
combined with above directory ignoring, this limits selection of files from a single directory:
      |box|
      box := FileSelectionBox new.
      box title:'Which file ?'.
      box enterField beInvisible.
      box listView ignoreDirectories:true.
      box open.
      box accepted ifTrue:[
          Transcript showCR:'path is ' , box pathName
      ].
finally, an action:
      |box|
      box := FileSelectionBox new.
      box title:'Which directory ?'.
      box pattern:'l*'.
      box matchBlock:[:name | OperatingSystem isDirectory:name].
      box action:[:name | Transcript showCR:name].
      box open
concrete examples: only show files beginning with lowercase characters and ending in '.c':
      |box|
      box := FileSelectionBox new.
      box title:'Which directory ?'.
      box matchBlock:[:name |
                          box pathName asFilename isDirectory
                          or:[name first isLowercase
                              and:[name endsWith:'.c']]
                     ].
      box open.
      box accepted ifTrue:[
          Transcript showCR:'full path:  ' , box pathName.
          Transcript showCR:'files name: ' , box fileName.
          Transcript showCR:'directory : ' , box directory pathName.
      ]


ST/X 7.2.0.0; WebServer 1.670 at bd0aa1f87cdd.unknown:8081; Thu, 09 Dec 2021 13:31:25 GMT