"

 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:'doubleClickSelectionBlock figuresWidth leftIndent

	classVariableNames:'ImageOpened ImageClosed ImageItem'

	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

    [author:]

        Claus Atzkern

"

!

examples

"

    shows the tree of smalltalk classes:

                                                                        [exBegin]

      |top model sel root|

      root  := TreeItem newAsTreeFromSmalltalkClass:Object.

      root expand.

      model := SelectionInTree new root:root.

      top := StandardSystemView new.

      top extent:300@300.

      sel := SelectionInTreeView new.

      sel model: model.

      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 model sel root|

      root  :=  TreeItem newAsTreeFromSmalltalkClass:nil.

      root expand.

      model := SelectionInTree new root:root.

      top   := StandardSystemView new.

      top extent:300@300.

      sel := SelectionInTreeView new.

      sel model: model.

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

figuresInset

    "returns horizontal right and left inset of a figure

    "

  ^ 2

!

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

"

! !

!SelectionInTreeView methodsFor:'accessing'!

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.

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

!

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.

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

!

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.

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

!

list:aList keepSelection:keepSelection

    |list|

    list := aList.

    list size == 0 ifTrue:[

        listOfNodes := #()

    ] ifFalse:[

        (list first respondsTo:#hasChildren) ifTrue:[

            listOfNodes := aList.

            list := listOfNodes collect:[:aNode| aNode name ].

        ]

    ].

    super list:list keepSelection:keepSelection

! !

!SelectionInTreeView methodsFor:'accessing-behavior'!

doubleClickSelectionBlock

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

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

     doubleClick will not be handled.

   "

   ^ doubleClickSelectionBlock

!

doubleClickSelectionBlock:aBlock

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

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

     doubleClick will not be handled.

   "

   doubleClickSelectionBlock := aBlock

!

showLines

    "returns true if lines are shown

    "

  ^ showLines

!

showLines:aState

    "show or hide lines

    "

    aState ~~ showLines ifTrue:[

        showLines := aState.

        self invalidate

    ].

! !

!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

    |nodeIndex listSize end fontHgDiv2 yBot yTop yCtr

     x x1 xFig xStr node level lvl idx image|

    nodeIndex := self visibleLineToAbsoluteLine:startVisLineNr.

    listSize  := 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).

    nodeIndex isNil ifTrue:[^ self].

    fontHgDiv2 := fontHeight // 2.

    self paint:fg on:bg.

    (end := nodeIndex + end) > listSize ifTrue:[

        end := listSize + 1

    ].

    [nodeIndex < end] whileTrue:[

        node  := listOfNodes at:nodeIndex.

        yBot  := yTop + fontHeight.

        yCtr  := yTop + fontHgDiv2.

        image := self figureFor:node.

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

            level := lvl.

            xFig  := self xOfFigureNode:node.

            xStr  := self xOfStringNode:node.

        ].

        showLines ifTrue:[

            x := xFig + figuresWidthDiv2.

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

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

            ].

        "/  draw horizontal and vertical line

            x1 := x - leftIndent.

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

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

        "/  draw vertical lines

            idx  := nodeIndex.

            idx ~~ listSize ifTrue:[

                x := leftIndent - figuresWidthDiv2.

                [(lvl > 0 and:[(idx := idx + 1) <= listSize])] whileTrue:[

                    node := listOfNodes at:idx.

                    node level > lvl ifFalse:[

                        x1 := (self xOfFigureNode:node) - x.

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

                        lvl := node level - 1

                    ]

                ]

            ]

        ].

        "/ draw image

        self displayForm:image x:xFig y:(yCtr - (image height // 2)).

        "/ draw text label

        self drawLabelIndex:nodeIndex atX:xStr y:yCtr.

        "/ setup next line

        nodeIndex := nodeIndex + 1.

        yTop      := yBot.

    ].

!

drawLabelIndex:anIndex atX:x y:yCenter

    "draw text label at x and y centered

    "

    |y lbl|

    lbl := (listOfNodes at:anIndex) name.

    lbl notNil ifTrue:[

        y := yCenter - ((lbl heightOn:self) // 2).

        (lbl respondsTo:#string) ifTrue:[

            y := y + fontAscent.

        ].

        self displayOpaqueString:lbl x:x y:y.

    ]    

! !

!SelectionInTreeView methodsFor:'initialization'!

fetchDeviceResources

    "initialize heavily used device resources - to avoid rendering

     images again and again later"

    super fetchDeviceResources.

    self refetchDeviceResources

!

fetchImageResources

    "initialize heavily used device resources - to avoid rendering

     images again and again later; returns maximum extent of the images used.

     Could be redefined by subclass

    "

    |y x t|

    imageOpened  := (self class imageOpened) onDevice:device.

    imageClosed  := (self class imageClosed) onDevice:device.

    imageItem    := (self class imageItem)   onDevice:device.

    y := imageClosed heightOn:self.

    x := imageClosed widthOn:self.

    (t := imageOpened heightOn:self) > y ifTrue:[y := t].

    (t := imageOpened widthOn:self)  > x ifTrue:[x := t].

    (t := imageItem   heightOn:self) > y ifTrue:[y := t].

    (t := imageItem   widthOn:self)  > x ifTrue:[x := t].

  ^ x @ y

!

getFontParameters

    super getFontParameters.

    figuresWidth notNil ifTrue:[

        self refetchDeviceResources

    ]

!

initialize

    "setup instance attributes

    "

    super initialize.

    showLines    := true.

    figuresWidth     := 18.                             "/ default: will change during startup

    figuresInset     := 2.                              "/ default: will change during startup

    leftIndent       := figuresWidth + figuresInset.    "/ default: will change during startup

    figuresWidthDiv2 := figuresWidth // 2.              "/ default: will change during startup

!

refetchDeviceResources

    "reinitialize heavily used device resources - to avoid rendering

     images again and again later

    "

    |y extent|

    figuresInset := self class figuresInset.

    extent       := self fetchImageResources.

    extent y > fontHeight ifTrue:[

        fontHeight := extent y.

    ].

    figuresWidth     := extent x.

    leftIndent       := figuresInset + figuresWidth.

    figuresWidthDiv2 := figuresWidth // 2.

! !

getListFromModel

    "if I have a model, get my list from it using the listMessage.

     If listMessage is nil, try aspectMessage for backward compatibilty.

    "

    widthOfWidestLine := nil.

! !

!SelectionInTreeView methodsFor:'private queries'!

lengthOfLongestLineBetween:firstLine and:lastLine

    "return the length (in characters) of the longest line in a line-range

    "

    |max|

    max := self widthOfContents:firstLine and:lastLine.