"

 COPYRIGHT (c) 1996 by eXept Software AG / 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.

"

"{ Package: 'stx:libwidg2' }"

"{ NameSpace: Smalltalk }"

ComboView subclass:#ComboListView

	instanceVariableNames:'useIndex values selectCondition'

	classVariableNames:''

	poolDictionaries:''

	category:'Views-Interactors'

!

!ComboListView class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1996 by eXept Software AG / 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 ComboListView combines a label with a drop down list of default inputs;

    choosing any from the pulled list sets the string in the label.

    If some other model is to be used, the changeMessage and aspectMessage

    should be defined as appropriate (or an aspectAdaptor should be used).

    If a listHolder is set, that one is assumed to provide the list of

    items in the popped menu;

    otherwise, if listMessage is nonNil, the model is assumed to also provide the

    [author:]

        Claus Gittinger

    [see also:]

        ComboView

        PopUpList SelectionInListView

        ComboBoxView ExtendedComboBox

        PullDownMenu Label EntryField

"

!

examples

"

  non-MVC use; 

    set the list explicitly:

                                                                [exBegin]

     |top comboList|

     top := StandardSystemView new.

     top extent:(300 @ 200).

     comboList := ComboListView in:top.

     comboList origin:(0.0 @ 0.0) corner:(1.0 @ 0.0).

     comboList bottomInset:(comboList preferredExtent y negated).

     comboList list:#('hello' 'world' 'this' 'is' 'st/x').

     top open.

                                                                [exEnd]

  a really, really long list (notice scrollup/down buttons at the top/bottom); 

                                                                [exBegin]

     |top comboList|

     top := StandardSystemView new.

     top extent:(300 @ 200).

     comboList := ComboListView in:top.

     comboList origin:(0.0 @ 0.0) corner:(1.0 @ 0.0).

     comboList bottomInset:(comboList preferredExtent y negated).

     comboList list:((1 to:100) collect:[:n | n printString]).

     top open.

                                                                [exEnd]

    with callBack:

                                                                [exBegin]

     |top comboList|

     top := StandardSystemView new.

     top extent:(300 @ 200).

     comboList := ComboListView in:top.

     comboList origin:(0.0 @ 0.0) corner:(1.0 @ 0.0).

     comboList bottomInset:(comboList preferredExtent y negated).

     comboList list:#('hello' 'world' 'this' 'is' 'st/x').

     comboList action:[:selected | Transcript showCR:selected].

     top open.

                                                                [exEnd]

    with separating lines:

                                                                [exBegin]

     |top comboList|

     top := StandardSystemView label:'fruit chooser'.

     top extent:(300 @ 200).

     comboList := ComboListView in:top.

     comboList origin:(0.0 @ 0.0) corner:(1.0 @ 0.0).

     comboList bottomInset:(comboList preferredExtent y negated).

     comboList label:'fruit'.

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

     comboList action:[:selected | Transcript showCR:selected].

     top open

                                                                [exEnd]

    with values different from the label strings:

                                                                        [exBegin]

     |top comboList|

     top := StandardSystemView label:'fruit chooser'.

     top extent:(300 @ 200).

     comboList := ComboListView in:top.

     comboList origin:(0.0 @ 0.0) corner:(1.0 @ 0.0).

     comboList bottomInset:(comboList preferredExtent y negated).

     comboList label:'dummy'.

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

     comboList selection:'apples'.

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

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

     top 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]

     |top comboList|

     top := StandardSystemView label:'fruit chooser'.

     top extent:(300 @ 200).

     comboList := ComboListView in:top.

     comboList origin:(0.0 @ 0.0) corner:(1.0 @ 0.0).

     comboList bottomInset:(comboList preferredExtent y negated).

     comboList label:'dummy'.

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

     comboList selection:'apples'.

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

     comboList useIndex:true.

     top 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, LabelAndIcon and Text classes)

                                                                        [exBegin]

     |top comboList l|

     top := StandardSystemView label:'fruit chooser'.

     top extent:(300 @ 200).

     comboList := ComboListView in:top.

     comboList origin:(0.0 @ 0.0) corner:(1.0 @ 0.0).

     comboList bottomInset:(comboList preferredExtent y negated).

     l := OrderedCollection new.

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

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

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

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

     l add:'='.

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

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

     l add:'='.

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

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

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

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

     comboList list:l.

     comboList values:#(apples bananas grape lemon 

                nil 

                'mhmh - so good' 'makes headache'

                nil

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

     comboList selection:'apples'.

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

     top open

                                                                        [exEnd]

    with values different from the label strings:

                                                                        [exBegin]

     |top comboList|

     top := StandardSystemView label:'language chooser'.

     top extent:(300 @ 200).

     comboList := ComboListView in:top.

     comboList origin:(0.0 @ 0.0) corner:(1.0 @ 0.0).

     comboList list:( #(

                'usa'

                'uk'

                'france'

                'germany'       

                'italy'

               ) collect:[:country |

                            LabelAndIcon 

                                icon:(Image fromFile:'bitmaps/xpmBitmaps/countries/' , country , '.xpm')

                                string:country

                         ]

            ).

     comboList values:#(us england france germany italy).

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

     comboList bottomInset:(comboList preferredExtent y negated).

     top open

                                                                        [exEnd]

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

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

                                                                        [exBegin]

     |p model|

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

     p := ComboListView label:'healthy fruit'.

     p model:model.

     p openAt:(Screen current center).

     model inspect

                                                                        [exEnd]

  model provides selection; list is explicit:

                                                                [exBegin]

     |model top b|

     model := 'foo' asValue.

     top := StandardSystemView new.

     top extent:(300 @ 200).

     b := ComboListView in:top.

     b origin:(0.0 @ 0.0) corner:(1.0 @ 0.0).

     b bottomInset:(b preferredExtent y negated).

     b list:#('hello' 'world' 'this' 'is' 'st/x').

     b model:model.

     top openModal.

     Transcript showCR:('comboBox''s value: ' , model value).

                                                                [exEnd]

    a comboListView and a SelectionInListView on the same model:

                                                                        [exBegin]

     |p slv model|

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

     model selection:'apples'.

     p := ComboListView on:model.

     p openAt:(Screen current center).

     slv := SelectionInListView on:model.

     slv openAt:(Screen current center + (100@100)).

                                                                        [exEnd]

    like above, using index:

                                                                        [exBegin]

     |p slv model|

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

     model selection:'apples'.

     p := ComboListView on:model.

     p openAt:(Screen current center).

     slv := SelectionInListView on:model.

     slv openAt:(Screen current center + (100@100)).

                                                                        [exEnd]

    two comboListViews 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 label:'meal chooser'.

     top extent:(150@150).

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

     panel horizontalLayout:#fitSpace.

     p := ComboListView label:'meals'.

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

     panel add:p.

     p := ComboListView label:'drinks'.

     p aspect:nil; model:model; listMessage:#drinks; 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 := ComboListView label:'healthy fruit'.

     p listHolder:listHolder.

     p model:selectionHolder.

     p openAt:(Screen current center).

     selectionHolder inspect

                                                                        [exEnd]

    using different values:

                                                                        [exBegin]

     |p priceHolder listHolder prices priceField|

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

     prices := #(10 10 5 15 50).

     priceHolder := nil asValue.

     p := ComboListView new.

     p listHolder:listHolder.

     p model:priceHolder.

     p values:prices.

     p openAt:(Screen current center).

     priceField := EditField new.

     priceField readOnly:true.

     priceField model:(TypeConverter onNumberValue:priceHolder).

     priceField openAt:(Screen current center + (10@10)).

                                                                        [exEnd]

  in a dialog:

                                                                [exBegin]

     |model1 model2 dialog b|

     model1 := 'foo' asValue.

     model2 := 'bar' asValue.

     dialog := Dialog new.

     (dialog addTextLabel:'ComboList example:') adjust:#left.

     dialog addVerticalSpace.

     (b := dialog addComboListOn:model1 tabable:true).

     b list:#('fee' 'foe' 'foo').

     dialog addVerticalSpace.

     (b := dialog addComboListOn:model2 tabable:true).

     b list:#('bar' 'baz' 'baloo').

     dialog addVerticalSpace.

     dialog addOkButton.

     dialog open.

     Transcript showCR:('1st comboBox''s value: ' , model1 value).

     Transcript showCR:('2nd comboBox''s value: ' , model2 value).

                                                                [exEnd]

  Select condition

                                                                [exBegin]

     |top comboList|

     top := StandardSystemView new.

     top extent:(300 @ 200).

     comboList := ComboListView in:top.

     comboList origin:(0.0 @ 0.0) corner:(1.0 @ 0.0).

     comboList bottomInset:(comboList preferredExtent y negated).

     comboList list:((1 to:100) collect:[:n | n printString]).

     comboList selectCondition:[:newValue | (Number readFrom:newValue) even].

     top open.

                                                                [exEnd]

"

! !

!ComboListView class methodsFor:'defaults'!

defaultAspectMessage

    ^ #selection

    "Created: 27.2.1997 / 15:23:13 / cg"

!

defaultChangeMessage

    ^ #selection:

    "Created: 27.2.1997 / 15:23:18 / cg"

!

defaultFont

    ^ SelectionInListView defaultFont.

! !

!ComboListView methodsFor:'accessing'!

selectCondition:something

    selectCondition := something.

! !

!ComboListView methodsFor:'accessing-behavior'!

useIndex

    "specify, if the selected components value or its index in the

     list should be sent to the model. The default is its value."

    ^ useIndex

!

useIndex:aBoolean

    "specify, if the selected component's value or its index in the

     list should be sent to the model. The default is its value."

    useIndex := aBoolean.

"/    "/ change the aspectMessage - but only if it has not yet been

"/    "/ changed explicitly

"/    useIndex ifTrue:[

"/        changeMsg == #selection: ifTrue:[

"/            changeMsg := #selectionIndex:.

"/            aspectMsg := #selectionIndex.

"/        ]

"/    ] ifFalse:[

"/        changeMsg == #selectionIndex: ifTrue:[

"/            changeMsg := #selection:.

"/            aspectMsg := #selection.

"/        ]

"/    ].

    "Created: / 26-07-1996 / 17:44:18 / cg"

    "Modified: / 24-01-1998 / 19:06:41 / cg"

    "Modified (comment): / 08-03-2017 / 01:12:50 / cg"

!

values:aCollection

    "specify, which values are to be stuffed into the model or

     passed via the actionBlock."

    values := aCollection.