"

 COPYRIGHT (c) 1997 by eXept Software AG / 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:#SelectionInTreeView

	instanceVariableNames:'validateDoubleClickBlock selectionHolder rootHolder imageWidth

		showLines listOfNodes imageInset textInset openIndicator

		closeIndicator showRoot extentOpenIndicator extentCloseIndicator

		showDirectoryIndicator indicatorExtentDiv2 imageOpened

		imageClosed imageItem'

	classVariableNames:'ImageOpened ImageClosed ImageItem OpenIndicator CloseIndicator'

	poolDictionaries:''

	category:'Views-Text'

!

!SelectionInTreeView class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1997 by eXept Software AG / 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

"

    somewhat like a SelectionInListView; but specialized for hierarchical (i.e. tree-like)

    lists and adds the functions to show/hide subtrees. 

    Requires SelectionInTree as model and TreeItem (or compatible) list entries.

    This class obsoletes SelectionInTreeView, which is no longer

    maintained but kept for backward compatibility.

    [see also:]

        SelectionInTree

        TreeItem

        SelectionInTreeView

        SelectionInListView

        FileSelectionTree

    [author:]

        Claus Atzkern

"

!

examples

"

    shows the tree of smalltalk classes:

                                                                        [exBegin]

      |top sel|

      top := StandardSystemView new; extent:300@300.

      sel := SelectionInTreeView new.

      sel root:(TreeItem newAsTreeFromSmalltalkClass:Object).

      sel action:[:nr | Transcript show:'selected:'; showCR:nr].

      top add:(ScrollableView forView:sel) in:((0.0 @ 0.0 ) corner:( 1.0 @ 1.0)).

      top open.

                                                                        [exEnd]

    same, including nil-subclasses (i.e. really all classes):

                                                                        [exBegin]

      |top sel|

      top := StandardSystemView new; extent:300@300.

      sel := SelectionInTreeView new.

      sel root:(TreeItem newAsTreeFromSmalltalkClass:nil).

      sel action:[:nr | Transcript show:'selected:'; showCR:nr].

      top add:(ScrollableView forView:sel) in:((0.0 @ 0.0 ) corner:( 1.0 @ 1.0)).

      top open.

                                                                        [exEnd]

    shows the tree of smalltalk classes; show directory indication and no

    lines.

                                                                        [exBegin]

      |top sel|

      top := StandardSystemView new; extent:300@300.

      sel := SelectionInTreeView new.

      sel showLines:false.

      sel showDirectoryIndicator:true.

      sel root:(TreeItem newAsTreeFromSmalltalkClass:Object).

      sel action:[:nr | Transcript show:'selected:'; showCR:nr].

      top add:(ScrollableView forView:sel) in:((0.0 @ 0.0 ) corner:( 1.0 @ 1.0)).

      top open.

                                                                        [exEnd]

"

! !

!SelectionInTreeView class methodsFor:'constants'!

minImageInset

    "returns minimum inset from directory indication to image

    "

  ^ 6

! !

!SelectionInTreeView class methodsFor:'default images'!

closeIndicator

    CloseIndicator isNil ifTrue:[

        CloseIndicator := Image fromFile:('xpmBitmaps/plus.xpm').

    ].

  ^ CloseIndicator

"

CloseIndicator := nil

"

!

imageClosed

    ImageClosed isNil ifTrue:[

        ImageClosed := Image fromFile:('xpmBitmaps/document_images/tiny_yellow_dir.xpm').

    ].

  ^ ImageClosed

"

ImageClosed := nil

"

!

imageItem

    ImageItem isNil ifTrue:[

        ImageItem := Image fromFile:('xpmBitmaps/document_images/tiny_file_plain.xpm')  

    ].

  ^ ImageItem

"

ImageItem := nil

"

!

imageOpened

    ImageOpened isNil ifTrue:[

        ImageOpened := Image fromFile:('xpmBitmaps/document_images/tiny_yellow_dir_open.xpm').

    ].

  ^ ImageOpened

"

ImageOpened := nil

"

!

openIndicator

    OpenIndicator isNil ifTrue:[

        OpenIndicator := Image fromFile:('xpmBitmaps/minus.xpm').

    ].

  ^ OpenIndicator

"

OpenIndicator := nil

"

! !

!SelectionInTreeView methodsFor:'accessing'!

nodeAtIndex:anIndex

    "returns node at an index or nil

    "

    (anIndex notNil and:[anIndex ~~ 0 and:[anIndex <= listOfNodes size]]) ifTrue:[

        ^ listOfNodes at:anIndex

    ].

  ^ nil

!

root

    "gets the root of the model; the first item into list.

    "

    ^ self nodeAtIndex:1

!

root:aRoot

    "sets the root of the model; the first item into list.

    "

    aRoot notNil ifTrue:[aRoot expand].

    model root:aRoot

!

textInset

    "get the left inset of the text label

    "

    ^ textInset

!

textInset:anInset

    "set the left inset of the text label

    "

    anInset ~~ textInset ifTrue:[

        anInset >= 0 ifTrue:[

            textInset := anInset.

            self invalidate

        ] ifFalse:[

            self error

        ]

    ].

! !

!SelectionInTreeView methodsFor:'accessing-behavior'!

showDirectoryIndicator

    "returns true if directories has an open/closed indicator

    "

  ^ showDirectoryIndicator

!

showDirectoryIndicator:aState

    "set or clear open/closed indicator for directories

    "

    "show or hide lines

    "

    aState ~~ showDirectoryIndicator ifTrue:[

        showDirectoryIndicator := aState.

        self refetchDeviceResources.

        self invalidate

    ].

!

showLines

    "returns true if lines are shown

    "

  ^ showLines

!

showLines:aState

    "show or hide lines

    "

    aState ~~ showLines ifTrue:[

        showLines := aState.

        self invalidate

    ].

!

showRoot

    "list with or without root

    "

  ^ showRoot

!

showRoot:aState

    "list with or without root

    "

    showRoot ~~ aState ifTrue:[

        model showRoot:(showRoot := aState)

    ].

!

validateDoubleClickBlock

    "set the conditionBlock; this block is evaluated before a doubleClick action

     on a node will be performed. In case of returning false, the doubleClick will

     not be handled.

   "

   ^ validateDoubleClickBlock

!

validateDoubleClickBlock:aOneArgBlock

    "set the conditionBlock; this block is evaluated before a doubleClick action

     on a node will be performed. In case of returning false, the doubleClick will

     not be handled.

   "

   validateDoubleClickBlock := aOneArgBlock

! !

!SelectionInTreeView methodsFor:'accessing-channels'!

rootHolder

    "get the holder which keeps the hierarchical list entry or nil

    "

    ^ rootHolder

!

rootHolder:aValueHolder

    "set the holder which keeps the hierarchical list entry or nil

    "

    rootHolder notNil ifTrue:[

        rootHolder removeDependent:self

    ].

    (rootHolder := aValueHolder) notNil ifTrue:[

        rootHolder addDependent:self.

        self rootFromModel.

    ].

!

selectionHolder

    "get the holder which keeps a list of selected items or nil

    "

    ^ selectionHolder

!

selectionHolder:aHolder

    "set the holder which keeps a list of selected items or nil

    "

    selectionHolder notNil ifTrue:[

        selectionHolder removeDependent:self

    ].

    (selectionHolder := aHolder) notNil ifTrue:[

        selectionHolder addDependent:self.

        self selectionFromModel

    ].

! !

!SelectionInTreeView methodsFor:'accessing-images'!

imageClosed

    "return the value of the instance variable 'imageClosed' (automatically generated)"

    ^ imageClosed

    "Created: 3.7.1997 / 12:34:31 / cg"

!

imageClosed:something

    "set the value of the instance variable 'imageClosed' (automatically generated)"

    imageClosed := something.

    self refetchDeviceResources.

!

imageItem

    "return the value of the instance variable 'imageItem' (automatically generated)"

    ^ imageItem

    "Created: 3.7.1997 / 12:34:34 / cg"

!

imageItem:something

    "set the value of the instance variable 'imageItem' (automatically generated)"

    imageItem := something.

    self refetchDeviceResources.

!

imageOpened

    "return the value of the instance variable 'imageOpened' (automatically generated)"

    ^ imageOpened

    "Created: 3.7.1997 / 12:34:28 / cg"

!

imageOpened:something

    "set the value of the instance variable 'imageOpened' (automatically generated)"

    imageOpened := something.

    self refetchDeviceResources.

! !

!SelectionInTreeView methodsFor:'change & update'!

update:something with:aParameter from:aModel

    "one of my models changed its value

    "

    aModel == rootHolder ifTrue:[

        ^ self rootFromModel

    ].

    aModel == selectionHolder ifTrue:[

        ^ self selectionFromModel

    ].

    ^ super update:something with:aParameter from:aModel.

! !

!SelectionInTreeView methodsFor:'drawing'!

drawLine:line atX:atX inVisible:visLineNr with:fg and:bg

    self drawFromVisibleLine:visLineNr to:visLineNr with:fg and:bg

!

drawLine:line fromX:x inVisible:visLineNr with:fg and:bg

    self drawFromVisibleLine:visLineNr to:visLineNr with:fg and:bg

!

drawLine:line inVisible:visLineNr with:fg and:bg

    self drawFromVisibleLine:visLineNr to:visLineNr with:fg and:bg

!

drawVisibleLine:visLineNr col:col with:fg and:bg

    self drawFromVisibleLine:visLineNr to:visLineNr with:fg and:bg

!

drawVisibleLine:visLineNr from:startCol to:endCol with:fg and:bg

    self drawFromVisibleLine:visLineNr to:visLineNr with:fg and:bg

!

drawVisibleLine:visLineNr from:startCol with:fg and:bg

    self drawFromVisibleLine:visLineNr to:visLineNr with:fg and:bg

! !

!SelectionInTreeView methodsFor:'drawing basics'!

drawFromVisibleLine:startVisLineNr to:endVisLineNr with:fg and:bg

    |size end index yBot yTop yCtr level figWidthDiv2

     x xFig xStr node lv idx image xCross|

    index := self visibleLineToAbsoluteLine:startVisLineNr.

    size  := listOfNodes size.

    yTop  := self yOfVisibleLine:startVisLineNr.

    end   := endVisLineNr - startVisLineNr + 1.

"/  clear rectangle line and set background color

    self paint:bg.

    self fillRectangleX:0 y:yTop width:width height:(end * fontHeight).

    index isNil ifTrue:[^ self].

    figWidthDiv2 := imageWidth // 2..

    yCtr := yTop - (fontHeight // 2).

    self paint:fg on:bg.

    (end := index + end) > size ifTrue:[end := size + 1].

    [index < end] whileTrue:[

        node := listOfNodes at:index.

        yBot := yTop + fontHeight.

        yCtr := yCtr + fontHeight.

        (lv := node level) == level ifFalse:[

            level  := lv.

            xFig   := self xOfFigureLevel:lv.

            xStr   := self xOfStringLevel:lv.

            xCross := (self xOfFigureLevel:(lv-1)) + figWidthDiv2.

        ].

        showLines ifTrue:[

            (node isCollapsable and:[node numberOfChildren ~~ 0]) ifTrue:[

                x := xFig + figWidthDiv2.

                self displayLineFromX:x y:yCtr  toX:x y:yBot

            ].

            (level ~~ 1 and:[node parent children last == node]) ifTrue:[

                self displayLineFromX:xCross y:yTop toX:xCross y:yCtr . "/ vertical

            ].

            self displayLineFromX:xCross y:yCtr toX:xFig y:yCtr .       "/ horizontal

        "/  draw vertical lines

            idx := index.

            [(lv > 0 and:[(idx := idx + 1) <= size])] whileTrue:[

                (x := (listOfNodes at:idx) level) <= lv ifTrue:[

                    lv := x - 1.

                    x  := (self xOfFigureLevel:lv) + figWidthDiv2.

                    self displayLineFromX:x y:yTop toX:x y:yBot.

                ]

            ]

        ].

        "/ draw image

        image := self figureFor:node.

        "/ draw text label

        self drawLabelIndex:index atX:xStr y:yCtr .