"

 COPYRIGHT (c) 1993 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.

"

SelectionInListView subclass:#FileSelectionList

	instanceVariableNames:'pattern directory timeStamp directoryId directoryName

		ignoreDirectories directoryChangeCheckBlock quickDirectoryChange

		directoryChangeAction directorySelectAction fileSelectAction

		ignoreFiles directoryHolder'

	classVariableNames:''

	poolDictionaries:''

	category:'Views-Text'

!

!FileSelectionList class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1993 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 lists - its basically a

    selection-in-list-view, but adds some right-arrows to directories.

    (and will soon remember the previous position when changing directories).

    You can specify an optional filename-pattern (such as '*.st') and an

    optional matchBlock (such as: [:name | name startsWith:'A']).

    Only files (plus directories) matching the pattern (if present) and

    for which the matchBlock returns true (if present), are shown.

    Except for file-browser like applications, FileSelectionLists are almost 

    exclusively used with FileSelectionBoxes (see examples there).

    [Instance variables:]

            pattern                 the matchpattern

            directory               the current directory

            timeStamp               the time, when directoryContents was last taken

            directoryId             the directories id (inode-nr) when it was taken

            directoryName           the path when it was taken

            directoryContents       (cached) contents of current directory

            directoryFileTypes      (cached) file types (symbols) of current directory

            fileTypes               file types as shown in list (i.e only matching ones)

            matchBlock              if non-nil: block evaluated per full filename;

                                    only files for which matchBlock returns true are shown.

            realAction              (internal) the action to perform when a file is selected

            quickDirectoryChange    if true, directories can be changed with a single click

                                    if false (the default), they need a double click.

                                    Makes sense if a directory is what we are interested in,

                                    for files its better to leave it as false.

            stayInDirectory         if true, no directoryChanges are allowed.

                                    Makes sense to limit the user to choose among certain files.    

                                    The default is false.

            ignoreParentDirectory   if true, the parent directory is not shown.

                                    Makes sense to limit the user to files below the initial

                                    directory. Default is false.

            ignoreDirectories       if true, no directories are shown at all.

                                    Makes sense to limit the user to choose among regular files.

                                    Default is false.

            ignoreFiles             if true, no regular files are shown at all.

                                    Makes sense to limit the user to choose among directories files.

                                    Default is false.

            directoryChangeCheckBlock 

                                    if nonNil, directoryChanges are only allowed if this block

                                    returns true. It is evaluated with one argument, the pathName.

                                    Defaults to nil (i.e. no checks).

            directorySelectAction 

                                    if nonNil, a directory-select evaluate this block.

                                    Possible hook for others (used with Boxes)

                                    Defaults to nil.

            fileSelectAction 

                                    if nonNil, file-select evaluate this block.

                                    Possible hook for others (used with Boxes)

                                    Defaults to nil.

    [author:]

        Claus Gittinger

    [see also:]

        DialogBox

        EnterBox2 YesNoBox

        ListSelectionBox FileSelectionBox FileSaveBox 

"

!

examples 

"

    FileSelectionLists are typically used in FileSelectionBoxes,

    or file-browser-like applications.

    Thus, the following examples are a bit untypical.

    example (plain file-list):

                                                                        [exBegin]

        |list|

        list := FileSelectionList new.

        list open

                                                                        [exEnd]

    setting a directory holder:

                                                                        [exBegin]

        |holder list|

        holder := '/etc' asValue.

        list := FileSelectionList new.

        list directoryHolder:holder.

        list open.

        (EditField on:holder) open.

                                                                        [exEnd]

    scrolled & some action:

                                                                        [exBegin]

        |top v list|

        top := StandardSystemView new.

        top extent:(300 @ 200).

        v := ScrollableView for:FileSelectionList in:top.

        v origin:(0.0 @ 0.0) corner:(1.0 @ 1.0).

        list := v scrolledView.

        list action:[:index | Transcript showCR:'you selected: ' , list selectionValue].

        top open

                                                                        [exEnd]

    ignore the parentDirectory:

                                                                        [exBegin]

        |top v list|

        top := StandardSystemView new.

        top extent:(300 @ 200).

        v := ScrollableView for:FileSelectionList in:top.

        v origin:(0.0 @ 0.0) corner:(1.0 @ 1.0).

        list := v scrolledView.

        list ignoreParentDirectory:true.

        top open

                                                                        [exEnd]

    ignore all directories (i.e. regular files only):

                                                                        [exBegin]

        |top v list|

        top := StandardSystemView new.

        top extent:(300 @ 200).

        v := ScrollableView for:FileSelectionList in:top.

        v origin:(0.0 @ 0.0) corner:(1.0 @ 1.0).

        list := v scrolledView.

        list ignoreDirectories:true.

        top open

                                                                        [exEnd]

    ignore all regular files (i.e. directories only):

                                                                        [exBegin]

        |top v list|

        top := StandardSystemView new.

        top extent:(300 @ 200).

        v := ScrollableView for:FileSelectionList in:top.

        v origin:(0.0 @ 0.0) corner:(1.0 @ 1.0).

        list := v scrolledView.

        list ignoreFiles:true.

        top open

                                                                        [exEnd]

    dont show the directory arrow-mark:

                                                                        [exBegin]

        |top v list|

        top := StandardSystemView new.

        top extent:(300 @ 200).

        v := ScrollableView for:FileSelectionList in:top.

        v origin:(0.0 @ 0.0) corner:(1.0 @ 1.0).

        list := v scrolledView.

        list markDirectories:false.

        top open

                                                                        [exEnd]

    adds a pattern, only showing .st files and directories:

                                                                        [exBegin]

        |top v list|

        top := StandardSystemView new.

        top extent:(300 @ 200).

        v := ScrollableView for:FileSelectionList in:top.

        v origin:(0.0 @ 0.0) corner:(1.0 @ 1.0).

        list := v scrolledView.

        list pattern:'*.st'.

        list action:[:index | Transcript showCR:'you selected: ' , list selectionValue].

        top open

                                                                        [exEnd]

    a more complicated pattern:

                                                                        [exBegin]

        |top v list|

        top := StandardSystemView new.

        top extent:(300 @ 200).

        v := ScrollableView for:FileSelectionList in:top.

        v origin:(0.0 @ 0.0) corner:(1.0 @ 1.0).

        list := v scrolledView.

        list pattern:'[A-D]*.st'.

        list action:[:index | Transcript showCR:'you selected: ' , list selectionValue].

        top open

                                                                        [exEnd]

    adds a matchblock to show only writable files:

                                                                        [exBegin]

        |top v list|

        top := StandardSystemView new.

        top extent:(300 @ 200).

        v := ScrollableView for:FileSelectionList in:top.

        v origin:(0.0 @ 0.0) corner:(1.0 @ 1.0).

        list := v scrolledView.

        list matchBlock:[:name | 

                            |fileName|

                            fileName := name asFilename.

                            fileName isWritable or:[fileName isDirectory]

                        ].

        list action:[:index | Transcript showCR:'you selected: ' , list selectionValue].

        top open

                                                                        [exEnd]

    adds a matchblock to suppress directories:

    (this can be done easier with #ignoreDirectories)

                                                                        [exBegin]

        |top v list|

        top := StandardSystemView new.

        top extent:(300 @ 200).

        v := ScrollableView for:FileSelectionList in:top.

        v origin:(0.0 @ 0.0) corner:(1.0 @ 1.0).

        list := v scrolledView.

        list matchBlock:[:name | 

                            name asFilename isDirectory not

                        ].

        list action:[:index | Transcript showCR:'you selected: ' , list selectionValue].

        top open

                                                                        [exEnd]

    the above can be done more convenient:

                                                                        [exBegin]

        |top v list|

        top := StandardSystemView new.

        top extent:(300 @ 200).

        v := ScrollableView for:FileSelectionList in:top.

        v origin:(0.0 @ 0.0) corner:(1.0 @ 1.0).

        list := v scrolledView.

        list ignoreDirectories:true.

        list action:[:index | Transcript showCR:'you selected: ' , list selectionValue].

        top open

                                                                        [exEnd]

    adds a matchblock to block parent dirs (i.e. only allow files here & below):

    (can be done easier with #ignoreParentDirectory)

                                                                        [exBegin]

        |top v list currentDir|

        currentDir := '.' asFilename pathName.

        top := StandardSystemView new.

        top extent:(300 @ 200).

        v := ScrollableView for:FileSelectionList in:top.

        v origin:(0.0 @ 0.0) corner:(1.0 @ 1.0).

        list := v scrolledView.

        list matchBlock:[:name | 

                            ((name endsWith:'/..') and:[list directory pathName = currentDir]) not

                        ].

        list action:[:index | Transcript showCR:'you selected: ' , list selectionValue].

        top open

                                                                        [exEnd]

    do not allow changing up AND show all .rc-files only:

    (but allow going down)

                                                                        [exBegin]

        |top v list currentDir|

        currentDir := '.' asFilename pathName.

        top := StandardSystemView new.

        top extent:(300 @ 200).

        v := ScrollableView for:FileSelectionList in:top.

        v origin:(0.0 @ 0.0) corner:(1.0 @ 1.0).

        list := v scrolledView.

        list pattern:'*.rc'.

        list matchBlock:[:name |  

                            ((name endsWith:'/..') and:[list directory pathName = currentDir]) not

                        ].

        list action:[:index | Transcript showCR:'you selected: ' , list selectionValue].

        top open

                                                                        [exEnd]

    show only .rc-files in current directory:

                                                                        [exBegin]

        |top v list currentDir|

        currentDir := '.' asFilename pathName.

        top := StandardSystemView new.

        top extent:(300 @ 200).

        v := ScrollableView for:FileSelectionList in:top.

        v origin:(0.0 @ 0.0) corner:(1.0 @ 1.0).

        list := v scrolledView.

        list pattern:'*.rc'.

        list matchBlock:[:name | 

                            name asFilename isDirectory not

                        ].

        list action:[:index | Transcript showCR:'you selected: ' , list selectionValue].

        top open

                                                                        [exEnd]

    show only h*-files in /etc; dont allow directory changes:

                                                                        [exBegin]

        |top v list|

        top := StandardSystemView new.

        top extent:(300 @ 200).

        v := ScrollableView for:FileSelectionList in:top.

        v origin:(0.0 @ 0.0) corner:(1.0 @ 1.0).

        list := v scrolledView.

        list directory:'/etc'.

        list pattern:'h*'.

        list matchBlock:[:name | name printNL.

                            name asFilename isDirectory not

                        ].

        list action:[:index | Transcript showCR:'you selected: ' , list selectionValue].

        top open

                                                                        [exEnd]

    only allow changing into directories below the current one; i.e. not up;

    but show it

                                                                        [exBegin]

        |top v list here|

        top := StandardSystemView new.

        top extent:(300 @ 200).

        v := ScrollableView for:FileSelectionList in:top.

        v origin:(0.0 @ 0.0) corner:(1.0 @ 1.0).

        list := v scrolledView.

        list directoryChangeCheckBlock:[:dirPath |

                        dirPath asFilename pathName

                            startsWith:Filename currentDirectory pathName].

        list action:[:index | Transcript showCR:'you selected: ' , list selectionValue].

        top open

                                                                        [exEnd]

    living in a box:

                                                                        [exBegin]

        |box listView|

        box := Dialog new.

        box addTextLabel:'which file ?'.

        listView := box 

                        addListBoxOn:nil 

                        class:FileSelectionList

                        withNumberOfLines:10 

                        hScrollable:false 

                        vScrollable:true.

        box addAbortButton; addOkButton.

        box stickAtBottomWithVariableHeight:listView.

        box open.

        box accepted ifTrue:[

            Transcript showCR:listView selectedPathname

        ]

                                                                        [exEnd]

    living in a box (local files only, no directory change allowed):

                                                                        [exBegin]

        |box listView|

        box := Dialog new.

        box addTextLabel:'which file ?'.

        listView := box 

                        addListBoxOn:nil 

                        class:FileSelectionList

                        withNumberOfLines:10 

                        hScrollable:false 

                        vScrollable:true.

        listView ignoreDirectories:true.

        listView ignoreParentDirectory:true.

        box addAbortButton; addOkButton.

        box stickAtBottomWithVariableHeight:listView.

        box open.

        box accepted ifTrue:[

            Transcript showCR:listView selectedPathname

        ]

                                                                        [exEnd]

    living in a box (local files only; immediately show owner in another field):

                                                                        [exBegin]

        |box listView lbl|

        box := Dialog new.

        box addTextLabel:'which file ?'.

        listView := box 

                        addListBoxOn:nil 

                        class:FileSelectionList

                        withNumberOfLines:10 

                        hScrollable:false 

                        vScrollable:true.

        lbl := box addTextLabel:''.

        lbl adjust:#left.

        listView fileSelectAction:[:index |

            |ownerId owner|

            ownerId := listView selectedPathname asFilename info at:#uid.

            ownerId == OperatingSystem getUserID ifTrue:[

                lbl label:('one of yours').

            ] ifFalse:[

                owner := OperatingSystem getUserNameFromID:ownerId.

                lbl label:(owner , '''s property').

            ]

        ].

        listView directorySelectAction:[:index |

            |ownerId owner|

            ownerId := listView selectedPathname asFilename info at:#uid.

            ownerId == OperatingSystem getUserID ifTrue:[

                lbl label:('your files there').

            ] ifFalse:[

                owner := OperatingSystem getUserNameFromID:ownerId.

                lbl label:(owner , '''s files there').

            ]    

        ].

        box addAbortButton; addOkButton.

        box stickAtBottomWithFixHeight:lbl.

        box stickAtBottomWithVariableHeight:listView.

        box open.

        box accepted ifTrue:[

            Transcript showCR:listView selectedPathname

        ]