"

 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

	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.

    The default changeMessage used is #selection:, which allows a

    PopUpList to be used with a SelectionInList as model.

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

     changeMessage to something else ..)

    [Instance variables:]

    [see also:]

    [author:]

"

!

examples

"

    example use:

     |p|

     p := PopUpList label:'healthy fruit'.

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

     p open

    with an initial selection:

     |p|

     p := PopUpList label:'dummy'.

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

     p selection:'apples'.

     p open

    with separating lines:

     |p|

     p := PopUpList label:'fruit'.

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

     p selection:'apples'.

     p open

    with an action:

     |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

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

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

     |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

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

     |p|

     p := PopUpList label:'dummy'.

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

     p values:#(apples bananas grape lemon 

     p selection:'apples'.

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

     p open

    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)

     |p l|

     p := PopUpList label:'dummy'.

     l := OrderedCollection new.

     l add:(ColoredListEntry string:'apples' color:Color red).

     l add:(ColoredListEntry string:'bananas' color:Color red).

     l add:(ColoredListEntry string:'grape' color:Color red).

     l add:(ColoredListEntry string:'lemon' color:Color red).

     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 

     p selection:'apples'.

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

     p open

    with values different from the label strings:

     |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

    with a model (see in the inspector, how the valueHolders index-value changes):

     |p model|

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

     p := PopUpList label:'healthy fruit'.

     p model:model.

     p open.

     model selectionIndexHolder inspect

    a popupList and a SelectionInListView on the same model:

     |p slv model|

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

     model selection:'apples'.

     p := PopUpList on:model.

     p useIndex:true; aspect:#selectionIndex; change:#selectionIndex:.

     p open.

     slv := SelectionInListView on:model.

     slv open.

     p inspect.

     model selectionIndexHolder inspect

    two PopUpLists on the same model, different aspects:

     |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

"

! !

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

    index := menu indexOf:indexOrString.

    index == 0 ifTrue:[

    ].

    "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

    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|