"

 COPYRIGHT (c) 2004 by eXept Software AG

              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:libtool' }"

"{ NameSpace: Tools }"

NavigatorModel subclass:#BrowserList

	instanceVariableNames:'menuHolder inGeneratorHolder outGeneratorHolder

		selectionChangeCondition immediateUpdate doubleClickChannel

		filter updateTrigger forceGeneratorTrigger hideUnloadedClasses

		showClassPackages selectionHolder packageFilter nameSpaceFilter

		organizerMode slaveMode listValid pseudoListLabelHolder icons

		sortBy autoSelect showAllClassesInNameSpaceOrganisation

		nameFilter showCoverageInformation searchHandler

		autoUpdateOnChange loadInProgress'

	classVariableNames:'SynchronousUpdate Icons'

	poolDictionaries:''

	category:'Interface-Browsers-New'

!

Object subclass:#SearchHandler

	instanceVariableNames:'listView listViewVisualBlock listViewSelectedVisualBlock

		listHolder listSelectionHolder searchField searchWindow

		searchHolder nextDelegate'

	classVariableNames:''

	poolDictionaries:''

	privateIn:BrowserList

!

!BrowserList class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 2004 by eXept Software AG

              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

"

    embeddable application displaying a browser's list.

    I am a pluggable component, which gets an input collection

    (typically a generator/iterator), which tells me what to display

    in the list.

    When an item is selected, I provides a similar outputGenerator, 

    which enumerates the selected sub-items.

    Concrete subclasses exist, to present lists of:

        class-categories (and generate a list of classes),

        packages (and generate a list of classes),

        namespaces (generates a list of classes),

        classes (and generate a list of methods+method category,

        method-categories (and generate a list of methods),

        methods

    [author:]

        Claus Gittinger (cg@exept.de)

    [instance variables:]

        can someone please write a  few words here...

        menuHolder 

        inGeneratorHolder 

        outGeneratorHolder

        selectionChangeCondition 

        immediateUpdate 

        doubleClickChannel

        filter                          a filterblock by the one who embedds this

        updateTrigger 

        forceGeneratorTrigger 

        hideUnloadedClasses

        showClassPackages 

        selectionHolder 

        packageFilter 

        nameSpaceFilter

        organizerMode 

        slaveMode                       I am just following passively (used for hidden

                                        organized lists (for example: package list, while hidden

                                        when another mode is active, to prevent it from sending

                                        out change requests etc.)

        listValid 

        pseudoListLabelHolder 

        icons

        sortBy 

        autoSelect 

        showAllClassesInNameSpaceOrganisation

        nameFilter                      a string or glob pattern (from the user, if a GUI for that is present)

"

! !

!BrowserList class methodsFor:'image specs'!

checkedIcon

    "TODO: cg: ask the checkbox for its icon, to ensure a common look"

    "This resource specification was automatically generated

     by the ImageEditor of ST/X."

    "Do not manually edit this!! If it is corrupted,

     the ImageEditor may not be able to read the specification."

    "

     self checkedIcon inspect

     ImageEditor openOnClass:self andSelector:#checkedIcon

     Icon flushCachedIcons

    "

    <resource: #image>

    ^ MenuPanel iconIndicationOn

"/    ^Icon

"/        constantNamed:#'Tools::HierarchicalPackageFilterList::PackageItem class checkedIcon'

"/        ifAbsentPut:[(Depth1Image new) width: 16; height: 16; photometric:(#palette); bitsPerSample:(#[1]); samplesPerPixel:(1); bits:(ByteArray fromPackedString:'@@@@@C?<O?0??C?<O?0??C?<O?07?C?<O?0??@@@@@@b') ; colorMapFromArray:#[0 0 0 33 161 33]; mask:((Depth1Image new) width: 16; height: 16; photometric:(#blackIs0); bitsPerSample:(#[1]); samplesPerPixel:(1); bits:(ByteArray fromPackedString:'

"/?????<@C0@O@D<@30GOH8<7C38OG@<HC0@O@@?????<@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

"/@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

"/@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@a') ; yourself); yourself]

    "Created: / 06-11-2008 / 16:32:46 / Jan Vrany <vranyj1@fel.cvut.cz>"

    "Modified: / 04-12-2011 / 15:35:39 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

checkedIconDisabled

    "TODO: cg: ask the checkbox for its icon, to ensure a common look"

    "This resource specification was automatically generated

     by the ImageEditor of ST/X."

    "Do not manually edit this!! If it is corrupted,

     the ImageEditor may not be able to read the specification."

    "

     self checkedIcon inspect

     ImageEditor openOnClass:self andSelector:#checkedIcon

     Icon flushCachedIcons

    "

    <resource: #image>

    ^ MenuPanel iconIndicationDisabledOn

"/    ^Icon

"/        constantNamed:#'Tools::HierarchicalPackageFilterList::PackageItem class checkedIcon'

"/        ifAbsentPut:[(Depth1Image new) width: 16; height: 16; photometric:(#palette); bitsPerSample:(#[1]); samplesPerPixel:(1); bits:(ByteArray fromPackedString:'@@@@@C?<O?0??C?<O?0??C?<O?07?C?<O?0??@@@@@@b') ; colorMapFromArray:#[0 0 0 33 161 33]; mask:((Depth1Image new) width: 16; height: 16; photometric:(#blackIs0); bitsPerSample:(#[1]); samplesPerPixel:(1); bits:(ByteArray fromPackedString:'

"/?????<@C0@O@D<@30GOH8<7C38OG@<HC0@O@@?????<@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

"/@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

"/@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@a') ; yourself); yourself]

    "Created: / 08-10-2014 / 22:53:49 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

nameSpaceIcon

    ^ SystemBrowser nameSpaceIcon

!

packageIcon

    ^ SystemBrowser packageIcon

!

padLockBlueMiniIcon

    ^ SystemBrowser padLockBlueMiniIcon

!

padLockGrayMiniIcon

    ^ SystemBrowser padLockGrayMiniIcon

!

padLockGreenMiniIcon

    ^ SystemBrowser padLockGreenMiniIcon

!

padLockRedMiniIcon

    ^ SystemBrowser padLockRedMiniIcon

!

programImageIcon

    ^ SystemBrowser programImageIcon

!

protectedMethod

    ^ self padLockRedMiniIcon

!

redLockIcon

    ^ SystemBrowser redLockIcon

!

uncheckedIcon

    "TODO: cg: ask the checkbox for its icon, to ensure a common look"

    "This resource specification was automatically generated

     by the ImageEditor of ST/X."

    "Do not manually edit this!! If it is corrupted,

     the ImageEditor may not be able to read the specification."

    "

     self uncheckedIcon inspect

     ImageEditor openOnClass:self andSelector:#uncheckedIcon

     Icon flushCachedIcons

    "

    <resource: #image>

    ^Icon

        constantNamed:'Tools::BrowserList uncheckedIcon'

        ifAbsentPut:[(Depth8Image new) width:13; height:13; bits:(ByteArray fromPackedString:'

G!!8^G!!8^G!!8^G!!8^G!!8,KB0,KB0,KB0,KA8^KA@PDA@PDCT)HR0^G"0PJ"(*J \QLR4,G!!8,DB(*@RX3E TUKA8^KA@4L <1F"8CHB0^G"00DQ$[@2\SD0$,

G!!8,IQXW@"LLC@0_KA8^K@8\H!!LLKAH,K20^G"0XH!!LTKB (JBP,G!!8,J04@A@ JA ,]KA8^KB0,KB0,KB0,KB0^G!!8^G!!8^G!!8^G!!8^G @a') ; colorMapFromArray:#[219 219 220 205 209 214 234 234 234 232 232 232 224 225 225 226 227 228 235 236 236 208 211 216 230 231 231 212 213 214 234 235 235 235 235 236 242 242 242 212 212 213 188 191 194 212 215 219 174 179 185 213 216 220 245 245 245 237 237 237 240 240 240 198 199 200 221 223 225 228 229 229 194 196 198 218 220 223 225 226 227 224 225 227 227 228 229 233 233 234 142 143 143 220 221 222 204 205 205 187 190 193 233 233 233 239 239 239 230 230 230 184 187 191 210 213 218 236 236 236 246 246 246 180 185 189 203 207 213 202 203 204 244 244 244 193 195 197 229 230 230 225 226 226 178 183 188 219 221 223 208 212 217 216 219 222 205 209 215 175 180 186]; yourself]

!

uncheckedIconDisabled

    "TODO: cg: ask the checkbox for its icon, to ensure a common look"

    "This resource specification was automatically generated

     by the ImageEditor of ST/X."

    "Do not manually edit this!! If it is corrupted,

     the ImageEditor may not be able to read the specification."

    "

     self uncheckedIconDisabled inspect

     ImageEditor openOnClass:self andSelector:#uncheckedIconDisabled

     Icon flushCachedIcons

    "

    <resource: #image>

    ^Icon

        constantNamed:'Tools::BrowserList uncheckedIconDisabled'

        ifAbsentPut:[(Depth8Image new) width:13; height:13; bits:(ByteArray fromPackedString:'

LC@0LC@0LC@0LC@0LC@GA0\GA0\GA0\GA3@0A2H"H"H"H!!@DL0\0L@\"APTEAQ #C@ GLC@GH TED D]JAX''A3@0A2HOCRDLK@$TL \0L@\KH2,-E@H%IQ(G

LC@G@B )D3T^G!!81A3@0A2@.MBT^A2PGB \0L@\*MBT&A0LC@08GLC@GA!!<QEQ$[E10/A3@0A0\GA0\GA0\GA0\0LC@0LC@0LC@0LC@0L@@a') ; colorMapFromArray:#[184 187 191 210 213 218 236 236 236 246 246 246 180 185 189 203 207 213 202 203 204 244 244 244 193 195 197 229 230 230 225 226 226 178 183 188 219 221 223 208 212 217 230 230 230 205 209 215 175 180 186 219 219 220 205 209 214 234 234 234 232 232 232 224 225 225 226 227 228 235 236 236 208 211 216 230 231 231 212 213 214 234 235 235 235 235 236 216 219 222 242 242 242 212 212 213 188 191 194 212 215 219 174 179 185 213 216 220 245 245 245 237 237 237 240 240 240 198 199 200 221 223 225 228 229 229 194 196 198 218 220 223 225 226 227 224 225 227 227 228 229 233 233 234 142 143 143 220 221 222 204 205 205 187 190 193 233 233 233 239 239 239]; yourself]

! !

!BrowserList class methodsFor:'queries'!

isAbstract

    ^ self == Tools::BrowserList

! !

!BrowserList methodsFor:'accessing'!

nameFilter:something

    nameFilter := something.

! !

!BrowserList methodsFor:'aspects'!

autoUpdateOnChange

    "automatic update of the list, when the system changes.

     For some (slow) search lists (such as string-search), autoupdate is

     disabled as it would otherwise make the browser unusable.

     Those lists need an explicit menu-update action."

    ^ autoUpdateOnChange ? true.

    "Modified: / 24-02-2000 / 23:57:13 / cg"

    "Created: / 15-05-2012 / 11:16:07 / cg"

!

autoUpdateOnChange: aBoolean

    "automatic update of the list, when the system changes.

     For some (slow) search lists (such as string-search), autoupdate is

     disabled as it would otherwise make the browser unusable.

     Those lists need an explicit menu-update action."

    autoUpdateOnChange := aBoolean

    "Modified: / 24-02-2000 / 23:57:13 / cg"

    "Created: / 15-05-2012 / 11:17:18 / cg"

!

defaultSlaveModeValue

    ^ nil.

    "Created: / 25.2.2000 / 22:36:40 / cg"

!

doubleClickChannel

    doubleClickChannel isNil ifTrue:[

	doubleClickChannel := TriggerValue new.

    ].

    ^ doubleClickChannel.

    "Modified: / 31.1.2000 / 00:42:44 / cg"

    "Created: / 5.2.2000 / 22:38:32 / cg"

!

doubleClickChannel:aChannel

    doubleClickChannel := aChannel

!

filter:aValueHolder

    filter notNil ifTrue:[

	filter removeDependent:self

    ].

    filter := aValueHolder.

    filter notNil ifTrue:[

	filter addDependent:self

    ].

    "Modified: / 4.2.2000 / 23:29:30 / cg"

    "Created: / 5.2.2000 / 13:42:12 / cg"

!

forceGeneratorTrigger

    forceGeneratorTrigger isNil ifTrue:[

	forceGeneratorTrigger := TriggerValue new.

	forceGeneratorTrigger addDependent:self.

    ].

    ^ forceGeneratorTrigger.

    "Modified: / 18.2.2000 / 02:02:52 / cg"

    "Created: / 18.2.2000 / 02:46:40 / cg"

!

forceGeneratorTrigger:aTriggerValue

    forceGeneratorTrigger notNil ifTrue:[

	forceGeneratorTrigger removeDependent:self

    ].

    forceGeneratorTrigger := aTriggerValue.

    forceGeneratorTrigger notNil ifTrue:[

	forceGeneratorTrigger addDependent:self

    ].

    "Modified: / 4.2.2000 / 23:29:30 / cg"

    "Created: / 18.2.2000 / 02:46:52 / cg"

!

hideUnloadedClasses

    hideUnloadedClasses isNil ifTrue:[

        hideUnloadedClasses := ValueHolder with:false.

        hideUnloadedClasses addDependent:self.

    ].

    ^ hideUnloadedClasses.

    "Modified: / 18.2.2000 / 02:02:52 / cg"

    "Created: / 18.2.2000 / 17:36:30 / cg"

!

hideUnloadedClasses:aValueHolder

    hideUnloadedClasses notNil ifTrue:[

	hideUnloadedClasses removeDependent:self

    ].

    hideUnloadedClasses := aValueHolder.

    hideUnloadedClasses notNil ifTrue:[

	hideUnloadedClasses addDependent:self

    ].

    "Modified: / 4.2.2000 / 23:29:30 / cg"

    "Created: / 18.2.2000 / 17:46:36 / cg"

!

menuHolder

    ^ menuHolder

    "Created: / 5.2.2000 / 13:42:06 / cg"

!

menuHolder:aValueHolder

    menuHolder := aValueHolder.

    "Created: / 5.2.2000 / 13:42:06 / cg"

!

nameSpaceFilter

    nameSpaceFilter isNil ifTrue:[

	nameSpaceFilter := ValueHolder new.

	nameSpaceFilter addDependent:self.

    ].

    ^ nameSpaceFilter.

    "Modified: / 24.2.2000 / 23:57:13 / cg"

    "Created: / 18.8.2000 / 14:18:56 / cg"

!

nameSpaceFilter:aValueHolder

    nameSpaceFilter notNil ifTrue:[

	nameSpaceFilter removeDependent:self

    ].

    nameSpaceFilter := aValueHolder.

    nameSpaceFilter notNil ifTrue:[

	nameSpaceFilter addDependent:self

    ].

    "Modified: / 24.2.2000 / 23:56:22 / cg"

    "Created: / 18.8.2000 / 14:19:06 / cg"

!

organizerMode

    organizerMode isNil ifTrue:[

        organizerMode := OrganizerCanvas organizerModeCategory asValue.

        organizerMode addDependent:self.

    ].

    ^ organizerMode

    "Modified: / 31.1.2000 / 00:51:06 / cg"

    "Created: / 25.2.2000 / 22:36:15 / cg"

!

organizerMode:aValueHolder

    organizerMode notNil ifTrue:[

	organizerMode removeDependent:self

    ].

    organizerMode := aValueHolder.

    organizerMode notNil ifTrue:[

	organizerMode addDependent:self

    ].

    "Modified: / 4.2.2000 / 23:34:28 / cg"

    "Created: / 25.2.2000 / 22:36:28 / cg"

!

packageFilter

    packageFilter isNil ifTrue:[

	packageFilter := ValueHolder new.

	packageFilter addDependent:self.

"/ debug-check only

"/ packageFilter onChangeEvaluate:[packageFilter value isValueModel ifTrue:[self halt:'debug halt']].

    ].

    ^ packageFilter.

    "Modified: / 18.8.2000 / 19:26:36 / cg"

!

packageFilter:aValueHolder

    packageFilter notNil ifTrue:[

	packageFilter removeDependent:self

    ].

    packageFilter := aValueHolder.

    packageFilter notNil ifTrue:[

	packageFilter addDependent:self.

"/ debug-check only

"/ packageFilter onChangeEvaluate:[packageFilter value isValueModel ifTrue:[self halt:'debug halt']].

    ].

    "Modified: / 18.8.2000 / 19:26:40 / cg"

!

pseudoListLabelHolder

    pseudoListLabelHolder isNil ifTrue:[

        pseudoListLabelHolder := ValueHolder with:''.

    ].

    ^ pseudoListLabelHolder

!

selectionChangeCondition:aBlockOrValueHolder

    selectionChangeCondition := aBlockOrValueHolder

!

selectionHolder

    selectionHolder isNil ifTrue:[

	selectionHolder := ValueHolder new.

	selectionHolder addDependent:self

    ].

    ^ selectionHolder.

!

selectionHolder:aValueHolder

    |prevSelection|

    prevSelection := selectionHolder value ? #().

    selectionHolder notNil ifTrue:[

	selectionHolder removeDependent:self

    ].

    selectionHolder := aValueHolder.

    selectionHolder notNil ifTrue:[

	selectionHolder addDependent:self

    ].

    (selectionHolder value ? #()) ~= prevSelection ifTrue:[

	"/ update

	self update:#value with:nil from:selectionHolder

    ].

!

showAllClassesInNameSpaceOrganisation

    ^[

        |holder|

        showAllClassesInNameSpaceOrganisation notNil ifTrue:[

            holder := showAllClassesInNameSpaceOrganisation

        ] ifFalse:[

            masterApplication notNil ifTrue:[

                holder := masterApplication perform:#showAllClassesInNameSpaceOrganisation ifNotUnderstood:nil.

            ].

            holder notNil ifTrue:[

                holder addDependent:self.

            ] ifFalse:[

                showAllClassesInNameSpaceOrganisation isNil ifTrue:[

                    showAllClassesInNameSpaceOrganisation := ValueHolder with:false.

                    showAllClassesInNameSpaceOrganisation addDependent:self.

                ].

                holder := showAllClassesInNameSpaceOrganisation.

            ].

        ].

        holder value

    ].