hg/stx-libwidg: comparison PopUpList.st

equal deleted inserted replaced

-:52111b0631da
+:59f182d1304f
 other person.  No title to or ownership of the software is
 hereby transferred.
 "
 Button subclass:#PopUpList
-	instanceVariableNames:'menu menuAction values useIndex listMsg defaultLabel'
+	instanceVariableNames:'menu menuAction values useIndex listMsg defaultLabel
+			       listHolder selectionHolder'
 	classVariableNames:''
 	poolDictionaries:''
 	category:'Views-Interactors'
 !
 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 listMsg (default
+is #list) and the current selected items index via
+#selection or: #selectionIndex (depending on the setting of useIndex).
 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:]
-menu                            helpers for the popup menu
+	menu                            helpers for the popup menu
-menuAction
+	menuAction
-values
+	values
-useIndex             <Boolean>  if true, the index of the selected entry
+	useIndex             <Boolean>  if true, the index of the selected entry
-is passed to the action block and the
+					is passed to the action block and the
-model in a change-message.
+					model in a change-message.
-If false (the default), the value is passed.
+					If false (the default), the value is passed.
-Notice that the default changeMessage is
+					Notice that the default changeMessage is
-#selection:, which is not ok to be used
+					#selection:, which is not ok to be used
-with useIndex:true and a selectionInList model.
+					with useIndex:true and a selectionInList model.
-(set the changeMessage to #selectionIndex: then)
+					(set the changeMessage to #selectionIndex: then)
-listMsg              <Symbol>   message to aquire a new list from the
+	listMsg              <Symbol>   message to aquire a new list from the
-model. Default is #list.
+					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.
+	selectionHolder      <Object>   if non-nil, this object is assumed to return the
+					selection via the changeMsg (instead of the model).
+					UseIndex specifies if its numeric (i.e. a selectionindex)
+					Default is nil.
 [see also:]
-SelectionInListView
+	SelectionInListView
-SelectionInList
+	SelectionInList
 [author:]
-Claus Gittinger
+	Claus Gittinger
 "
 !
 examples
 "
 example use:
-[exBegin]
+									[exBegin]
 |p|
 p := PopUpList label:'healthy fruit'.
 p list:#('apples' 'bananas' 'grape' 'lemon' 'margaritas').
 p open
-[exEnd]
+									[exEnd]
 with an initial selection:
-[exBegin]
+									[exBegin]
 |p|
 p := PopUpList label:'dummy'.
 p list:#('apples' 'bananas' 'grape' 'lemon' 'margaritas').
 p selection:'apples'.
 p open
-[exEnd]
+									[exEnd]
 with separating lines:
-[exBegin]
+									[exBegin]
 |p|
 p := PopUpList label:'fruit'.
 p list:#('apples' 'bananas' 'grape' 'lemon' '-' 'margaritas').
 p selection:'apples'.
 p open
-[exEnd]
+									[exEnd]
 with an action:
-[exBegin]
+									[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]
+									[exEnd]
 sometimes, you may like the index instead of the value:
 (notice, that the separating line counts, so you have to take care ...)
-[exBegin]
+									[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]
+									[exEnd]
 since the list is actually a popupMenu, you can add double-separators:
-[exBegin]
+									[exBegin]
 |p|
 p := PopUpList label:'dummy'.
 p list:#('apples' 'bananas' 'grape' 'lemon'
-'='
+	      '='
-'margaritas' 'pina colada'
+	      'margaritas' 'pina colada'
-'='
+	      '='
-'smalltalk' 'c++' 'eiffel' 'java').
+	      'smalltalk' 'c++' 'eiffel' 'java').
 p values:#(apples bananas grape lemon
-nil
+		nil
-'mhmh - so good' 'makes headache'
+		'mhmh - so good' 'makes headache'
-nil
+		nil
-'great' 'another headache' 'not bad' 'neat').
+		'great' 'another headache' 'not bad' 'neat').
 p selection:'apples'.
 p action:[:what | Transcript show:'you selected: '; showCR:what].
 p open
-[exEnd]
+									[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]
+									[exBegin]
 |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:'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
+		nil
-'mhmh - so good' 'makes headache'
+		'mhmh - so good' 'makes headache'
-nil
+		nil
-'great' 'another headache' 'not bad' 'neat').
+		'great' 'another headache' 'not bad' 'neat').
 p selection:'apples'.
 p action:[:what | Transcript show:'you selected: '; showCR:what].
 p open
-[exEnd]
+									[exEnd]
 with values different from the label strings:
-[exBegin]
+									[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]
+									[exEnd]
 with a model (see in the inspector, how the valueHolders index-value changes):
-[exBegin]
+									[exBegin]
 |p model|
 model := SelectionInList with:#('apples' 'bananas' 'grape' 'lemon' 'margaritas').
 p := PopUpList label:'healthy fruit'.
 p model:model.
 p open.
 model selectionIndexHolder inspect
-[exEnd]
+									[exEnd]
 a popupList and a SelectionInListView on the same model:
-[exBegin]
+									[exBegin]
 |p slv model|
 model := SelectionInList with:#('apples' 'bananas' 'grape' 'lemon' 'margaritas').
 model selection:'apples'.
 slv := SelectionInListView on:model.
 slv open.
 p inspect.
 model selectionIndexHolder inspect
-[exEnd]
+									[exEnd]
 two PopUpLists on the same model, different aspects:
-[exBegin]
+									[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].
 p := PopUpList label:'drinks'.
 p model:model; listMessage:#drinks; aspect:nil; change:#drink:.
 panel add:p.
 top open
-[exEnd]
+									[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 selectionHolder:selectionHolder.
+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 selectionHolder:selectionIndexHolder.
+p useIndex:true.
+p open.
+selectionIndexHolder inspect
+									[exEnd]
 "
 ! !
 !PopUpList class methodsFor:'defaults'!
 p action:[:val | Transcript showCR:'selected: ' , val printString].
 p open
 "
 !
+listHolder
+"return the listHolder if any"
+^ listHolder
+!
+listHolder:aValueHolder
+"set the listHolder and change the listMessage to #value."
+listHolder notNil ifTrue:[
+	listHolder removeDependent:self.
+].
+listHolder := aValueHolder.
+listHolder notNil ifTrue:[
+	listHolder addDependent:self.
+].
+listMsg := #value.
+shown ifTrue:[
+	self getListFromModel
+]
+!
 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 label:defaultLabel.
-^ self
+	^ self
 ].
 "kludge: dont want label to resize ..."
 wasFix := fixSize. fixSize := true.
 self label:(menu labels at:index) printString.
 "
 "Modified: 8.2.1996 / 12:55:01 / cg"
 !
+selectionHolder
+"return the selectionHolder if any"
+^ selectionHolder
+!
+selectionHolder:aValueHolder
+"set the selectionHolder and change the aspect/changeMessage to #value / #value:"
+selectionHolder notNil ifTrue:[
+	selectionHolder removeDependent:self.
+].
+selectionHolder := aValueHolder.
+selectionHolder notNil ifTrue:[
+	selectionHolder addDependent:self.
+].
+aspectMsg := #value.
+changeMsg := #value:.
+shown ifTrue:[
+	self getSelectionFromModel
+]
+!
 values:aList
 "set a value list - these are reported via the action or changeSymbol instead of
-the labe strings."
+the label strings."
 values := aList.
 menu args:(1 to:aList size).
 "
 !
 getListFromModel
 "if I have a model and a listMsg, get my list from it"
-(model notNil
+|l|
-and:[listMsg notNil]) ifTrue:[
-	self list:(model perform:listMsg).
+listMsg notNil ifTrue:[
-].
+	listHolder notNil ifTrue:[
+	    l := listHolder perform:listMsg
+	] ifFalse:[
+	    model notNil ifTrue:[
+		l := model perform:listMsg.
+	    ]
+	].
+	self list:l
+]
 !
 getSelectionFromModel
 "if I have a model and an aspectMsg, get my current value from it"
-(model notNil
+|sel|
-and:[aspectMsg notNil]) ifTrue:[
-menu isNil ifTrue:[
+aspectMsg notNil ifTrue:[
-self getListFromModel
+	selectionHolder notNil ifTrue:[
-].
+	    sel := selectionHolder perform:aspectMsg
-self selection:(model perform:aspectMsg).
+	] ifFalse:[
+	    model notNil ifTrue:[
+		sel := model perform:aspectMsg.
+	    ]
+	].
+	self selection:sel
 ].
 "Modified: 25.5.1996 / 14:21:07 / cg"
 !
 listMessage
 "return the selector by which we ask the model for the list.
-Default is #list."
+The default is #list if used with a model
+or #value, if used with a listHolder."
 ^ listMsg
 !
 listMessage:aSelector
 "set the selector by which we ask the model for the list.
-Default is #list."
+The default is #list if used with a model
+or #value, if used with a listHolder."
 listMsg := aSelector
 ! !
 !PopUpList methodsFor:'change & update'!
 update:something with:aParameter from:changedObject
+changedObject == listHolder ifTrue:[
+	self getListFromModel.
+	^ self
+].
+changedObject == selectionHolder ifTrue:[
+	self getSelectionFromModel.
+	^ self
+].
 changedObject == model ifTrue:[
 	(something == aspectMsg
 	or:[something == #selectionIndex]) ifTrue:[
 	    self getSelectionFromModel.
 	    ^ self
 popMenu
 |org mv w|
 menu notNil ifTrue:[
-self turnOffWithoutRedraw.
+	self turnOffWithoutRedraw.
-menu labels size == 0 ifTrue:[
+	menu labels size == 0 ifTrue:[
-^ self
+	    ^ self
-].
+	].
-menu font:font.
+	menu font:font.
-"
+	"
-adjust the menus width to my current width
+	 adjust the menus width to my current width
-"
+	"
-mv := menu menuView.
+	mv := menu menuView.
-mv create.      "/ stupid: it resizes itself upon first create
+	mv create.      "/ stupid: it resizes itself upon first create
-w := mv width.  "/ to its preferred size.
+	w := mv width.  "/ to its preferred size.
-w := w max:(self width - (2 * menu margin) - (menu borderWidth*2)).
+	w := w max:(self width - (2 * menu margin) - (menu borderWidth*2)).
-mv width:w.
+	mv width:w.
-mv level:0; borderWidth:0.
+	mv level:0; borderWidth:0.
-"
+	"
-the popupMenu wants Display coordinates in its showAt: method
+	 the popupMenu wants Display coordinates in its showAt: method
-"
+	"
-org := device translatePoint:0@0
+	org := device translatePoint:0@0
-from:(self id)
+				from:(self id)
-to:(device rootView id).
+				  to:(device rootView id).
-menu showAt:org "resizing:false"
+	menu showAt:org "resizing:false"
 ].
 ! !
 !PopUpList methodsFor:'initialization'!
 !PopUpList methodsFor:'private'!
 computeLabelSize
 "compute the extent needed to hold the label plus the mark"
-|mmH mmV savedLogo longest longestWidth|
+|mmH mmV savedLogo longest longestWidth labels|
 menu isNil ifTrue:[
-super computeLabelSize
+	super computeLabelSize
 ] ifFalse:[
-"hack: simulate logo change to longest menu entry"
+	"hack: simulate logo change to longest menu entry"
-font := font on:device.
+	font := font on:device.
-longest := logo.
+	longest := logo.
-longestWidth := font widthOf:logo.
+	logo isNil ifTrue:[
-menu labels do:[:entry |
+	    longestWidth := 0
-|this|
+	] ifFalse:[
+	    longestWidth := font widthOf:logo.
-this := font widthOf:entry printString.
+	].
-this > longestWidth ifTrue:[
+	labels := menu labels.
-longest := entry.
+	labels notNil ifTrue:[
-longestWidth := this
+	    labels do:[:entry |
-].
+		|this|
-].
-savedLogo := logo.
+		this := font widthOf:entry printString.
-logo := longest printString.
+		this > longestWidth ifTrue:[
-super computeLabelSize.
+		    longest := entry.
-logo := savedLogo.
+		    longestWidth := this
-"self halt.     "
+		].
+	    ].
+	].
+	savedLogo := logo.
+	logo := longest printString.
+	super computeLabelSize.
+	logo := savedLogo.
 ].
 mmH := device horizontalPixelPerMillimeter.
 mmV := device verticalPixelPerMillimeter.
 labelWidth := labelWidth + hSpace + (mmH * 2.5) rounded + hSpace.
 labelHeight := labelHeight max: (mmV * 2) rounded
 		     for:self.
 !
 realize
 super realize.
-model notNil ifTrue:[
+(model notNil or:[listHolder notNil]) ifTrue:[
-	self getListFromModel.
+self getListFromModel.
-	self getSelectionFromModel.
+].
-].
+(model notNil or:[selectionHolder notNil]) ifTrue:[
+self getSelectionFromModel.
+]
 ! !
 !PopUpList methodsFor:'private-controller access'!
 menu
 "redefined to make certain that the menu is fully defined"
 "/ If I have an explicit preferredExtent ..
 preferredExtent notNil ifTrue:[
-^ preferredExtent
+	^ preferredExtent
 ].
 menu isNil ifTrue:[
-self getListFromModel
+	self getListFromModel
 ].
 self computeLabelSize.
 ^ super preferredExtent.
 "Modified: 19.7.1996 / 20:45:16 / cg"
 !
 specClass
 self class == PopUpList ifTrue:[^ PopUpListSpec].
-^ nil
+^ super specClass
 ! !
 !PopUpList methodsFor:'user actions'!
 select:anEntry
 |value label|
 label := menu labels at:anEntry.
 values isNil ifTrue:[
-value := anEntry.
+	value := anEntry.
-useIndex ifFalse:[
+	useIndex ifFalse:[
-value := menu labels at:anEntry.
+	    value := menu labels at:anEntry.
-]
+	]
 ] ifFalse:[
-value := values at:anEntry
+	value := values at:anEntry
-].
-menuAction notNil ifTrue:[
-menuAction value:value.
 ].
 self sizeFixed:true.
 self label:label printString.
+selectionHolder notNil ifTrue:[
+	selectionHolder perform:changeMsg with:value
+].
 "/
 "/ ST-80 way of doing it
 "/ tell my model - if any
 "/
-self sendChangeMessageWith:value
+self sendChangeMessageWith:value.
+"/
+"/ ST/X action blocks
+"/
+menuAction notNil ifTrue:[
+	menuAction value:value.
+].
 "Modified: 14.2.1997 / 16:47:09 / cg"
 ! !
 !PopUpList class methodsFor:'documentation'!
 version
-^ '$Header: /cvs/stx/stx/libwidg/PopUpList.st,v 1.31 1997-02-21 19:24:57 ca Exp $'
+^ '$Header: /cvs/stx/stx/libwidg/PopUpList.st,v 1.32 1997-02-25 14:51:44 cg Exp $'
 ! !

changeset 1052	59f182d1304f
parent 1035	c7cfaead1621
child 1063	b315e2580bc7