"

 COPYRIGHT (c) 1994 by 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.

"

Button subclass:#PopUpList

	instanceVariableNames:'menu menuAction values useIndex listMsg defaultLabel listHolder'

	classVariableNames:''

	poolDictionaries:''

	category:'Views-Interactors'

!

!PopUpList class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1994 by 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

"

    a PopUpList is basically a button with a popup menu.

    The PopUpLists label is showing the current selection from the

    list.

    When an entry is selected, an actionBlock (if nonNil) is evaluated

    and (if nonNil), the model is notified via the changeMessage.

    If no model is set, the list is assumed to be a static list, which

    is defined via #list:, and the popUpList evaluates the action block,

    as defined via #action:.

    If a model is provided, it should return the list from the listMessage

    (default is #list) and the current selected items index via the aspectMessage

    (default is #selection or: #selectionIndex, depending on the setting of useIndex).

    The defaults are set to allows a PopUpList to be used with a SelectionInList 

    as model without further setup.

    (if used with some other model, either use an adaptor, or set the

     change/aspect and/or listMessage to something else ..)

    [Instance variables:]

        menu                            helpers for the popup menu

        menuAction 

        values 

        useIndex             <Boolean>  if true, the index of the selected entry

                                        is passed to the action block and the

                                        model in a change-message.

                                        If false (the default), the value is passed.

                                        Notice that the default changeMessage is

                                        #selection:, which is not ok to be used

                                        with useIndex:true and a selectionInList model.

                                        (set the changeMessage to #selectionIndex: then)

        listMsg              <Symbol>   message to aquire a new list from the

                                        model. Default is #list.

        listHolder           <Object>   if non-nil, this object is assumed to return the

                                        list via the listMsg (instead of the model).

                                        Default is nil.

    [see also:]

        SelectionInListView

        SelectionInList

    [author:]

        Claus Gittinger

"

!

examples

"

  non-MVC use:

                                                                        [exBegin]

     |p|

     p := PopUpList label:'healthy fruit'.

     p list:#('apples' 'bananas' 'grape' 'lemon' 'margaritas').

     p open

                                                                        [exEnd]

    with an initial selection:

                                                                        [exBegin]

     |p|

     p := PopUpList label:'dummy'.

     p list:#('apples' 'bananas' 'grape' 'lemon' 'margaritas').

     p selection:'apples'.

     p open

                                                                        [exEnd]

    with separating lines:

                                                                        [exBegin]

     |p|

     p := PopUpList label:'fruit'.

     p list:#('apples' 'bananas' 'grape' 'lemon' '-' 'margaritas').

     p selection:'apples'.

     p open

                                                                        [exEnd]

    with an action:

                                                                        [exBegin]

     |p|

     p := PopUpList label:'dummy'.

     p list:#('apples' 'bananas' 'grape' 'lemon' '-' 'margaritas').

     p selection:'apples'.

     p action:[:what | Transcript showCR:'you selected: ' , what].

     p open

                                                                        [exEnd]

    sometimes, you may like the index instead of the value:

    (notice, that the separating line counts, so you have to take care ...)

                                                                        [exBegin]

     |p|

     p := PopUpList label:'dummy'.

     p list:#('apples' 'bananas' 'grape' 'lemon' '-' 'margaritas').

     p selection:'apples'.

     p action:[:what | Transcript show:'you selected: '; showCR:what].

     p useIndex:true.

     p open

                                                                        [exEnd]

    since the list is actually a popupMenu, you can add double-separators:

                                                                        [exBegin]

     |p|

     p := PopUpList label:'dummy'.

     p list:#('apples' 'bananas' 'grape' 'lemon' 

              '=' 

              'margaritas' 'pina colada'

              '=' 

              'smalltalk' 'c++' 'eiffel' 'java').

     p values:#(apples bananas grape lemon 

                nil 

                'mhmh - so good' 'makes headache'

                nil

                'great' 'another headache' 'not bad' 'neat').

     p selection:'apples'.

     p action:[:what | Transcript show:'you selected: '; showCR:what].

     p open

                                                                        [exEnd]

    since the list is actually represented by a menuView,

    which itself is inheriting from listView, which itself can display

    things different from strings, arbitrary lists can be constructed:

    (see ListEntry classes)

                                                                        [exBegin]

     |p l|

     p := PopUpList label:'dummy'.

     l := OrderedCollection new.

     l add:'='.

     l add:(ColoredListEntry string:'margaritas' color:Color green darkened darkened).

     l add:(ColoredListEntry string:'pina colada' color:Color green darkened darkened).

     l add:'='.

     l add:(ColoredListEntry string:'smalltalk' color:Color blue).

     l add:(ColoredListEntry string:'c++' color:Color blue).

     l add:(ColoredListEntry string:'eiffel' color:Color blue).

     l add:(ColoredListEntry string:'java' color:Color blue).

     p list:l.

     p values:#(apples bananas grape lemon 

                nil 

                'mhmh - so good' 'makes headache'

                nil

                'great' 'another headache' 'not bad' 'neat').

     p selection:'apples'.

     p action:[:what | Transcript show:'you selected: '; showCR:what].

     p open

                                                                        [exEnd]

    with values different from the label strings:

                                                                        [exBegin]

     |p|

     p := PopUpList label:'dummy'.

     p list:#('apples' 'bananas' 'grape' 'lemon' '-' 'margaritas').

     p selection:'apples'.

     p values:#(10 20 30 40 nil 50).

     p action:[:what | Transcript show:'you selected: '; showCR:what].

     p open

                                                                        [exEnd]

  the defaults are setup to allow a SelectionInList directly as model:

                                                                        [exBegin]

     |p model|

     model := SelectionInList with:#('apples' 'bananas' 'grape' 'lemon' 'margaritas').

     p := PopUpList label:'healthy fruit'.

     p model:model.

     p open.

     model inspect

                                                                        [exEnd]

    a popupList and a SelectionInListView on the same model:

                                                                        [exBegin]

     |p slv model|

     model := SelectionInList with:#('apples' 'bananas' 'grape' 'lemon' 'margaritas').

     model selection:'apples'.

     p := PopUpList on:model.

     p open.

     slv := SelectionInListView on:model.

     slv open.

                                                                        [exEnd]

    two PopUpLists on the same model, different aspects:

                                                                        [exBegin]

     |top panel p model|

     model := Plug new.

     model respondTo:#eat: with:[:val | Transcript showCR:'eat: ' , val].

     model respondTo:#drink: with:[:val | Transcript showCR:'drink: ' , val].

     model respondTo:#meals with:[#(taco burrito enchilada)].

     model respondTo:#drinks with:[#(margarita water corona)].

     top := StandardSystemView new.

     top extent:(100@100).

     panel := VerticalPanelView origin:0.0@0.0 corner:1.0@1.0 in:top.

     panel horizontalLayout:#fitSpace.

     p := PopUpList label:'meals'.

     p model:model; listMessage:#meals; aspect:nil; change:#eat:.

     panel add:p.

     p := PopUpList label:'drinks'.

     p model:model; listMessage:#drinks; aspect:nil; change:#drink:.

     panel add:p.

     top open

                                                                        [exEnd]

    with separate list- and indexHolders:

                                                                        [exBegin]

     |p selectionHolder listHolder|

     listHolder := #('apples' 'bananas' 'grape' 'lemon' 'margaritas') asValue.

     selectionHolder := 'apples' asValue.

     p := PopUpList label:'healthy fruit'.

     p listHolder:listHolder.

     p open.

     selectionHolder inspect

                                                                        [exEnd]

    same, using index:

                                                                        [exBegin]

     |p selectionIndexHolder listHolder|

     listHolder := #('apples' 'bananas' 'grape' 'lemon' 'margaritas') asValue.

     selectionIndexHolder := 3 asValue.

     p := PopUpList new.

     p listHolder:listHolder.

     p useIndex:true.

     p open.

     selectionIndexHolder inspect

                                                                        [exEnd]

"

! !

!PopUpList class methodsFor:'defaults'!

defaultAspectMessage

    ^ #selection

!

defaultChangeMessage

    ^ #selection:

!

defaultListMessage

    ^ #list 

! !

!PopUpList methodsFor:'accessing'!

contents

    ^ self label

!

contents:con

    ^ self selection:con

    "Modified: 25.5.1996 / 14:20:57 / cg"

!

defaultLabel:aString

    "set the defaultLabel, to be shown if nothing is selected"

    defaultLabel := aString

!

list

    "return the list - i.e. the values shown in the pop-up list"

    ^ menu labels

!

list:aList

    "set the list - i.e. the values shown in the pop-up list"

    self createMenuFor:aList.

    realized ifTrue:[

	self computeLabelSize

    ]

    "

     |p|

     p := PopUpList label:'fruit ?'.

     p list:#('apples' 'bananas' 'grape' 'lemon' 'margaritas').

     p action:[:val | Transcript showCR:'selected: ' , val printString].   

     p open

    "

!

selection:indexOrString

    "set (force) a selection - usually done to set

     an initial selection without updating others"

    |index wasFix|

    menu isNil ifTrue:[

	self getListFromModel.

    ].

    menu isNil ifTrue:[^ self].

    index := menu indexOf:indexOrString.

    index == 0 ifTrue:[

	self label:defaultLabel.

	^ self

    ].

    "kludge: dont want label to resize ..."

    wasFix := fixSize. fixSize := true.

    self label:(menu labels at:index) printString.

    fixSize := wasFix

    "

     |p|

     p := PopUpList label:'what fruit ?'.

     p list:#('apples' 'bananas' 'grape' 'lemon' 'margaritas').

     p selection:'grape'.

     p open 

     |p|

     p := PopUpList label:'what fruit ?'.

     p list:#('apples' 'bananas' 'grape' 'lemon' 'margaritas').

     p selection:'blabla'.

     p open

    "

    "Modified: 8.2.1996 / 12:55:01 / cg"

!

values:aList

    "set a value list - these are reported via the action or changeSymbol instead of

     the label strings."

    values := aList.

    menu args:(1 to:aList size).

    "

     |p|

     p := PopUpList label:'fruit ?'.

     p list:#('apples' 'bananas' 'grape' 'lemon' 'margaritas').

     p values:#(1 2 3 4 'mhmh - good').

     p action:[:val | Transcript showCR:'selected: ' , val printString].   

     p open.

    "

! !

!PopUpList methodsFor:'accessing-behavior'!

action:aOneArgBlock

    "set the action to be performed on selection changes;

     the argument, aOneArgBlock will be evaluated with the

     selection-value as argument"

    menuAction := aOneArgBlock

!

useIndex:aBoolean 

    "tell the popuplist to pass the index (instead of the value)

     to both the actionBlock and model. Notice, that if you use a model,

     the default changeSelector is not ok for using index and a SelectionInList"

    useIndex := aBoolean

    "

     |p|

     p := PopUpList label:'fruit ?'.

     p list:#('apples' 'bananas' 'grape' 'lemon' 'margaritas').

     p action:[:val | Transcript showCR:'selected: ' , val printString].   

     p open.

    "

    "

     |p|

     p := PopUpList label:'fruit ?'.

     p list:#('apples' 'bananas' 'grape' 'lemon' 'margaritas').

     p action:[:val | Transcript showCR:'selected: ' , val printString].   

     p useIndex:true.

     p open.

    "

! !

!PopUpList methodsFor:'accessing-mvc'!

addModelInterfaceTo:aDictionary

    "see comment in View>>modelInterface"

    super addModelInterfaceTo:aDictionary.

    aDictionary at:#listMessage put:listMsg

    "Modified: 26.2.1997 / 19:08:04 / cg"

!

getListFromModel

    "if I have a listHolder, ask it for the list;

     otherwise, if I have a model and a listMsg, get my list from there"

    listHolder notNil ifTrue:[

        self list:listHolder value

    ] ifFalse:[

        (listMsg notNil and:[model notNil]) ifTrue:[

            self list:(model perform:listMsg).

        ].

    ]