"

 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.

"

"{ Package: 'stx:libwidg2' }"

"{ NameSpace: Smalltalk }"

Object subclass:#TreeItem

	instanceVariableNames:'name tree parent children contents hide readChildren'

	classVariableNames:'UnknownContents'

	poolDictionaries:''

	category:'Interface-Support'

!

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

"

    THIS CLASS HAS BEEN OBSOLETED by HierarchicalItem with its corresponding

    view class HierarchicalListView. Please use these new ones.

    Class to build up tree-like structures to represent file-trees, class tress etc.

    Especially suited for use with (also now obsolete) SelectionInTree and SelectionInTreeView.

    [Author:]

        W. Olberding

        Claus Atzkern

    [See also:]

        SelectionInTree

        SelectionInTreeView

"

! !

!TreeItem class methodsFor:'instance creation'!

contents:aContents

    |node|

    node := self new.

    node contents:aContents.

  ^ node

!

name:aName

    ^ self name:aName contents:nil

!

name:aName contents:aContents

    |node|

    node := self new.

    node name:aName.

    node contents:aContents.

  ^ node

!

name:aName value:aContents

    ^ self name:aName contents:aContents

!

new

    ^ self basicNew initialize

! !

!TreeItem class methodsFor:'class initialization'!

initialize

    UnknownContents isNil ifTrue:[

        UnknownContents := Object new.

    ]

    "

     self initialize

    "

! !

!TreeItem class methodsFor:'default icons'!

keysAndIcons

    "returns an IdentityDictionary containing a list of images and keys used

     by any file entry; could be redefined by subclass

    "

    ^ nil

! !

!TreeItem class methodsFor:'example-instance creation'!

newAsTreeFromNestedList:aListOfElementsOrSublists named:name

    "create a tree of nodes with fix elements from aListOfElementsOrSublists.

     The tree will contain leafs for any non-collection elements in aListOfElementsOrSublists,

     and sub-trees for 2-element array-elements.

     Useful to be shown in long selection lists, if some grouping is possible"

    |newInst|

    newInst := self new.

    newInst name:name.

    aListOfElementsOrSublists do:[:each |

        each isArray ifTrue:[

            newInst add:(self newAsTreeFromNestedList:each second named:each first)

        ] ifFalse:[    

            newInst add:(self new name:each)

        ]

    ].

    ^ newInst

    "

      |top model sel root|

      root  := TreeItem 

                newAsTreeFromNestedList:

                    #(

                        'one-1'

                        'two-1'

                        ('three...' 

                            ('three-1'

                             'three-2'

                             'three-3'))

                        'four-1'

                        ('five...' 

                            ('five-1'

                             'five-2'

                             'five-3'

                             'five-4'

                             'five-5'))

                        ('six...' 

                            ('six-1' 

                             'six-2' 

                             ('six-3...' 

                                ('six-3-1' 

                                 'six-3-2'

                                 'six-3-3'))

                             'six-4'

                             ('six-5...'

                                ('six-5-1' 

                                 'five-5-2'))

                             ) 

                        )    

                        'seven-1'

                    ).

      root expand.

      model := SelectionInTree new root:root.

      top := StandardSystemView new.

      top extent:300@300.

      sel := SelectionInTreeView new.

      sel showDirectoryIndicator:true.

      sel showRoot:false.

      sel imageOpened:nil.

      sel imageClosed:nil.

      sel imageItem:nil.

      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.

    "

    "Created: / 04-02-2017 / 22:48:28 / cg"

!

newAsTreeFromSmalltalkClass:aClass

    "create a tree of nodes with aClass and all its

     subclasses as contents. Set the initial level as given."

    |newInst clsName|

    aClass isNil ifTrue:[

        "/ nil subclasses requested

        clsName := 'nil'

    ] ifFalse:[

        "/ regular tree requested

        clsName := aClass name

    ].

    newInst := self new.

    newInst name:clsName.

    aClass isNil ifTrue:[

        ((Smalltalk allClasses select:[:cls | cls superclass isNil])

            asSortedCollection:[:a :b | a name < b name])

        do:[:aSubClass |

            newInst add:(self newAsTreeFromSmalltalkClass:aSubClass).

        ]

    ] ifFalse:[

        (aClass subclasses asSortedCollection:[:a :b | a name < b name])

        do:[:aSubClass |

            newInst add:(self newAsTreeFromSmalltalkClass:aSubClass).

        ]

    ].

    ^newInst

"

      |top model sel root|

      root  := TreeItem newAsTreeFromSmalltalkClass:ByteArray.

      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.

"

! !

!TreeItem methodsFor:'accessing'!

contents

    "get the contents; 

     usually, the contents is computed lazily

     i.e. #retrieveContents is invoked when the contents has not yet been set."

    contents == UnknownContents ifTrue:[        

        self retrieveContents

    ].

    ^contents

    "Modified (comment): / 04-02-2017 / 20:23:22 / cg"

!

contents:something 

    "set the contents"

    contents := something

    "Modified (comment): / 04-02-2017 / 20:23:33 / cg"

!

editor

    "returns an editor on the editable value or nil"

    ^ nil

    "Modified (comment): / 04-02-2017 / 20:23:44 / cg"

!

hide

   "retrieve the hide flag "    

    ^ hide

    "Modified (comment): / 04-02-2017 / 20:24:08 / cg"

!

hide:aBoolean

   "set hide flag "    

   hide := aBoolean

    "Modified (comment): / 04-02-2017 / 20:23:55 / cg"

!

icon

    "get the icon"        

    ^self retrieveAndEvaluate: #iconAction

    "Modified (comment): / 04-02-2017 / 20:24:16 / cg"

!

label

    "for protocol compatibility with herarchical item"

    ^ self name

    "Created: / 20-10-2017 / 11:30:15 / cg"

!

labelPath

    "for protocol compatibility with herarchical item"

    ^ ({self} , self allParents) reverse collect:#label

    "Created: / 20-10-2017 / 11:30:07 / cg"

!

level

    "get the nesting level"

    |p lvl|

    lvl := 1.

    p  := self.

    [ (p := p parent) notNil ] whileTrue:[ lvl := lvl + 1 ].

    ^ lvl

    "Modified (comment): / 04-02-2017 / 20:25:22 / cg"

!

middleButtonMenu

    "returns the middleButtonMenu of the item or nil"

    ^ nil

    "Modified (comment): / 04-02-2017 / 20:25:04 / cg"

!

name

    "get name

    "   

    name isNil ifTrue:[    

        self retrieveLabel

    ].

    ^name

!

name:aString

    name := aString.

!

parent

    "get parent

    "

    ^ parent

!

parent:something

    "set parent

    "

    parent := something.

!

string

    ^ self contents asString

    "Created: / 03-08-2017 / 16:49:05 / cg"

!

value

    "get contents

    "

    ^ self contents

!

value:something 

    "allow TreeItem to be used as a model"

    self contents:something

! !

!TreeItem methodsFor:'accessing-children'!

basicLastChild

    "returns the last child without checking for valid sequence

    "

    ^ children last

!

children

    "get list of children

    "

    "/ readChildren is actually: "MUSTreadChildren" - bad naming

    (readChildren and:[children isEmpty]) ifTrue:[       

        self retrieveChildren

    ].

    ^children

    "Modified (comment): / 04-08-2017 / 14:15:08 / cg"

!

children:aCollection 

    "set children

    "

    aCollection isNil ifTrue:[

        children removeAll

    ] ifFalse:[

        aCollection notNil ifTrue:[

            aCollection do:[:child| child parent:self ].

            "/ readChildren is actually: "MUSTreadChildren" - bad naming

            readChildren := false

        ].

        children := aCollection

    ]

    "Modified (comment): / 04-08-2017 / 14:15:13 / cg"

!

firstChild

    "returns first child in sequence

    "

    self children notEmpty ifTrue:[

        ^ children at:1

    ].

    ^ nil

!

lastChild

    "returns the last child in sequence"

    self children notEmpty ifTrue:[

        ^ children last

    ].

    ^ nil

!

readChildren:aBoolean

   "set MUSTread children flag

   "    

    "/ readChildren is actually: "MUSTreadChildren" - bad naming

   readChildren:= aBoolean

    "Modified (comment): / 04-08-2017 / 14:15:25 / cg"

! !

!TreeItem methodsFor:'accessing-dimensions'!

childrenWidthOn:aDevice

    "returns the maximum name length of my children

    "

    |max name|

    max := 0.

    children do:[:aChild|

        (name := aChild name) notNil ifTrue:[

            max := max max:(name widthOn:aDevice)

        ]

    ].

    ^ max

! !

!TreeItem methodsFor:'accessing-hierarchy'!

allParents

    "return a collection of all parents (in parent, grandparent, ... order)"

    |parents|

    parents := OrderedCollection new.

    self parentsDo:[:p | parents add:p].

    ^ parents.

    "Created: / 20-10-2017 / 11:31:06 / cg"

!

collapse 

    "hide all my children

    "

    hide := true

!

collapseAll 

    "hide all my children and sub children

    "

    hide := true.

    children notEmpty ifTrue:[

        children do:[:aChild| aChild collapseAll]

    ]

!

expand

    "show all my children

    "

    hide := false

!

expandAll 

    "show all my children and sub children

    "

    hide := false.