hg/stx-libwidg2: comparison HierarchicalItem.st

equal deleted inserted replaced

-:b020ebbffa8a
+:9b59aafa16d2
 getChildren
 "returns the children as they are present (or not); not going to the model..."
 ^ children
-"Modified: / 09-07-2010 / 08:43:29 / cg"
 !
 level
-"returns the level starting with 1"
+"returns the level starting with 0 for the root"
 |item level|
-"/ for optimization we try to suppress a block
+item := self.
+level := 0.
-item  := self.
+[ (item := item parentOrModel) notNil] whileTrue:[
-(item := item parentOrModel) isNil ifTrue:[^ 0].
-(item := item parentOrModel) isNil ifTrue:[^ 1].
-(item := item parentOrModel) isNil ifTrue:[^ 2].
-(item := item parentOrModel) isNil ifTrue:[^ 3].
-(item := item parentOrModel) isNil ifTrue:[^ 4].
-(item := item parentOrModel) isNil ifTrue:[^ 5].
-(item := item parentOrModel) isNil ifTrue:[^ 6].
-level := 7.
-[(item := item parentOrModel) notNil] whileTrue:[
 level := level + 1.
 level > 100000 ifTrue:[
 self halt:'possibly recursive item hierarchy'
 ].
 ].
 ^ level
-"Modified: / 09-07-2010 / 08:40:56 / cg"
+"Modified: / 09-07-2010 / 08:56:27 / cg"
 !
 parent
 "returns the parent or nil"
 ^ (parent notNil and:[parent isHierarchicalItem])
 ifTrue:[parent]
 ifFalse:[nil]
-"Modified: / 09-07-2010 / 08:36:07 / cg"
 !
 parent:aParent
 "set the parent (or the model if the item is the root item)"
 parent := aParent
-"Modified: / 09-07-2010 / 08:35:52 / cg"
 !
 rootItem
 "returns the root item"
 parent isHierarchicalItem ifTrue:[
 ^ parent rootItem
 ].
 ^ self
-"Modified: / 09-07-2010 / 08:32:41 / cg"
 ! !
 !HierarchicalItem methodsFor:'accessing-children'!
 at:anIndex
 last
 "returns the last child"
 ^ self at:(self size)
-"Modified: / 09-07-2010 / 08:41:00 / cg"
 !
 second
 "returns the second child"
 ^ self at:2
-"Modified: / 09-07-2010 / 08:32:37 / cg"
 ! !
 !HierarchicalItem methodsFor:'accessing-hierarchy'!
 collapse
 self criticalDo:[
 parent expand.
 parent makeVisible
 ]
 ].
-"Modified: / 09-07-2010 / 08:40:37 / cg"
 !
 recursiveCollapse
 "collapse all item and sub items
 **** must be expanded
 index ~~ 0 ifTrue:[self hierarchyChanged]
 ]
 ]
 ].
-"Modified: / 09-07-2010 / 08:33:58 / cg"
 !
 recursiveToggleExpand
 "if the item is collapsed, the item and all its sub-items
 are expanded otherwise collapsed"
 isExpanded ifTrue:[
 self collapse
 ] ifFalse:[
 self expand
 ].
-"Modified: / 29-06-2010 / 21:41:53 / cg"
 ! !
 !HierarchicalItem methodsFor:'accessing-mvc'!
 application
 item := next.
 ].
 item isHierarchicalItem ifFalse:[^ item].
 ^ nil
-"Modified: / 09-07-2010 / 08:40:23 / cg"
 ! !
 !HierarchicalItem methodsFor:'adding & removing'!
 add:aChildItem
 parent notNil ifTrue:[                                      "check whether parent exists"
 parent isHierarchicalItem ifTrue:[parent remove:self]   "parent is HierarchicalItem"
 ifFalse:[parent root:nil]      "parent is HierarchicalList"
 ].
 ^ self
-"Modified: / 09-07-2010 / 08:33:24 / cg"
 !
 remove:aChild
 "remove a child"
 self removeIndex:(self identityIndexOf:aChild)
-"Modified: / 09-07-2010 / 08:33:19 / cg"
 !
 removeAll
 "remove all children"
 |size|
 (size := children size) ~~ 0 ifTrue:[
 self removeFromIndex:1 toIndex:size
 ]
-"Modified: / 09-07-2010 / 08:33:12 / cg"
 !
 removeAll:aList
 "remove all children in the collection"
 ]
 ]
 ]
 ].
 ^ aList
-"Modified: / 09-07-2010 / 08:33:08 / cg"
 !
 removeFromIndex:startIndex
 "remove the children from startIndex up to end of children"
 ^ self removeFromIndex:startIndex toIndex:(children size)
-"Modified: / 09-07-2010 / 08:33:03 / cg"
 !
 removeFromIndex:startIndex toIndex:stopIndex
 "remove the children from startIndex up to and including
 the child under stopIndex."
 children size == 0 ifTrue:[
 self clearExpandedWhenLastChildWasRemoved ifTrue:[
 isExpanded := false.
 ]
 ].
-"Modified: / 09-07-2010 / 08:32:57 / cg"
 !
 removeIndex:anIndex
 "remove the child at an index"
 anIndex > 0 ifTrue:[
 self removeFromIndex:anIndex toIndex:anIndex
 ]
-"Modified: / 09-07-2010 / 08:32:53 / cg"
 ! !
 !HierarchicalItem methodsFor:'basic adding & removing'!
 basicAdd:aChild sortBlock:aBlock
 model itemAddAll:coll beforeIndex:(index + 1).
 notify notNil ifTrue:[
 notify changed
 ].
 ^ aList
 !
 basicRemoveFromIndex:startIndex toIndex:stopIndex
 "remove the children from startIndex up to and including
 the child under stopIndex."
 hierarchyChanged
 "hierarchy changed; optimize redrawing"
 self changed:#hierarchy with:nil
-"Modified: / 09-07-2010 / 08:42:30 / cg"
 !
 iconChanged
 "icon changed; optimize redrawing"
 self changed:#icon with:nil
-"Modified: / 09-07-2010 / 08:42:20 / cg"
 ! !
 !HierarchicalItem methodsFor:'enumerating'!
 collect:aBlock
 self criticalDo:[
 res := self nonCriticalFrom:startIndex to:endIndex reverseDo:aOneArgBlock
 ].
 ^ res
-"Modified: / 09-07-2010 / 08:43:36 / cg"
 !
 keysAndValuesDo:aTwoArgBlock
 "evaluate the argument, aBlock for every child,
 passing both index and element as arguments."
 self do:[:el|
 res := el value:key value:el.
 key := key + 1.
 ].
 ^ res
-"Modified: / 09-07-2010 / 08:41:15 / cg"
 !
 keysAndValuesReverseDo:aTwoArgBlock
 "evaluate the argument, aBlock in reverse order for every
 child, passing both index and element as arguments."
 self criticalDo:[
 res := self nonCriticalKeysAndValuesReverseDo:aTwoArgBlock
 ].
 ^ res
-"Modified: / 09-07-2010 / 08:41:10 / cg"
 !
 recursiveCollect:aBlock
 "for each child in the receiver, evaluate the argument, aBlock
 and return a new collection with the results"
 |coll|
 coll := OrderedCollection new.
 self recursiveDo:[:el| coll add:(aBlock value:el) ].
 ^ coll
-"Modified: / 09-07-2010 / 08:34:24 / cg"
 !
 recursiveDo:aOneArgBlock
 "evaluate a block on each item and all the sub-items"
 self do:[:aChild|
 aOneArgBlock value:aChild.
 aChild nonCriticalRecursiveDo:aOneArgBlock
 ].
-"Modified: / 09-07-2010 / 08:34:05 / cg"
 !
 recursiveReverseDo:aOneArgBlock
 "evaluate a block on each item and all the sub-items;
 proccesing children in reverse direction"
 self reverseDo:[:aChild|
 aChild nonCriticalRecursiveReverseDo:aOneArgBlock.
 aOneArgBlock value:aChild.
 ].
-"Modified: / 09-07-2010 / 08:33:52 / cg"
 !
 recursiveSelect:aBlock
 "return a new collection with all children and subChildren from the receiver, for which
 the argument aBlock evaluates to true."
 |coll|
 coll := OrderedCollection new.
 self recursiveDo:[:el| (aBlock value:el) ifTrue:[coll add:el] ].
 ^ coll
-"Modified: / 09-07-2010 / 08:33:47 / cg"
 !
 reverseDo:aOneArgBlock
 "evaluate a block on each child in reverse direction"
 ^ self from:1 reverseDo:aOneArgBlock
-"Modified: / 09-07-2010 / 08:32:48 / cg"
 !
 select:aBlock
 "return a new collection with all items from the receiver, for which
 the argument aBlock evaluates to true."
 |coll|
 coll := OrderedCollection new.
 self do:[:el| (aBlock value:el) ifTrue:[coll add:el] ].
 ^ coll
-"Modified: / 09-07-2010 / 08:32:32 / cg"
 !
 withAllDo:aOneArgBlock
 "evaluate the block on each item and subitem including self"
 self do:[:el|
 aOneArgBlock value:el.
 el nonCriticalRecursiveDo:aOneArgBlock.
 ].
-"Modified: / 09-07-2010 / 08:31:43 / cg"
 ! !
 !HierarchicalItem methodsFor:'enumerating parents'!
 parentsDetect:aBlock
 "find the first parent, for which evaluation of the block returns
 true; if none does so, report an error"
 ^ self parentsDetect:aBlock ifNone:[self errorNotFound]
-"Modified: / 09-07-2010 / 08:35:43 / cg"
 !
 parentsDetect:aBlock ifNone:anExceptionBlock
 "find the first parent, for which evaluation of the block returns
 true; if none does so, return the evaluation of anExceptionBlock"
 [(prnt := prnt parent) notNil and:[prnt isHierarchicalItem]] whileTrue:[
 (aBlock value:prnt) ifTrue:[^ prnt]
 ]
 ].
 ^ anExceptionBlock value
-"Modified: / 09-07-2010 / 08:35:37 / cg"
 !
 parentsDo:aBlock
 "evaluate a block for each parent"
 self criticalDo:[
 [(prnt := prnt parent) notNil and:[prnt isHierarchicalItem]] whileTrue:[
 aBlock value:prnt
 ]
 ].
-"Modified: / 09-07-2010 / 08:35:31 / cg"
 ! !
 !HierarchicalItem methodsFor:'initialization'!
 initialize
 (index ~~ 0 or:[parent == model]) ifTrue:[
 ^ index
 ]
 ].
 ^ nil
-"Modified: / 09-07-2010 / 08:40:50 / cg"
 !
 numberOfVisibleChildren
 "returns number of all visible children including subchildren"
 parentOrModel
 "returns the parent without checking for item or model"
 ^ parent
-"Modified: / 09-07-2010 / 08:35:48 / cg"
 !
 setExpanded:aBoolean
 "set expanded flag without any computation or notification"
 ^ h
 ].
 h := 1 + (aLabel occurrencesOf:(Character cr)).
 ^ h * (aGC font height)
-"Modified: / 09-07-2010 / 08:42:40 / cg"
 !
 widthOf:aLabel on:aGC
 "returns the height of the label or 0"
 ].
 w := 0.
 aLabel asCollectionOfLines do:[:el|w := w max:(el widthOn:aGC)].
 ^ w
-"Modified: / 09-07-2010 / 08:32:03 / cg"
 ! !
 !HierarchicalItem methodsFor:'private-enumerating'!
 nonCriticalDo:aOneArgBlock
 "evaluate a block noncritical for each child."
 ^ self nonCriticalFrom:1 to:nil do:aOneArgBlock
-"Modified: / 09-07-2010 / 08:37:57 / cg"
 !
 nonCriticalFrom:startIndex to:endIndex do:aOneArgBlock
 "evaluate a block noncritical for each child starting with the
 child at startIndex to the endIndex (if nil to end of list)."
 resp := nil.
 endIndex notNil ifTrue:[
 size := size min:endIndex
 ].
-startIndex to:size do:[:i| |item|
+startIndex to:size do:[:i|
+|item|
 item := list at:i ifAbsent:nil.
 item isNil ifTrue:[^ resp].
 resp := aOneArgBlock value:item.
 ].
 ^ resp
-"Modified: / 09-07-2010 / 08:37:50 / cg"
 !
 nonCriticalFrom:startIndex to:endIndex reverseDo:aOneArgBlock
 "evaluate a block non critical for each child starting with the
 child at endIndex (if nil to end of list) to startIndex."
 item := list at:i ifAbsent:nil.
 item isNil ifTrue:[^ resp].
 resp := aOneArgBlock value:item.
 ].
 ^ resp
-"Modified: / 09-07-2010 / 08:37:43 / cg"
 !
 nonCriticalKeysAndValuesReverseDo:aOneArgBlock
 "evaluate the argument, aBlock in reverse order for every
 child, passing both index and element as arguments."
 item := list at:i ifAbsent:nil.
 item isNil ifTrue:[^ resp].
 resp := aOneArgBlock value:i value:item.
 ].
 ^ resp
-"Modified: / 09-07-2010 / 08:37:23 / cg"
 !
 nonCriticalRecursiveDo:aOneArgBlock
 "evaluate the block non critical for each item and all the sub-items"
-self nonCriticalFrom:1 to:nil do:[:aChild|
+self nonCriticalFrom:1 to:nil do:[:eachChild|
-aOneArgBlock value:aChild.
+aOneArgBlock value:eachChild.
-aChild nonCriticalRecursiveDo:aOneArgBlock
+eachChild nonCriticalRecursiveDo:aOneArgBlock
 ].
-"Modified: / 09-07-2010 / 08:36:58 / cg"
 !
 nonCriticalRecursiveReverseDo:aOneArgBlock
 "evaluate the block non critical for each item and all the sub-items;
 proccesing children in reverse direction"
-self nonCriticalFrom:1 to:nil reverseDo:[:aChild|
+self nonCriticalFrom:1 to:nil reverseDo:[:eachChild|
-aChild nonCriticalRecursiveReverseDo:aOneArgBlock.
+eachChild nonCriticalRecursiveReverseDo:aOneArgBlock.
-aOneArgBlock value:aChild.
+aOneArgBlock value:eachChild.
 ].
-"Modified: / 09-07-2010 / 08:36:49 / cg"
 !
 nonCriticalRecursiveSort:aSortBlock
 "evaluate a block noncritical for each child."
 unsorted size ~~ 0 ifTrue:[
 sorted := unsorted sort:aSortBlock.
 sorted do:[:el| el nonCriticalRecursiveSort:aSortBlock ].
 children := sorted.
 ].
-"Modified: / 09-07-2010 / 08:36:33 / cg"
 ! !
 !HierarchicalItem methodsFor:'private-hierarchy'!
 recursiveSetCollapsed
 (model := self model) notNil ifTrue:[
 ^ model iconFor:self
 ].
 ^ nil
-"Modified: / 09-07-2010 / 08:42:25 / cg"
 !
 label
 "returns the label displayed on aGC;
 *** to optimize:redefine by subClass"
 (model := self model) notNil ifTrue:[
 ^ model labelFor:self
 ].
 ^ nil
-"Modified: / 09-07-2010 / 08:41:04 / cg"
 !
 middleButtonMenu
 "returns the items middleButtonMenu or nil if no menu is defined.
 If nil is returned, the view is asked for a menu."
 (model := self model) notNil ifTrue:[
 ^ model middleButtonMenuFor:self
 ].
 ^ nil
-"Modified: / 09-07-2010 / 08:40:32 / cg"
 !
 recursiveSortChildren:aSortBlock
 |children|
 height isNil ifTrue:[
 height := self heightOf:(self label) on:aGC
 ].
 ^ height
-"Modified: / 09-07-2010 / 08:42:35 / cg"
 !
 widthOn:aGC
 "return the width of the receiver, if it is to be displayed on aGC"
 width isNil ifTrue:[
 width := self widthOf:(self label) on:aGC
 ].
 ^ width
-"Modified: / 09-07-2010 / 08:31:53 / cg"
 ! !
 !HierarchicalItem methodsFor:'protocol-event processing'!
 processButtonPress:button x:x y:y
 "a mouse button was pressed in my label.
 Return true, if the event is eaten (ignored by the gc).
 By default, false is returned (should be handled by the gc)."
 ^ false
-"Modified: / 09-07-2010 / 08:35:22 / cg"
 !
 processButtonPress:button x:x y:y on:aGC
 "a mouse button was pressed in my label.
 Return true, if the event is eaten (ignored by the gc).
 By default, false is returned (should be handled by the gc)."
 ^ self processButtonPress:button x:x y:y
-"Modified: / 09-07-2010 / 08:35:10 / cg"
 !
 processButtonPressOnIcon:button on:aGC
 "a mouse button was pressed in my icon.
 Return true, if the event is eaten (ignored by the gc).
 By default, false is returned (should be handled by the gc)."
 ^ false
-"Modified: / 09-07-2010 / 08:35:00 / cg"
 ! !
 !HierarchicalItem methodsFor:'protocol-monitoring'!
 monitoringCycle
 "called every 'n' seconds by the model, if the monitoring
 cycle is enabled. The item can perform some checks, ..
 **** can be redefined by subclass to perform some actions
 "
-"Modified: / 09-07-2010 / 08:38:06 / cg"
 ! !
 !HierarchicalItem methodsFor:'protocol-queries'!
 canCollapse
 "checks whether the item has children;
 the list needs not to be loaded yet( example. FileDirectory ).
 *** to optimize: redefine in subClass"
 ^ self children size ~~ 0
-"Modified: / 09-07-2010 / 08:42:50 / cg"
 !
 hasIndicator
 "on default the indicator is drawn if the item has children"
 ^ self hasChildren
-"Modified: / 09-07-2010 / 08:42:46 / cg"
 !
 isSelectable
 "returns true if the item is selectable"
 ^ true
-"Modified: / 09-07-2010 / 08:41:30 / cg"
 !
 string
-"access the printable string used for steping through a list
+"access the printable string used for stepping through a list
 searching for an entry starting with a character.
 *** to optimize:redefine by subClass"
 |label|
 s notNil ifTrue:[^ s].
 ]
 ]
 ].
 ^ nil
-"Modified: / 09-07-2010 / 08:32:12 / cg"
 ! !
 !HierarchicalItem methodsFor:'queries'!
 isChildOf:anItem
 ((item := item parent) notNil and:[item isHierarchicalItem]) ifFalse:[
 ^ false
 ]
 ].
 ^ true
-"Modified: / 09-07-2010 / 08:41:58 / cg"
 !
 isCollapsed
 "returns true if the item is collapsed"
 isHierarchicalItem
 "used to decide if the parent is a hierarchical item or the model"
 ^ true
-"Modified: / 09-07-2010 / 08:41:43 / cg"
 !
 isRealChildOf:anItem
 "returns true if the item is a child of anItem"
 [item notNil] whileTrue:[
 item == anItem ifTrue:[^ true].
 item := item parent.
 ].
 ^ false
-"Modified: / 09-07-2010 / 08:41:36 / cg"
 !
 isRootItem
 "returns true if the item is the root item"
 ^ parent isHierarchicalItem not
-"Modified: / 09-07-2010 / 08:41:26 / cg"
 !
 size
 "return the number of children"
 ^ self children size
-"Modified: / 09-07-2010 / 08:32:24 / cg"
 ! !
 !HierarchicalItem methodsFor:'searching'!
 detect:aOneArgBlock
 self do:[:el|
 (aOneArgBlock value:el) ifTrue:[^ el]
 ].
 ^ exceptionBlock value
-"Modified: / 13-09-2006 / 11:17:53 / cg"
 !
 detectLast:aOneArgBlock
 "find the last child, for which evaluation of the block returns
 true; if none does so, an exception is raised"
 identityIndexOf:aChild
 "return the index of aChild or 0 if not found. Compare using =="
 ^ self identityIndexOf:aChild startingAt:1
-"Modified: / 09-07-2010 / 08:42:12 / cg"
 !
 identityIndexOf:aChild startingAt:startIndex
 "return the index of aChild, starting search at startIndex.
 Compare using ==; return 0 if not found"
 self from:startIndex do:[:el|
 el == aChild ifTrue:[^ index ].
 index := index + 1.
 ].
 ^ 0
-"Modified: / 09-07-2010 / 08:42:07 / cg"
 !
 recursiveDetect:aOneArgBlock
 "recursive find the first child, for which evaluation
 of the block returns true; if none nil is returned"
 self recursiveDo:[:aChild|
 (aOneArgBlock value:aChild) ifTrue:[^ aChild]
 ].
 ^ nil
-"Modified: / 09-07-2010 / 08:34:17 / cg"
 !
 recursiveDetectLast:aBlock
 "find the last child, for which evaluation of the block returns
 true; if none does so, nil id returned"
 self recursiveReverseDo:[:aChild|
 (aBlock value:aChild) ifTrue:[^ aChild].
 ].
 ^ nil
-"Modified: / 09-07-2010 / 08:34:12 / cg"
 !
 withAllDetect:aOneArgBlock
 "recursive find the first item including self, for which evaluation
 of the block returns true; if none nil is returned"
 (aOneArgBlock value:self) ifTrue:[^ self].
 ^ self recursiveDetect:aOneArgBlock
-"Modified: / 09-07-2010 / 08:31:47 / cg"
 ! !
 !HierarchicalItem methodsFor:'sorting & reordering'!
 recursiveSort:aSortBlock
 children size ~~ 0 ifTrue:[
 self nonCriticalRecursiveSort:aSortBlock.
 self childrenOrderChanged.
 ]
 ].
-"Modified: / 09-07-2010 / 08:33:34 / cg"
 !
 sort:aSortBlock
 "sort the children inplace using the 2-arg block sortBlock for comparison"
 unsorted size ~~ 0 ifTrue:[
 children := unsorted sort:aSortBlock.
 self childrenOrderChanged.
 ]
 ].
-"Modified: / 09-07-2010 / 08:32:19 / cg"
 ! !
 !HierarchicalItem::Example class methodsFor:'instance creation'!
 labeled:aLabel
 ! !
 !HierarchicalItem class methodsFor:'documentation'!
 version
-^ '$Header: /cvs/stx/stx/libwidg2/HierarchicalItem.st,v 1.93 2010-07-09 06:43:47 cg Exp $'
+^ '$Header: /cvs/stx/stx/libwidg2/HierarchicalItem.st,v 1.94 2010-07-09 07:00:29 cg Exp $'
 !
 version_CVS
-^ '$Header: /cvs/stx/stx/libwidg2/HierarchicalItem.st,v 1.93 2010-07-09 06:43:47 cg Exp $'
+^ '$Header: /cvs/stx/stx/libwidg2/HierarchicalItem.st,v 1.94 2010-07-09 07:00:29 cg Exp $'
 ! !

changeset 3913	9b59aafa16d2
parent 3912	b020ebbffa8a
child 3914	084e5ac32b90