"{ Package: 'stx:libtool' }"

SimpleDialog subclass:#FileDialog

	instanceVariableNames:'aspects treeBrowser enableBack enableDirectoryUp enableForward

		enableHome directory pattern filterHolder initialText

		doubleClickAction cancelLabelHolder okLabelHolder startFilename

		result filterField filenameField viewFiles filenameLabelHolder

		asLoadDialog newDirectoryVisibilityHolder

		appendButtonVisibleHolder multipleSelect appendWasPressed'

	classVariableNames:'LastFileSelectionDirectory'

	poolDictionaries:''

	category:'Interface-Tools-File'

!

!FileDialog class methodsFor:'documentation'!

documentation

"

    documentation to be added.

    [author:]

        Martin Walser (martin@vercingetorix)

    [instance variables:]

    [class variables:]

    [see also:]

"

!

examples

"

  Starting the application:

                                                                [exBegin]

    FileDialog open

                                                                [exEnd]

  more examples to be added:

                                                                [exBegin]

    ... add code fragment for 

    ... executable example here ...

                                                                [exEnd]

"

!

history

    "Created: / 19.9.2002 / 13:05:28 / martin"

! !

!FileDialog class methodsFor:'instance creation'!

requestDirectoryName:title default:aFileName ifFail:failBlock

    "same as requestFileName, but only show directories"

    ^ self  requestDirectoryName:title 

            default:aFileName 

            ok:nil 

            abort:nil 

            version:nil 

            pattern:nil 

            fromDirectory:nil 

            ifFail:failBlock 

            whenBoxCreatedEvaluate:nil

            asLoadDialog:nil.

    "

     FileDialog

        requestDirectoryName:'which directory ?' 

        ifFail:'none'

    "

!

requestDirectoryName:titleString default:aFileName ok:okText abort:abortText version:versionSymbol pattern:pattern fromDirectory:aDirectoryPath ifFail:failBlock whenBoxCreatedEvaluate:boxCreatedCallback asLoadDialog:aBoolean

    "same as requestFileName, but only show directories"

    |enteredFileName instance enteredFileNameString|

    instance := self    startApplicationFor:titleString 

                        default:aFileName 

                        ok:okText 

                        abort:abortText 

                        ifFail:failBlock 

                        pattern:pattern 

                        fromDirectory:aDirectoryPath 

                        whenBoxCreatedEvaluate:boxCreatedCallback

                        asLoadDialog:aBoolean

                        forDirectory:true

                        multipleSelect:false.

    enteredFileNameString := instance result.

    enteredFileNameString isNil ifTrue:[

        ^ failBlock value

    ].

    enteredFileName := enteredFileNameString asFilename.

    enteredFileNameString := enteredFileName asString.

    (enteredFileName notNil 

    and:[enteredFileNameString notEmpty]) ifTrue:[

        versionSymbol isNil ifTrue:[ ^ enteredFileNameString].

        versionSymbol == #mustBeNew ifTrue:[

            "/ file may not exist

            enteredFileName exists ifTrue:[^ ''].

        ].

        versionSymbol == #new ifTrue:[

            "/ file may not exist

            enteredFileName exists ifTrue:[

                (Dialog confirm:(self classResources string:'''%1'' exists.\\Continue anyway ?' with:enteredFileNameString) withCRs)

                    ifFalse:[^ ''].

            ].

        ].

        versionSymbol == #mustBeOld ifTrue:[

            enteredFileName exists ifFalse:[^ ''].

        ].

        versionSymbol == #old ifTrue:[

            "/ file may not exist

            enteredFileName exists ifFalse:[

                (self confirm:(self classResources string:'''%1'' does not exist yet.\\Continue anyway ?' with:enteredFileNameString) withCRs)

                ifFalse:[^ ''].

            ].

        ].

        FileSelectionBox lastFileSelectionDirectory:(enteredFileNameString).

    ].

    ^ enteredFileNameString

    "

     FileDialog

        requestDirectoryName:'which directory ?' 

        ifFail:nil

    "

    "

     FileDialog

        requestDirectoryName:'which directory ?' 

        ok:nil

        abort:nil 

        version:nil 

        pattern:nil 

        fromDirectory:nil 

        ifFail:nil 

        whenBoxCreatedEvaluate:nil

        asLoadDialog:true

    "

!

requestFileName:titleString default:defaultName ok:okText abort:abortText pattern:pattern fromDirectory:aDirectoryPathOrNil whenBoxCreatedEvaluate:boxCreatedCallback

    ^ self  requestFileName:titleString 

            default:defaultName 

            ok:okText 

            abort:abortText 

            version:nil 

            ifFail:nil 

            pattern:pattern 

            fromDirectory:aDirectoryPathOrNil 

            whenBoxCreatedEvaluate:boxCreatedCallback

!

requestFileName:titleString default:defaultName ok:okText abort:abortText version:versionSymbol ifFail:failBlock pattern:pattern fromDirectory:aDirectoryPath whenBoxCreatedEvaluate:boxCreatedCallback

    "launch a Dialog, which allows user to enter a filename.

     The files presented initially are those in aDirectoryPathOrNil, or the

     last fileBox directory (default: current directory) (if a nil path is given).

     The box will show okText in its okButton, abortText in the abortButton.

     The matchPattern is set to pattern initially.

     Return the string, or nil if cancel was pressed

     The version argument allows validation of the files existance;

     it may be any of:

        #mustBeNew      - fail (return empty string) if the file exists

        #new            - confirm if the file exists

        #mustBeOld      - fail if the file does not exist

        #old            - confirm if the file does not exist

        #any (other)    - no validation

    "

    ^ self  requestFileName:titleString 

            default:defaultName 

            ok:okText 

            abort:abortText 

            version:versionSymbol 

            ifFail:failBlock 

            pattern:pattern 

            fromDirectory:aDirectoryPath 

            whenBoxCreatedEvaluate:boxCreatedCallback 

            asLoadDialog:nil

!

requestFileName:titleString default:defaultName ok:okText abort:abortText version:versionSymbol ifFail:failBlock pattern:pattern fromDirectory:aDirectoryPath whenBoxCreatedEvaluate:boxCreatedCallback asLoadDialog:aBoolean

    "launch a Dialog, which allows user to enter a filename.

     The files presented initially are those in aDirectoryPathOrNil, or the

     last fileBox directory (default: current directory) (if a nil path is given).

     The box will show okText in its okButton, abortText in the abortButton.

     The matchPattern is set to pattern initially.

     Return the string, or nil if cancel was pressed

     The version argument allows validation of the files existance;

     it may be any of:

        #mustBeNew      - fail (return empty string) if the file exists

        #new            - confirm if the file exists

        #mustBeOld      - fail if the file does not exist

        #old            - confirm if the file does not exist

        #any (other)    - no validation

    "

    | instance enteredFileName enteredFileNameString|

    instance := self    startApplicationFor:titleString 

                        default:defaultName 

                        ok:okText 

                        abort:abortText 

                        ifFail:failBlock 

                        pattern:pattern 

                        fromDirectory:aDirectoryPath 

                        whenBoxCreatedEvaluate:boxCreatedCallback

                        asLoadDialog:aBoolean

                        forDirectory:false

                        multipleSelect:false.

    enteredFileNameString := instance result.

    (enteredFileNameString isNil or:[enteredFileNameString isEmpty]) ifTrue:[

        ^ failBlock value

    ].

    enteredFileName := enteredFileNameString asFilename.

    enteredFileNameString := enteredFileName asString.

    (enteredFileName notNil 

    and:[enteredFileNameString notEmpty]) ifTrue:[

        versionSymbol isNil ifTrue:[ ^ enteredFileNameString].

        versionSymbol == #mustBeNew ifTrue:[

            "/ file may not exist

            enteredFileName exists ifTrue:[^ ''].

        ].

        versionSymbol == #new ifTrue:[

            "/ file may not exist

            enteredFileName exists ifTrue:[

                (Dialog confirm:(self classResources string:'''%1'' exists.\\Continue anyway ?' with:enteredFileNameString) withCRs)

                    ifFalse:[^ ''].

            ].

        ].

        versionSymbol == #mustBeOld ifTrue:[

            enteredFileName exists ifFalse:[^ ''].

        ].

        versionSymbol == #old ifTrue:[

            "/ file may not exist

            enteredFileName exists ifFalse:[

                (self confirm:(self classResources string:'''%1'' does not exist yet.\\Continue anyway ?' with:enteredFileNameString) withCRs)

                ifFalse:[^ ''].

            ].

        ].

        FileSelectionBox lastFileSelectionDirectory:(enteredFileName directoryName).

    ].

    ^ enteredFileNameString

"

     FileDialog 

        requestFileName:'enter a fileName:'

        default:''

        ok:nil 

        abort:nil

        version:nil

        ifFail:['none']

        pattern:'*.conf'

        whenBoxCreatedEvaluate:nil

        asLoadDialog:true

"

!

requestFileName:titleString default:defaultName version:versionSymbol ifFail:failBlock pattern:pattern fromDirectory:aDirectoryPathOrNil whenBoxCreatedEvaluate:boxCreatedCallback

    ^ self  requestFileName:titleString 

            default:defaultName 

            ok:nil 

            abort:nil 

            version:versionSymbol 

            ifFail:failBlock 

            pattern:pattern 

            fromDirectory:aDirectoryPathOrNil 

            whenBoxCreatedEvaluate:boxCreatedCallback

    "

     FileDialog 

        requestFileName:'enter a fileName:'

        default:''

        version:nil

        ifFail:['none']

        pattern:'*.conf'

        whenBoxCreatedEvaluate:nil.

     Dialog 

        requestFileName:'enter a fileName:'

        default:''

        version:nil

        ifFail:['none']

        pattern:'*.conf'

        whenBoxCreatedEvaluate:nil

    "

    "

     FileDialog

        requestFileName:'enter a fileName:'

        default:''

        version:#old 

        ifFail:['none']   

        pattern:'*.conf'

        whenBoxCreatedEvaluate:nil

    "

    "

     FileDialog

        requestFileName:'enter a fileName:'

        default:''

        version:#mustBeNew 

        ifFail:['none']   

        pattern:'*.conf'

        whenBoxCreatedEvaluate:nil

    "

!

requestFileNames:titleString default:defaultName ok:okText abort:abortText ifFail:failBlock pattern:pattern fromDirectory:aDirectoryPath whenBoxCreatedEvaluate:boxCreatedCallback

    "launch a Dialog, which allows user to enter a filename.

     The files presented initially are those in aDirectoryPathOrNil, or the

     last fileBox directory (default: current directory) (if a nil path is given).

     The box will show okText in its okButton, abortText in the abortButton.

     The matchPattern is set to pattern initially.

     Return all selected Filenames as filenames in a collection, or nil if cancel was pressed

    "

    ^ self  requestFileNames:titleString 

            default:defaultName 

            ok:okText 

            abort:abortText 

            ifFail:failBlock 

            pattern:pattern 

            fromDirectory:aDirectoryPath 

            whenBoxCreatedEvaluate:boxCreatedCallback 

            asLoadDialog:nil.

"

     FileDialog 

        requestFileNames:'enter a fileName:'

        default:''

        ok:nil 

        abort:nil 

        ifFail:['none']

        pattern:'*.conf'

        whenBoxCreatedEvaluate:nil.

"

!

requestFileNames:titleString default:defaultName ok:okText abort:abortText ifFail:failBlock pattern:pattern fromDirectory:aDirectoryPath whenBoxCreatedEvaluate:boxCreatedCallback asLoadDialog:asLoadDialog

    "launch a Dialog, which allows user to enter a filename.

     The files presented initially are those in aDirectoryPathOrNil, or the

     last fileBox directory (default: current directory) (if a nil path is given).

     The box will show okText in its okButton, abortText in the abortButton.

     The matchPattern is set to pattern initially.

     Return all selected Filenames as filenames in a collection, or nil if cancel was pressed

    "

    | instance enteredFileNames lastDirectory|

    instance := self    startApplicationFor:titleString 

                        default:defaultName 

                        ok:okText 

                        abort:abortText 

                        ifFail:failBlock 

                        pattern:pattern 

                        fromDirectory:aDirectoryPath 

                        whenBoxCreatedEvaluate:boxCreatedCallback

                        asLoadDialog:asLoadDialog 

                        forDirectory:false

                        multipleSelect:true.

    enteredFileNames := instance currentSelectedFiles.

    (enteredFileNames isEmpty or:[instance result isNil]) ifTrue:[

        ^ failBlock value

    ].

    lastDirectory := enteredFileNames first.

    lastDirectory := lastDirectory isFilename ifTrue:[lastDirectory directory] ifFalse:[lastDirectory].

    FileSelectionBox lastFileSelectionDirectory:(lastDirectory directoryName).

    ^ enteredFileNames

"

     FileDialog 

        requestFileNames:'enter a fileName:'

        default:''

        ok:nil 

        abort:nil 

        ifFail:['none']

        pattern:'*.conf'

        whenBoxCreatedEvaluate:nil

        asLoadDialog:true.

"

!

startApplicationFor:titleString default:aFileName ok:okText abort:abortText ifFail:failBlock pattern:pattern fromDirectory:aDirectoryPath whenBoxCreatedEvaluate:boxCreatedCallback asLoadDialog:asLoadDialog forDirectory:forDirectory multipleSelect:multipleSelect

    "launch a Dialog, which allows user to enter a filename.

     The files presented initially are those in aDirectoryPathOrNil, or the

     last fileBox directory (default: current directory) (if a nil path is given).

     The box will show okText in its okButton, abortText in the abortButton.

     The matchPattern is set to pattern initially.

     Return the string, or nil if cancel was pressed

     The version argument allows validation of the files existance;

     it may be any of:

        #mustBeNew      - fail (return empty string) if the file exists

        #new            - confirm if the file exists

        #mustBeOld      - fail if the file does not exist

        #old            - confirm if the file does not exist

        #any (other)    - no validation

    "

    | defaultDir defaultNm instance defaultFile locFilename|

    locFilename := aFileName.

    defaultNm := locFilename.

    defaultDir := aDirectoryPath.

    defaultDir isNil ifTrue:[

        defaultNm notNil ifTrue:[

            defaultDir := locFilename asFilename asAbsoluteFilename directory.

        ] ifFalse:[

            defaultDir := FileSelectionBox lastFileSelectionDirectory.

            defaultDir isNil ifTrue:[

                defaultDir := Filename currentDirectory asAbsoluteFilename.        

            ].

        ]

    ].

    defaultDir := defaultDir asFilename asAbsoluteFilename.

    [defaultDir exists not] whileTrue:[

        defaultDir := defaultDir directory.

    ].

    forDirectory not ifTrue:[

        (locFilename notNil and:[locFilename asFilename withoutSuffix baseName ~= '*']) ifTrue:[

            defaultFile := defaultDir construct:(locFilename asFilename baseName).

        ].

    ] ifFalse:[

        defaultFile := locFilename asFilename asAbsoluteFilename.

    ].

    defaultFile isNil ifTrue:[

        defaultFile := defaultDir.

    ].

    instance := self new.

    defaultDir notNil ifTrue:[instance directory:(defaultDir asFilename)].

    instance multipleSelect:multipleSelect ? false.

    instance startFilename:defaultFile.

    instance pattern:((pattern isNil or:[pattern isEmpty]) ifTrue:['*'] ifFalse:[pattern]).

    instance initialText:titleString.

    instance okLabelHolder value:okText.

    instance cancelLabelHolder value:abortText.

    instance asLoadDialog:asLoadDialog ? false.

    instance viewFiles:(forDirectory isNil ifTrue:[true] ifFalse:[forDirectory not]).

    self setDoubleClickActionFor:instance.

    instance allButOpenInterface:#windowSpec.

    boxCreatedCallback notNil ifTrue:[boxCreatedCallback value:instance].

    Dialog aboutToOpenBoxNotificationSignal raiseRequestWith:instance.

    instance openWindowModal.

    ^ instance

! !

!FileDialog 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

!

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

!

setDoubleClickActionFor:instance

    instance doubleClickAction:[:anIndex|

        | item |

        item := instance treeBrowser fileList at:anIndex ifAbsent:nil.

        item notNil ifTrue:[

            ((instance viewFiles and:[item isDirectory not]) or:[instance viewFiles not]) ifTrue:[

                instance doAccept.

            ]

        ]

    ].

! !