"

 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 }"

Model subclass:#SelectionInTree

	instanceVariableNames:'root list selection showRoot contentsAction labelAction

		childrenAction iconAction indicatorList indicatorTask accessLock'

	classVariableNames:''

	poolDictionaries:''

	category:'Interface-Support-Models'

!

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

"

    list and selection holder for hierarchical list structures. 

    Used to buildup file-trees, class trees etc.

    Especially suited for use with SelectionInTreeView.

    Notice: this class replaces SelectionInHierarchy, 

            which provides similar (but less sophisticated) functionality.

    [See also:]

        TreeItem

        SelectionInTreeView

        SelectionInHierarchy

    [Author:]

        W. Olberding

        Claus Atzkern

"

! !

!SelectionInTree class methodsFor:'instance creation'!

new

    ^ self basicNew initialize

! !

!SelectionInTree class methodsFor:'defaults'!

defaultItemClass

    "returns the default item class or nil (the default)"

    ^ nil

    "Modified (comment): / 04-02-2017 / 19:48:09 / cg"

! !

!SelectionInTree methodsFor:'accessing'!

list

    "get the list of currently shown objects"

    ^ list

    "Modified (comment): / 04-02-2017 / 19:38:18 / cg"

!

root

    "get the root node"

    ^ root

    "Modified (comment): / 04-02-2017 / 19:40:07 / cg"

!

root:aRoot

    "set a new root"

    |tree|

    root notNil ifTrue: [

        tree := root tree.

        root tree:nil.

    ] ifFalse:[

        tree := self

    ].

    self stopRunningTasks.

    (root := aRoot) notNil ifTrue:[

        root tree:tree.

        root parent:nil.

    ].

    self recomputeList

    "Modified (comment): / 04-02-2017 / 19:40:12 / cg"

!

value

    ^ list

! !

!SelectionInTree methodsFor:'accessing hierarchy new'!

    |anchor parent|

        parent := anItem.

        anchor := nil.

        parent notNil ifTrue:[

            [(parent := parent parent) notNil] whileTrue:[

                parent hidden ifTrue:[

                    anchor notNil ifTrue:[ anchor expand ].

                    anchor := parent.

                ]

            ].

            anchor notNil ifTrue:[

                self expandItem:anchor do:[anchor expand]

            ]

        ].

    ]

! !

!SelectionInTree methodsFor:'accessing-behavior'!

childrenAction

    "get the children action block.

     This is called by tree items to retrieve the children of a node"

    ^childrenAction

    "Modified (comment): / 04-02-2017 / 19:31:38 / cg"

!

childrenAction:aBlock

    "set the children action block

     This is called by tree items to retrieve the children of a node"

    childrenAction := aBlock.

    "Modified (comment): / 04-02-2017 / 19:31:51 / cg"

!

contentsAction

    "get contents action block

     This is called by tree items to retrieve the contents of a node"

    ^contentsAction

    "Modified (comment): / 04-02-2017 / 19:32:04 / cg"

!

contentsAction:aBlock

    "set contents action block

     This is called by tree items to retrieve the contents of a node"

    contentsAction := aBlock.

    "Modified (comment): / 04-02-2017 / 19:32:09 / cg"

!

iconAction

    "get icon action block

     This is called by tree items to retrieve the icon of a node"

    ^iconAction

    "Modified (comment): / 04-02-2017 / 19:32:22 / cg"

!

iconAction:aBlock

    "set icon action block

     This is called by tree items to retrieve the icon of a node"

    iconAction := aBlock.

    "Modified (comment): / 04-02-2017 / 19:32:17 / cg"

!

labelAction

    "get label action block

     This is called by tree items to retrieve the label of a node"

    ^labelAction

    "Modified (comment): / 04-02-2017 / 19:32:27 / cg"

!

labelAction:aBlock

    "set label action block

     This is called by tree items to retrieve the label of a node"

    labelAction := aBlock.

    "Modified (comment): / 04-02-2017 / 19:32:35 / cg"

!

showRoot

    "controls if the list is shown with or without root.

     Notice that technically, there is always one single root item;

     however, its visibility can be suppressed to make the tree look like a list

     on the top level"

    ^ showRoot

    "Modified (comment): / 04-02-2017 / 19:33:45 / cg"

!

showRoot:aBoolean

    "controls if the list is shown with or without root.

     Notice that technically, there is always one single root item;

     however, its visibility can be suppressed to make the tree look like a list

     on the top level"

    aBoolean ~~ showRoot ifTrue:[

        showRoot := aBoolean.

        root notNil ifTrue:[

            aBoolean ifTrue:[

                list addFirst:root.

                self changed:#insertCollection: with:(Array with:1 with:1 with:nil).

            ] ifFalse:[

                list removeFirst.

                self changed:#removeFrom: with:(Array with:1 with:1 with:nil).

            ].

        ].

    ].

    "Modified (format): / 04-02-2017 / 21:34:26 / cg"

! !

!SelectionInTree methodsFor:'accessing-hierarchy'!

collapse:something 

    "collapse a node or collection of nodes"

    |listChanged|

    listChanged := false.

    self each:something do:[:aNode|

        aNode isCollapsable ifTrue:[

            aNode collapse.

            listChanged := true

        ]

    ].

    listChanged ifTrue:[

        self listFromRoot.

        self changed:#list.

    ]

    "Modified (comment): / 04-02-2017 / 19:34:09 / cg"

!

expand

    "expand the root"

    self expand:root

    "Modified (comment): / 04-02-2017 / 19:34:13 / cg"

!

expand:something 

    "expand a node or collection of nodes"

    |listChanged|

    listChanged := false.

    self each:something do:[:aNode|

        aNode isExpandable ifTrue:[

            aNode expand.

            listChanged := true

        ]

    ].

    listChanged ifTrue:[

        self listFromRoot.

        self changed:#list.

    ]

    "Modified (comment): / 04-02-2017 / 19:34:17 / cg"

! !

!SelectionInTree methodsFor:'accessing-hierarchy new'!

doCollapse:something

    "collapse all children under an item or a sequence of items;

     if the list changed, a change notifications are sent"

    self each:something do:[:anItem|

        self collapseItem:anItem do:[ anItem collapse ]

    ]

    "Modified (comment): / 04-02-2017 / 19:36:30 / cg"

!

doCollapseAll:something

    "collapse all children and subChildren under an item or sequence of items;

     if the list changed, a change notifications are sent"

    self each:something do:[:anItem|

        self collapseItem:anItem do:[ anItem collapseAll ]

    ]

    "Modified (comment): / 04-02-2017 / 19:36:39 / cg"

!

doExpand:something

    "expand all children under an item or collection of items;

     if the list changed, a change notifications are sent"

    self each:something do:[:anItem|

        self expandItem:anItem do:[anItem expand]

    ]

    "Modified (comment): / 04-02-2017 / 19:36:44 / cg"

!

doExpandAll:something

    "expand all children and subChildren under an item or sequence of items;

     if the list changed, change notifications are sent"

    self each:something do:[:anItem|

        self expandItem:anItem do:[anItem expandAll]

    ]

    "Modified (comment): / 04-02-2017 / 19:36:55 / cg"

! !

!SelectionInTree methodsFor:'adding & removing'!

add:something after:aChild

    "add a node or collection of nodes to the parent of aChild

     after that child in the sublist"

    |p|

    (aChild notNil and:[(p := aChild parent) notNil]) ifTrue:[

        self add:something afterIndex:(p indexOfChild:aChild) below:p

    ]

    "Modified (comment): / 04-02-2017 / 19:35:11 / cg"

!

add:something afterIndex:anIndex below:aParent

    "add a node or collection of nodes to parent after an index

    "

    self add:something beforeIndex:(anIndex + 1) below:aParent

!

add:something before:aChild

    "add a node or collection of nodes to before a child"

    |p|

    (aChild notNil and:[(p := aChild parent) notNil]) ifTrue:[

        self add:something beforeIndex:(p indexOfChild:aChild) below:p

    ]

    "Modified (comment): / 04-02-2017 / 19:35:19 / cg"

!

add:something beforeIndex:anIndex below:aParent

    "add a node or collection of nodes to aParents children

     before anIndex (which is a child-index)"

    |children start index size pList|

    (    aParent isNil

     or:[something isNil

     or:[(something isCollection and:[something isEmpty])]]

    ) ifTrue:[

        ^ self

    ].

    (start := self indexOf:aParent) == 0 ifTrue:[

        "/

        "/ parent not visible; list not changed

        "/

        aParent == root ifFalse:[

            aParent add:something beforeIndex:anIndex.

          ^ self

        ]

    ] ifFalse:[

        aParent shown ifFalse:[

            aParent add:something beforeIndex:anIndex.

            self changed:#at: with:start.

            ^ self

        ]

    ].

    children := aParent children.

    (children isEmpty or:[anIndex <= 1]) ifTrue:[

        index := 1.

    ] ifFalse:[

        size  := children size.

        anIndex > size ifTrue:[

            index := size + 1.

            start := aParent numberOfAllVisibleChildren + start.

        ] ifFalse:[

            index := anIndex.

            start := (self indexOf:(children at:index)) - 1.

        ]

    ].

    aParent add:something beforeIndex:index.

    (start := start + 1) == 0 ifTrue:[

        "/

        "/ not visible

        "/

        ^ self

    ].

    pList := OrderedCollection new:2048.

    self each:something do:[:aNode|

        pList add:aNode.

        aNode addVisibleChildrenTo:pList

    ].

    pList isEmpty ifTrue:[

        ^ self

    ].

    list addAll:pList beforeIndex:start.

    self changed:#insertCollection:

            with:(Array with:start with:pList size with:aParent).

    "Modified (comment): / 04-02-2017 / 19:35:23 / cg"

!

add:something below:aParent

    "add a node or collection of nodes to parent"

    aParent notNil ifTrue:[

        self add:something beforeIndex:(aParent numberOfChildren + 1) below:aParent

    ]

    "Modified (comment): / 04-02-2017 / 19:35:28 / cg"

!

remove:something

    "remove a node or collection of nodes.

     Change notifications are sent"

    |node index loNums loItem start size parent stop|

    something isNil ifTrue:[

        ^ something

    ].

    loNums := SortedCollection new.

    self each:something do:[:el|

        node := el isNumber ifTrue:[list at:el ifAbsent:nil]

                           ifFalse:[el].

        node notNil ifTrue:[

            self stopIndicatorValidationFor:node.

            node parent isNil ifTrue:[

                "/ remove all including root

                node == root ifTrue:[ self root:nil ].

              ^ something

            ].

            index := self indexOf:node.