Class: DirectoryTreeBrowser

• Inheritance
• Description
• Class protocol
  • defaults
  • instance creation
  • interface specs
  • menu specs
  • plugIn spec
• Instance protocol
  • accessing
  • actions
  • aspects
  • change & update
  • drag & drop
  • event handling
  • initialization
  • queries
  • selection
  • startup & release
• Private classes
• Examples

Inheritance:

   Object
   |
   +--Model
      |
      +--ApplicationModel
         |
         +--ApplicationWithFileHistory
            |
            +--AbstractFileBrowser
               |
               +--AbstractDirectoryBrowser
                  |
                  +--DirectoryTreeBrowser

Package:

stx:libtool

Category:

Interface-Tools-File

Version:

rev: 1.155 date: 2023/08/02 14:17:05

user: stefan

file: DirectoryTreeBrowser.st directory: libtool

module: stx stc-classLibrary: libtool

Description:

An application for displaying directories as a tree.
To be used as a building block in file browsers and fileSelection dialogs.
This is used as the top-left component in the new fileBrowser.

copyright
COPYRIGHT (c) 2002 by eXept Software AG
             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.

Class protocol:

 timeForExpandOnDropInMilliseconds

 openOn: aFileName

DirectoryTreeBrowser openOn:Filename homeDirectory
DirectoryTreeBrowser openOn:(Filename homeDirectory construct:'.bashrc')

 openOn: aFileName withFiles: aBoolean

DirectoryTreeBrowser openOn:Filename homeDirectory
DirectoryTreeBrowser openOn:(Filename homeDirectory construct:'.bashrc') withFiles:false

 windowSpec

This resource specification was automatically generated
by the UIPainter of ST/X.

Usage example(s):

UIPainter new openOnClass:DirectoryTreeBrowser andSelector:#windowSpec DirectoryTreeBrowser new openInterface:#windowSpec DirectoryTreeBrowser open

 menu

This resource specification was automatically generated
by the MenuEditor of ST/X.

Usage example(s):

MenuEditor new openOnClass:DirectoryTreeBrowser andSelector:#menu (Menu new fromLiteralArrayEncoding:(DirectoryTreeBrowser menu)) startUp

 sortInTreeMenu

This resource specification was automatically generated
by the MenuEditor of ST/X.

Usage example(s):

MenuEditor new openOnClass:DirectoryTreeBrowser andSelector:#sortInTreeMenu (Menu new fromLiteralArrayEncoding:(DirectoryTreeBrowser sortInTreeMenu)) startUp

 aspectSelectors

This resource specification was automatically generated
by the UIPainter of ST/X.

Instance protocol:

 allowRenameOnOneClick

 browser

return the value of the instance variable 'browser' (automatically generated)

 directory

 doubleClickAction

 doubleClickAction: aBlock

aBlock is a one arg block with selected index as argument

 updateTreeSelection

 doDoubleClick: anIndex

handle a doubleClick on a directory

 doExpand: anItem

expand the item; return true the item have expanded

 doIndicatorClick: anIndex

handle a click on the indicator

 doSetSelectionToRoot

 doUpdate

DirectoryContents flushCache.

 evaluateSortBlockWith: aBlock

 expandEnforceSelectedItems

expand the selected item if one directory selected

 expandSelectedItems

expand the selected item(s) if any directory selected

 moveFileInTreeView

self halt.

 renameFileInTreeView

Modified (format): / 12-12-2021 / 09:48:41 / cg

 renameToIncludeDirectoryInNameInTreeView

 setMatchBlockInList: list

 sortFileListsBy: instanceName

 toggleExpand: anItem

self withWaitCursorDo:[

 toggleExpandSelectedItem

 updateSelectedItem

 allowFileOperations

allowFileOperations

 fileList

holder, which keeps the current list of file entries shown by the directory-browser

 multipleSelect

 multipleSelect: aBoolean

 newVisibilityHolder

newVisibilityHolder

 sortCaseless

aspect for sort caseless

 sortCaseless: aValueHolder

 sortCaselessInTreeBrowser

only for backward compat.
We do not need two such flags

** This is an obsolete interface - do not use it (it may vanish in future versions) **

 sortInTreeVisibilityHolder

newVisibilityHolder

 sortPropertyInTree

 sortPropertyInTree: aValueHolder

 treeSelectionHolder

 treeSelectionHolder: aValueHolder

 changeMatchBlock

 currentFileNameHolderChanged

(comment from inherited method)
self currentFileNameHolderChangedForCommon

 rootHolderChanged

self withWaitCursorDo:[

 selectionChanged

if viewFiles is false i can't take my
selection to overwrite currentFileNameHolder

 update: something with: aParameter from: aModel

one of my models changed

 dropDestinationPath

 dropOver: aDropContext

called during drag & drop while moving over the widget.

 dropTargetItemChangedTo: anItem in: aDropContext

 expandForDrop: item with: aDropContext

 getDisplayObjects: anArgument

Modified (format): / 20-06-2017 / 08:17:36 / cg

 removeExpandItemTimedBlock

(comment from inherited method)
left blank

 setupAutoExpandItemTimedBlock: aBlock

 processEvent: anEvent

filter keyboard events.
Return true, if I have eaten the event

 initialize

 hasOpenEditor

 masterIsFileBrowser

 selectedFilesIncludesNonRootDirectory

|directories|

 firstSelectedDirectory

 rootSelected

 selectFiles: aColOfFileOrDirectory

selects a file; if the file is not included in my
root directory, the root will be changed

 selectItems: aColOfItems

aColOfItems do:[:anItem| anItem isDirectory ifTrue:[ anItem expand ]].

 selectNextFile

 selectPreviousFile

 selectedDirectories

 selectedDirectoryItems

 selectedFilenameDirectories

 selectedItems

Wrap single value into Array

 delayedPostOpenFromMaster: fromMaster

 makeDependent

 openEditorAction

 openEditorIn: aGC forLine: ln

self withWaitCursorDo:[

 postBuildDirBrowser: aWidget

browser hasConstantHeight:true.

 postOpenFromMaster: fromMaster

 release

(comment from inherited method)
remove all references to objects that may refer to self.
Subclasses may redefine this method but should do a 'super release'.

Private classes:

    DirTreeBrowserHFL

Examples:

    DirectoryTreeBrowser open