"{ Encoding: utf8 }"

"

 COPYRIGHT (c) 1990 by Claus Gittinger

	      All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

"{ Package: 'stx:libwidg' }"

"{ NameSpace: Smalltalk }"

ListSelectionBox subclass:#FileSelectionBox

	instanceVariableNames:'patternField selectingDirectory allowMakeDirectory'

	classVariableNames:'LastFileSelectionDirectory'

	poolDictionaries:''

	category:'Views-DialogBoxes'

!

!FileSelectionBox class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1990 by Claus Gittinger

	      All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

!

documentation

"

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

    [author:]

        Claus Gittinger

    [see also:]

        DialogBox

        EnterBox2 FilenameEnterBox YesNoBox

        ListSelectionBox FileSaveBox

        FileSelectionList SelectionInListView

"

!

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:

                                                                        [exBegin]

        |name|

        name := Dialog requestFileName.

        Transcript showCR:name

                                                                        [exEnd]

    simple:

                                                                        [exBegin]

        |name|

        name := FileSelectionBox requestFileName:'which file ?'.

        Transcript showCR:name

                                                                        [exEnd]

    with initial selection:

                                                                        [exBegin]

        |name|

        name := FileSelectionBox requestFileName:'which file ?' default:'Make.proto'.

        Transcript showCR:name

                                                                        [exEnd]

  more detailed setup

    setting title:

                                                                        [exBegin]

        |box|

        box := FileSelectionBox new.

        box title:'Which file ?'.

        box open.

        box accepted ifTrue:[

            Transcript showCR:'you selected: ' , box pathName

        ]

                                                                        [exEnd]

    setting a matchpattern:

                                                                        [exBegin]

        |box|

        box := FileSelectionBox new.

        box title:'Which file ?'.

        box pattern:'*.rc'.

        box open

                                                                        [exEnd]

    setting multiple patterns:

                                                                        [exBegin]

        |box|

        box := FileSelectionBox new.

        box title:'Which file ?'.

        box pattern:'*.rc;*.st'.

        box open

                                                                        [exEnd]

    setting a matchblock:

                                                                        [exBegin]

        |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

                                                                        [exEnd]

    both pattern and matchBlock:

                                                                        [exBegin]

        |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

                                                                        [exEnd]

    don't show the parent directory:

                                                                        [exBegin]

        |box|

        box := FileSelectionBox new.

        box title:'Which directory ?'.

        box listView ignoreParentDirectory:true.

        box open

                                                                        [exEnd]

    don't show any directory:

                                                                        [exBegin]

        |box|

        box := FileSelectionBox new.

        box title:'Which file ?'.

        box listView ignoreDirectories:true.

        box open

                                                                        [exEnd]

    don't show any directory or hidden file:

    (notice the basename extraction - we are not interested in the full pathName)

                                                                        [exBegin]

        |box|

        box := FileSelectionBox new.

        box title:'Which file ?'.

        box listView ignoreDirectories:true.

        box matchBlock:[:name | (name asFilename baseName startsWith:'.') not].

        box open

                                                                        [exEnd]

    don't allow direct filename entry:

    (i.e. avoid the user choosing files from other directories)

                                                                        [exBegin]

        |box|

        box := FileSelectionBox new.

        box title:'Which one ?'.

        box enterField beInvisible.

        box open.

        box accepted ifTrue:[

            Transcript showCR:'path is ' , box pathName

        ].

                                                                        [exEnd]

    combined with above directory ignoring,

    this limits selection of files from a single directory:

                                                                        [exBegin]

        |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

        ].

                                                                        [exEnd]

    finally, an action:

                                                                        [exBegin]

        |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

                                                                        [exEnd]

  concrete examples:

    only show files beginning with lowercase characters

    and ending in '.c':

                                                                        [exBegin]

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

        ]

                                                                        [exEnd]

"

! !

!FileSelectionBox class methodsFor:'accessing'!

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

    |f|

    LastFileSelectionDirectory notNil ifTrue:[

        ((f := LastFileSelectionDirectory asFilename) exists 

        and:[f isDirectory]) ifFalse:[

            LastFileSelectionDirectory := nil.

        ]

    ].

    ^ LastFileSelectionDirectory

    "Created: / 9.9.1997 / 10:03:17 / cg"

    "Modified: / 16.6.1998 / 15:11:20 / cg"

!

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

    LastFileSelectionDirectory := aDirectoryString

    "Created: / 9.9.1997 / 10:03:42 / cg"

    "Modified: / 15.6.1998 / 14:05:21 / cg"

! !

!FileSelectionBox class methodsFor:'defaults'!

listViewType

    "return the type of listView - using a FileSelectionList here"

    ^ FileSelectionList

! !

!FileSelectionBox class methodsFor:'menu specs'!

fileListMenu

    "This resource specification was automatically generated

     by the MenuEditor of ST/X."

    "Do not manually edit this!! If it is corrupted,

     the MenuEditor may not be able to read the specification."

    "

     MenuEditor new openOnClass:FileSelectionBox andSelector:#fileListMenu

     (Menu new fromLiteralArrayEncoding:(FileSelectionBox fileListMenu)) startUp

    "

    <resource: #menu>

    ^ 

     #(#Menu

        #(

         #(#MenuItem

            #label: 'New Folder...'

            #translateLabel: true

            #value: #fileListMenuNewFolder

          )

         #(#MenuItem

            #label: '-'

          )

         #(#MenuItem

            #label: 'Remove...'

            #translateLabel: true

            #value: #fileListMenuRemove

          )

         )

        nil

        nil

      )

! !

!FileSelectionBox methodsFor:'accessing'!

allowMakeDirectory:aBoolean

    "allow or deny creation of new directories;

     The default is to allow it."

    allowMakeDirectory := aBoolean.

!

contents

    "return the current entered value (i.e. the enterFields string).

     redefined to return the full pathname."

    |string|

    string := super contents.

    string size == 0 ifTrue:[

        selectingDirectory ifFalse:[^ string].

        ^ selectionList directory pathName

    ].

    (string asFilename isAbsolute) ifTrue:[

        ^ string

    ].

    ^ (selectionList directory pathName asFilename construct:string) asString

    "Modified: / 9.9.1998 / 21:23:16 / cg"

!

directory

    "return the directory which is currently shown"

    ^ selectionList directory

!

directory:directoryName

    "change the directory shown in the list."

    selectionList directory:directoryName.

    selectingDirectory ifTrue:[

        enterField contents:directoryName asFilename pathName

    ]

!

fileName

    "if some filename has been entered, return it (without the directory path)

     otherwise, return nil"

    |string|

    string := super contents.

    string isNil ifTrue:[^ nil].

    ^ self pathName asFilename baseName

    "Modified: / 12.8.1998 / 09:54:01 / cg"

!

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

    selectionList matchBlock:aBlock 

!

openOn:aPath

    "open the box showing files in aPath.

     This is only a shortcut message - no new functionality."

    self directory:aPath.

    self showAtPointer

!

pathName

    "same as contents - return the full pathname of the selected file,

     or the pathname of the directory if nothing has been entered"

    ^ self contents

!

pattern:aPattern

    "set the pattern - this also enables the PatternField

     (if the pattern is non-nil) or hides it (if nil)."

    |focusSequence|

    patternField initialText:aPattern.

    selectionList pattern:aPattern.

    aPattern isNil ifTrue:[

        patternField beInvisible.

        self makeUntabable:patternField.

        focusSequence := (Array 

                             with:enterField 

                             with:selectionList 

                             with:okButton 

                             with:abortButton)

    ] ifFalse:[

        patternField beVisible.

        self makeTabable:patternField.

        focusSequence := (Array 

                             with:patternField 

                             with:enterField 

                             with:selectionList 

                             with:okButton 

                             with:abortButton)

    ].

    windowGroup notNil ifTrue:[

        windowGroup focusSequence:focusSequence

    ].

    "Modified: 18.10.1997 / 03:02:05 / cg"

!

selectingDirectory:aBoolean

    "setup the box for directory selection (hides regular files).

     Use this, to ask the user for a directories name"

    selectingDirectory := aBoolean.

    aBoolean ifTrue:[

        selectionList directoryChangeAction:[:entry | self directoryChanged].

        selectionList directorySelectAction:[:entry | self directorySelected].

        selectionList ignoreFiles:true.

    ]

    "Modified: 22.10.1996 / 13:24:50 / cg"

! !

!FileSelectionBox methodsFor:'change & update'!

update:something with:argument from:changedObject

    |commonName index s|

    something == #directory ifTrue:[

        "

         sent by fileNameEnterField, if a filename

         completion was not possible due to multiple

         matches.

        "

        selectionList directory:argument.

        s := enterField contents.

        s notNil ifTrue:[

            commonName := s asFilename baseName.

            commonName size ~~ 0 ifTrue:[

                index := selectionList list findFirst:[:entry | entry startsWith:commonName].

                index ~~ 0 ifTrue:[

                    selectionList makeLineVisible:index

                ]

            ]

        ]