"

stx:goodies/smallsense - A productivity plugin for Smalltalk/X IDE

Copyright (C) 2013-2014 Jan Vrany

This library is free software; you can redistribute it and/or

modify it under the terms of the GNU Lesser General Public

License as published by the Free Software Foundation; either

version 2.1 of the License.

This library is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public

License along with this library; if not, write to the Free Software

Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

"

"{ Package: 'stx:goodies/smallsense' }"

"{ NameSpace: SmallSense }"

AbstractDIalog subclass:#AbstractListDialog

	instanceVariableNames:'matchingObjects matchingObjectsView matchingObjectsMultiselect

		matchingObjectsTree matchingObjectsSelectionHolder

		matchingObjectsLabelHolder matchingObjectsUpdateJob

		matchPatternHolder matchPatternView environmentHolder

		filterHolder filter'

	classVariableNames:''

	poolDictionaries:''

	category:'SmallSense-Core-Interface-Search'

!

!AbstractListDialog class methodsFor:'documentation'!

copyright

"

stx:goodies/smallsense - A productivity plugin for Smalltalk/X IDE

Copyright (C) 2013-2014 Jan Vrany

This library is free software; you can redistribute it and/or

modify it under the terms of the GNU Lesser General Public

License as published by the Free Software Foundation; either

version 2.1 of the License.

This library is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public

License along with this library; if not, write to the Free Software

Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

"

! !

!AbstractListDialog class methodsFor:'interface specs-content'!

contentPaneSpec

    "This resource specification was automatically generated

     by the UIPainter of ST/X."

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

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

    "

     UIPainter new openOnClass:SmallSense::AbstractSearchDialog andSelector:#contentPaneSpec

     SmallSense::AbstractSearchDialog new openInterface:#contentPaneSpec

    "

    <resource: #canvas>

    ^

    #(FullSpec

       name: contentPaneSpec

       window:

      (WindowSpec

         label: 'Search...'

         name: 'Search...'

         min: (Point 10 10)

         bounds: (Rectangle 0 0 708 404)

         menu: mainMenuSpec

       )

       component:

      (SpecCollection

         collection: (

          (VerticalPanelViewSpec

             name: 'Content'

             layout: (LayoutFrame 0 0 0 0 0 1 0 1)

             horizontalLayout: fit

             verticalLayout: topSpaceFit

             component:

            (SpecCollection

               collection: (

                (ViewSpec

                   name: 'Box1'

                   component:

                  (SpecCollection

                     collection: (

                      (LabelSpec

                         label: 'Enter name prefix or pattern (*):'

                         name: 'PatternLabel'

                         layout: (LayoutFrame 0 0 0 0 -100 1 0 1)

                         translateLabel: true

                         adjust: left

                       )

                      (UISubSpecification

                         name: 'SubSpecification1'

                         layout: (LayoutFrame -100 1 0 0 0 1 0 1)

                         visibilityChannel: hasOptions

                         minorKey: optionsShowHideRightAlignedPaneSpec

                       )

                      )

                   )

                   extent: (Point 708 30)

                 )

                (InputFieldSpec

                   name: 'Pattern'

                   model: matchPatternHolder

                   immediateAccept: true

                   acceptOnReturn: true

                   acceptOnTab: true

                   acceptOnPointerLeave: true

                   entryCompletionBlock: matchPatternCompletionBlock

                   extent: (Point 706 25)

                   postBuildCallback: postBuildMatchPatternView:

                   usePreferredHeight: true

                 )

                (LabelSpec

                   label: 'Matching items:'

                   name: 'MatchingLabel'

                   translateLabel: true

                   labelChannel: matchingObjectsLabelHolder

                   adjust: left

                   extent: (Point 708 25)

                 )

                (HierarchicalListViewSpec

                   name: 'HierarchicalListView1'

                   model: matchingObjectsSelectionHolder

                   hasHorizontalScrollBar: true

                   hasVerticalScrollBar: true

                   listModel: matchingObjectsTree

                   multipleSelectOk: true

                   useIndex: false

                   highlightMode: line

                   doubleClickSelector: doAcceptByDoubleClick

                   selectConditionSelector: canSelectIndex:

                   showLines: false

                   showIndicators: false

                   showLeftIndicators: false

                   useDefaultIcons: false

                   showRoot: false

                   extent: (Point 708 302)

                   postBuildCallback: postBuildMatchingObjectsView:

                 )

                )

             )

           )

          )

       )

     )

! !

!AbstractListDialog class methodsFor:'queries'!

isAbstract

    "Return if this class is an abstract class.

     True is returned here for myself only; false for subclasses.

     Abstract subclasses must redefine again."

    ^ self == SmallSense::AbstractListDialog.

! !

!AbstractListDialog methodsFor:'accessing'!

environment

    ^ self environmentHolder value

    "Created: / 22-04-2014 / 10:45:56 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

environment: aJavaClassEnvironment

    ^self environmentHolder value: aJavaClassEnvironment

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

!

filter

    ^self filterHolder value.

    "Created: / 11-03-2013 / 17:37:36 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

filter: aBlock

    self filterHolder value: aBlock

    "Created: / 10-05-2014 / 00:41:50 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

matchingObjectsSelection

    ^ self matchingObjectsSelectionHolder value

    "Created: / 10-05-2014 / 00:47:53 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

matchingObjectsSelection: selection

    self matchingObjectsSelectionHolder value: selection withoutNotifying:self.

    self updateAcceptEnabled.

    "Created: / 02-05-2014 / 12:26:27 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 25-11-2014 / 13:59:52 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

multiselect

    ^ matchingObjectsMultiselect

    "Created: / 10-05-2014 / 11:22:04 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

multiselect: aBoolean

    matchingObjectsMultiselect := aBoolean.

    matchingObjectsView notNil ifTrue:[

        matchingObjectsView multipleSelectOk: aBoolean

    ].

    "Created: / 10-05-2014 / 11:22:32 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

pattern

    ^self matchPatternHolder value.

    "Created: / 11-03-2013 / 14:39:44 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

pattern: aString

    ^self matchPatternHolder value: aString

    "Created: / 11-03-2013 / 15:21:24 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

selection: selection

    | matchingObjectsSelection |

    matchingObjectsMultiselect ifTrue:[

        matchingObjectsSelection := selection collect:[ :each | matchingObjectsTree root recursiveDetect: [ :po | po subject = each ] ].

        matchingObjectsSelection := matchingObjectsSelection reject:[:each | each isNil ].

    ] ifFalse:[

        matchingObjectsSelection := matchingObjectsTree root recursiveDetect: [ :po | po subject = selection ]

    ].

    self matchingObjectsSelection: matchingObjectsSelection.

    "Created: / 10-05-2014 / 00:50:32 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 10-05-2014 / 11:42:17 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

title

    ^ self titleHolder value.

    "Created: / 05-05-2014 / 23:35:55 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

title: aString

    | title |

    title := aString.

    (title includes: Character cr) ifTrue:[

        title := title upTo:Character cr.

    ].

    self titleHolder value: title

    "Created: / 05-05-2014 / 23:36:03 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 10-05-2014 / 01:22:15 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!AbstractListDialog methodsFor:'accessing - private'!

matchingObjectForString: aString

    "Creates a new object from given string. Called only when

     #canCreateMatchingObjectFromString: returns true"

    (self canCreateMatchingObjectFromString:aString) ifFalse:[

        self shouldNeverBeSent

    ] ifTrue:[

        self subclassResponsibility

    ]

    "Created: / 23-06-2014 / 15:20:45 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!AbstractListDialog methodsFor:'accessing-defaults'!

defaultTitle

    ^ (resources string: 'Search...')

    "Created: / 05-05-2014 / 23:39:23 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!AbstractListDialog methodsFor:'aspects'!

environmentHolder

    "return/create the 'registryHolder' value holder (automatically generated)"

    environmentHolder isNil ifTrue:[

        environmentHolder := Smalltalk asValue.

        environmentHolder addDependent:self.

    ].

    ^ environmentHolder

    "Created: / 22-04-2014 / 10:45:15 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 28-04-2014 / 00:04:14 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

environmentHolder:something

    "set the 'registryHolder' value holder (automatically generated)"

    |oldValue newValue|

    environmentHolder notNil ifTrue:[

        oldValue := environmentHolder value.

        environmentHolder removeDependent:self.

    ].

    environmentHolder := something.

    environmentHolder notNil ifTrue:[

        environmentHolder addDependent:self.

    ].

    newValue := environmentHolder value.

    oldValue ~~ newValue ifTrue:[

        self update:#value with:newValue from:environmentHolder.

    ].

    "Created: / 22-04-2014 / 10:45:25 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

filterHolder

    "return/create the 'filterHolder' value holder (automatically generated)"

    filterHolder isNil ifTrue:[

        filterHolder := ValueHolder new.

        filterHolder addDependent:self.

    ].

    ^ filterHolder

!

filterHolder:something

    "set the 'filterHolder' value holder (automatically generated)"

    |oldValue newValue|

    filterHolder notNil ifTrue:[

        oldValue := filterHolder value.

        filterHolder removeDependent:self.

    ].

    filterHolder := something.

    filterHolder notNil ifTrue:[

        filterHolder addDependent:self.

    ].

    newValue := filterHolder value.

    oldValue ~~ newValue ifTrue:[

        self update:#value with:newValue from:filterHolder.

    ].

!

matchPatternCompletionBlock

    ^ [ :contents :field |

        | completion |

        (contents notEmptyOrNil and:[ matchingObjectsUpdateJob running not]) ifTrue:[

            field topView withCursor:(Cursor questionMark) do:[

                completion := self matchPatternCompletionFor: contents

            ].

        ].

        completion notNil ifTrue:[

            field contents: completion first.

            completion second size == 1 ifTrue:[

                matchingObjectsMultiselect ifTrue:[

                    self matchingObjectsSelection: completion second asArray

                ] ifFalse:[

                    self matchingObjectsSelection: completion second anElement.

                ].

            ].

        ] ifFalse:[

            matchingObjectsView flash.

        ]

    ]

    "Created: / 28-04-2014 / 22:30:06 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 20-06-2014 / 14:12:08 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

matchPatternHolder

    <resource: #uiAspect>

    matchPatternHolder isNil ifTrue:[

        matchPatternHolder := ValueHolder new.

    ].

    ^ matchPatternHolder.

    "Modified: / 25-11-2014 / 13:52:37 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

matchingObjectsLabelHolder

    <resource: #uiAspect>

    "automatically generated by UIPainter ..."

    "*** the code below creates a default model when invoked."

    "*** (which may not be the one you wanted)"

    "*** Please change as required and accept it in the browser."

    "*** (and replace this comment by something more useful ;-)"

    matchingObjectsLabelHolder isNil ifTrue:[

        matchingObjectsLabelHolder := ValueHolder with:(resources string:'Matching items:').

"/ if your app needs to be notified of changes, uncomment one of the lines below:

"/       matchingLabelHolder addDependent:self.

"/       matchingLabelHolder onChangeSend:#matchingLabelHolderChanged to:self.

    ].

    ^ matchingObjectsLabelHolder.

    "Created: / 28-04-2014 / 22:29:11 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

matchingObjectsSelectionHolder

    "return/create the 'matchingClassesSelectionHolder' value holder (automatically generated)"

    matchingObjectsSelectionHolder isNil ifTrue:[

        matchingObjectsSelectionHolder := ValueHolder new.

        matchingObjectsSelectionHolder addDependent:self.

    ].

    ^ matchingObjectsSelectionHolder

    "Modified: / 08-03-2013 / 14:05:28 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

matchingObjectsSelectionHolder:something

    "set the 'matchingClassesSelectionHolder' value holder (automatically generated)"

    matchingObjectsSelectionHolder := something.

!

matchingObjectsTree

    <resource: #uiAspect>

    matchingObjectsTree isNil ifTrue:[

        matchingObjectsTree := HierarchicalList new.

        matchingObjectsTree showRoot:false.

        matchingObjectsTree root:(HierarchicalItem new).

        matchingObjectsTree application:self.

        self updateNoResults:matchingObjectsTree root.

    ].

    ^ matchingObjectsTree.

    "Created: / 08-03-2013 / 15:40:18 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 27-04-2014 / 23:41:52 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!AbstractListDialog methodsFor:'aspects-queries'!

hasFilter

    ^self filterHolder value notNil

    "Created: / 08-03-2013 / 15:43:58 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 11-03-2013 / 17:34:22 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!AbstractListDialog methodsFor:'change & update'!

delayedUpdateMatchingObjects: matchineObjectsArg POs: matchingPOsArg

    | rootPO matchPatternString  |

    matchingObjects := matchineObjectsArg.

    rootPO := self matchingObjectsTree root.

    rootPO

        children:matchingPOsArg;

        expand.

    matchPatternString := self matchPatternHolder value.

    matchPatternString isEmptyOrNil ifTrue:[ 

        ^ self.

    ].

    matchingPOsArg size == 1 ifTrue:[

        matchingObjectsMultiselect ifTrue:[

            self matchingObjectsSelection: matchingPOsArg

        ] ifFalse:[

            self matchingObjectsSelection: matchingPOsArg anElement

        ]

    ].

    "Created: / 08-12-2014 / 02:31:57 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

update:something with:aParameter from:changedObject

    "Invoked when an object that I depend upon sends a change notification."

    changedObject == matchPatternHolder ifTrue:[

        matchingObjectsUpdateJob restart.

        ^ self.

    ].

    changedObject == matchingObjectsSelectionHolder ifTrue:[

        self updateMatchPatternHolderFromSelection.

        self updateAcceptEnabled.

        ^ self.

    ].

    changedObject == accept ifTrue:[

        accept value ifTrue:[

            self updateAcceptedValue.

        ].

        ^ self.

    ].

    changedObject == filterHolder ifTrue:[

        (filter notNil and:[filter isBlock not and:[(filter isKindOf: MessageSend) not]]) ifTrue:[filter removeDependent: self].

        filter := filterHolder value.

        (filter notNil and:[filter isBlock not and:[(filter isKindOf: MessageSend) not]]) ifTrue:[filter addDependent: self].

        "/ Only do this after window is opened....

        (self builder notNil and:[ self builder window notNil  ]) ifTrue:[

            matchingObjectsUpdateJob restart.

        ].

         ^ self.

    ]    .

    changedObject == filter ifTrue:[

        matchingObjectsUpdateJob restart.

    ].

    super update:something with:aParameter from:changedObject

    "Modified: / 08-12-2014 / 02:35:55 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

updateAcceptEnabled

    self acceptEnabledHolder value: