|
75
|
1 |
"
|
|
|
2 |
COPYRIGHT (c) 1995 by Claus Gittinger
|
|
|
3 |
All Rights Reserved
|
|
|
4 |
|
|
|
5 |
This software is furnished under a license and may be used
|
|
|
6 |
only in accordance with the terms of that license and with the
|
|
|
7 |
inclusion of the above copyright notice. This software may not
|
|
|
8 |
be provided or otherwise made available to, or used by, any
|
|
|
9 |
other person. No title to or ownership of the software is
|
|
|
10 |
hereby transferred.
|
|
|
11 |
"
|
|
|
12 |
|
|
69
|
13 |
ValueModel subclass:#ProtocolAdaptor
|
|
186
|
14 |
instanceVariableNames:'accessPath subject subjectChannel subjectSendsUpdates'
|
|
|
15 |
classVariableNames:''
|
|
|
16 |
poolDictionaries:''
|
|
|
17 |
category:'Interface-Support-Models'
|
|
69
|
18 |
!
|
|
|
19 |
|
|
|
20 |
!ProtocolAdaptor class methodsFor:'documentation'!
|
|
|
21 |
|
|
|
22 |
copyright
|
|
|
23 |
"
|
|
|
24 |
COPYRIGHT (c) 1995 by Claus Gittinger
|
|
71
|
25 |
All Rights Reserved
|
|
69
|
26 |
|
|
|
27 |
This software is furnished under a license and may be used
|
|
|
28 |
only in accordance with the terms of that license and with the
|
|
|
29 |
inclusion of the above copyright notice. This software may not
|
|
|
30 |
be provided or otherwise made available to, or used by, any
|
|
|
31 |
other person. No title to or ownership of the software is
|
|
|
32 |
hereby transferred.
|
|
|
33 |
"
|
|
|
34 |
!
|
|
|
35 |
|
|
|
36 |
documentation
|
|
|
37 |
"
|
|
|
38 |
a ProtocolAdaptor allows access to embeded values in a
|
|
|
39 |
complex model and plays model towards the outside world.
|
|
|
40 |
|
|
|
41 |
Consider the case where editFields are required for the
|
|
|
42 |
elements (instance variables) of a more complex model.
|
|
|
43 |
Using ValueHolders, you had to copy the individual
|
|
|
44 |
values out-of and into multiple valueHolders.
|
|
|
45 |
A protocolAdaptor makes this easier, by playing model towards
|
|
|
46 |
the editField, returning a value from the complex model,
|
|
|
47 |
and forwards changes to the complex model.
|
|
|
48 |
|
|
231
|
49 |
Notice:
|
|
|
50 |
since you can specify the aspect- and changeSymbols in most ST/X
|
|
|
51 |
widgets, ProtocolAdapters are not always needed
|
|
|
52 |
(at least, if no accesspath is required).
|
|
|
53 |
However, if you want to apply widgets on objects which where not
|
|
|
54 |
originally designed as models (such as Arrays), ProtocolAdapters
|
|
|
55 |
are very handy.
|
|
69
|
56 |
|
|
231
|
57 |
Notice:
|
|
|
58 |
this class was implemented using protocol information
|
|
|
59 |
from alpha testers - it may not be complete or compatible to
|
|
|
60 |
the corresponding ST-80 class.
|
|
|
61 |
If you encounter any incompatibilities, please forward a note
|
|
|
62 |
describing the incompatibility verbal (i.e. no code) to the ST/X team.
|
|
223
|
63 |
|
|
|
64 |
[author:]
|
|
|
65 |
Claus Gittinger
|
|
231
|
66 |
|
|
|
67 |
[see also:]
|
|
|
68 |
Model AspectAdaptor ValueHolder
|
|
69
|
69 |
"
|
|
|
70 |
!
|
|
|
71 |
|
|
|
72 |
examples
|
|
|
73 |
"
|
|
231
|
74 |
[exBegin]
|
|
|
75 |
|a obj|
|
|
69
|
76 |
|
|
231
|
77 |
a := ProtocolAdaptor accessPath:#(1 2 3).
|
|
|
78 |
obj := Array with:#(11 (121 122 123) 13)
|
|
|
79 |
with:#(21 (221 222 223) 23)
|
|
|
80 |
with:#(33 (321 322 323) 33).
|
|
|
81 |
a valueUsingSubject:obj
|
|
|
82 |
[exEnd]
|
|
69
|
83 |
|
|
|
84 |
|
|
|
85 |
|
|
231
|
86 |
[exBegin]
|
|
|
87 |
|a obj|
|
|
69
|
88 |
|
|
231
|
89 |
a := ProtocolAdaptor accessPath:#(1 2 origin).
|
|
|
90 |
obj := Array with:(Array with:1@1 with:(1@2 corner:100@100))
|
|
|
91 |
with:(Array with:2@1 with:2@2)
|
|
|
92 |
with:(Array with:3@1 with:3@2).
|
|
|
93 |
a valueUsingSubject:obj
|
|
|
94 |
[exEnd]
|
|
69
|
95 |
|
|
|
96 |
|
|
|
97 |
|
|
231
|
98 |
[exBegin]
|
|
|
99 |
|a model|
|
|
69
|
100 |
|
|
231
|
101 |
a := ProtocolAdaptor accessPath:#(1 2 origin).
|
|
|
102 |
model := (Array with:(Array with:1@1 with:(1@2 corner:100@100))
|
|
|
103 |
with:(Array with:2@1 with:2@2)
|
|
|
104 |
with:(Array with:3@1 with:3@2)) asValue.
|
|
|
105 |
a subjectChannel:model.
|
|
|
106 |
a value
|
|
|
107 |
[exEnd]
|
|
69
|
108 |
"
|
|
|
109 |
! !
|
|
|
110 |
|
|
|
111 |
!ProtocolAdaptor class methodsFor:'instance creation'!
|
|
|
112 |
|
|
|
113 |
accessPath:aCollectionOfSelectors
|
|
|
114 |
^ (self new) accessPath:aCollectionOfSelectors
|
|
|
115 |
!
|
|
|
116 |
|
|
|
117 |
subject:anObject
|
|
|
118 |
^ (self new) subject:anObject
|
|
|
119 |
!
|
|
|
120 |
|
|
125
|
121 |
subject:anObject accessPath:aCollectionOfSelectors
|
|
|
122 |
^ (self new) subject:anObject; accessPath:aCollectionOfSelectors
|
|
|
123 |
!
|
|
|
124 |
|
|
69
|
125 |
subject:anObject sendsUpdates:aBoolean
|
|
186
|
126 |
^ (self new) subject:anObject; subjectSendsUpdates:aBoolean
|
|
|
127 |
|
|
|
128 |
"Modified: 18.4.1996 / 01:45:34 / cg"
|
|
69
|
129 |
!
|
|
|
130 |
|
|
|
131 |
subject:anObject sendsUpdates:aBoolean accessPath:aCollectionOfSelectors
|
|
186
|
132 |
^ (self new) subject:anObject; subjectSendsUpdates:aBoolean; accessPath:aCollectionOfSelectors
|
|
|
133 |
|
|
|
134 |
"Modified: 18.4.1996 / 01:45:38 / cg"
|
|
69
|
135 |
!
|
|
|
136 |
|
|
|
137 |
subjectChannel:aValueHolder
|
|
|
138 |
^ (self new) subjectChannel:aValueHolder
|
|
|
139 |
!
|
|
|
140 |
|
|
125
|
141 |
subjectChannel:aValueHolder accessPath:aCollectionOfSelectors
|
|
|
142 |
^ (self new) subjectChannel:aValueHolder; accessPath:aCollectionOfSelectors
|
|
|
143 |
!
|
|
|
144 |
|
|
69
|
145 |
subjectChannel:aValueHolder sendsUpdates:aBoolean
|
|
186
|
146 |
^ (self new) subjectChannel:aValueHolder; subjectSendsUpdates:aBoolean
|
|
|
147 |
|
|
|
148 |
"Modified: 18.4.1996 / 01:45:45 / cg"
|
|
69
|
149 |
!
|
|
|
150 |
|
|
|
151 |
subjectChannel:aValueHolder sendsUpdates:aBoolean accessPath:aCollectionOfSelectors
|
|
186
|
152 |
^ (self new) subjectChannel:aValueHolder; subjectSendsUpdates:aBoolean; accessPath:aCollectionOfSelectors
|
|
|
153 |
|
|
|
154 |
"Modified: 18.4.1996 / 01:45:50 / cg"
|
|
69
|
155 |
! !
|
|
|
156 |
|
|
|
157 |
!ProtocolAdaptor methodsFor:'accessing'!
|
|
|
158 |
|
|
125
|
159 |
setValue:newValue
|
|
|
160 |
"set the value in my subject or subjectChannel."
|
|
|
161 |
|
|
|
162 |
|obj|
|
|
|
163 |
|
|
|
164 |
subject notNil ifTrue:[
|
|
|
165 |
obj := subject.
|
|
|
166 |
] ifFalse:[
|
|
|
167 |
obj := subjectChannel value
|
|
|
168 |
].
|
|
|
169 |
^ self setValue:newValue usingSubject:obj
|
|
|
170 |
!
|
|
|
171 |
|
|
69
|
172 |
setValue:newValue usingSubject:anObject
|
|
|
173 |
"set a value in anObject, using the selectors in accessPath.
|
|
|
174 |
A helper for setValue:."
|
|
|
175 |
|
|
|
176 |
|obj lastIndex|
|
|
|
177 |
|
|
|
178 |
obj := anObject.
|
|
|
179 |
lastIndex := accessPath size.
|
|
|
180 |
accessPath keysAndValuesDo:[:idx :aSelectorOrIndex |
|
|
|
181 |
aSelectorOrIndex isInteger ifTrue:[
|
|
|
182 |
idx == lastIndex ifTrue:[
|
|
|
183 |
obj at:aSelectorOrIndex put:newValue
|
|
|
184 |
] ifFalse:[
|
|
|
185 |
obj := obj at:aSelectorOrIndex
|
|
|
186 |
]
|
|
|
187 |
] ifFalse:[
|
|
|
188 |
idx == lastIndex ifTrue:[
|
|
|
189 |
obj perform:(aSelectorOrIndex , ':') asSymbol with:newValue
|
|
|
190 |
] ifFalse:[
|
|
|
191 |
obj := obj perform:aSelectorOrIndex
|
|
|
192 |
]
|
|
|
193 |
]
|
|
|
194 |
].
|
|
|
195 |
^ newValue
|
|
|
196 |
!
|
|
|
197 |
|
|
125
|
198 |
value
|
|
|
199 |
"return the value from my subject or subjectChannel."
|
|
|
200 |
|
|
|
201 |
|obj|
|
|
|
202 |
|
|
|
203 |
subject notNil ifTrue:[
|
|
|
204 |
obj := subject.
|
|
|
205 |
] ifFalse:[
|
|
|
206 |
obj := subjectChannel value
|
|
|
207 |
].
|
|
|
208 |
^ self valueUsingSubject:obj
|
|
|
209 |
!
|
|
|
210 |
|
|
733
|
211 |
value:newValue
|
|
|
212 |
"set my value & send change notifications to my dependents
|
|
|
213 |
if it changed. But only if my subject does not itself
|
|
|
214 |
send change notifications (otherwise, we'd send double notifications)."
|
|
|
215 |
|
|
|
216 |
|oldValue|
|
|
|
217 |
|
|
|
218 |
oldValue := self value.
|
|
|
219 |
oldValue ~~ newValue ifTrue:[
|
|
|
220 |
self setValue:newValue.
|
|
|
221 |
subjectSendsUpdates ifFalse:[
|
|
|
222 |
self changed:#value
|
|
|
223 |
]
|
|
|
224 |
]
|
|
|
225 |
|
|
|
226 |
"Created: / 1.11.1997 / 14:04:45 / cg"
|
|
|
227 |
!
|
|
|
228 |
|
|
69
|
229 |
valueUsingSubject:anObject
|
|
|
230 |
"return the value from anObject, using the selectors in accessPath.
|
|
|
231 |
A helper for value."
|
|
|
232 |
|
|
|
233 |
|obj|
|
|
|
234 |
|
|
|
235 |
obj := anObject.
|
|
|
236 |
accessPath notNil ifTrue:[
|
|
|
237 |
accessPath do:[:aSelectorOrIndex |
|
|
|
238 |
aSelectorOrIndex isInteger ifTrue:[
|
|
|
239 |
obj := obj at:aSelectorOrIndex
|
|
|
240 |
] ifFalse:[
|
|
|
241 |
obj := obj perform:aSelectorOrIndex
|
|
|
242 |
]
|
|
|
243 |
].
|
|
|
244 |
].
|
|
|
245 |
^ obj
|
|
|
246 |
! !
|
|
|
247 |
|
|
|
248 |
!ProtocolAdaptor methodsFor:'accessing-spec'!
|
|
|
249 |
|
|
125
|
250 |
accessPath
|
|
231
|
251 |
"return the access path"
|
|
|
252 |
|
|
125
|
253 |
^ accessPath
|
|
231
|
254 |
|
|
|
255 |
"Modified: 27.4.1996 / 16:20:48 / cg"
|
|
125
|
256 |
!
|
|
69
|
257 |
|
|
125
|
258 |
accessPath:aCollectionOfSelectors
|
|
231
|
259 |
"set the access path"
|
|
|
260 |
|
|
125
|
261 |
accessPath := aCollectionOfSelectors
|
|
231
|
262 |
|
|
|
263 |
"Modified: 27.4.1996 / 16:20:53 / cg"
|
|
125
|
264 |
!
|
|
|
265 |
|
|
|
266 |
subject
|
|
231
|
267 |
"return the subject"
|
|
|
268 |
|
|
125
|
269 |
^ subject
|
|
231
|
270 |
|
|
|
271 |
"Modified: 27.4.1996 / 16:21:03 / cg"
|
|
69
|
272 |
!
|
|
|
273 |
|
|
125
|
274 |
subject:anObject
|
|
231
|
275 |
"set the subject"
|
|
|
276 |
|
|
125
|
277 |
subject notNil ifTrue:[
|
|
231
|
278 |
subject removeDependent:self
|
|
125
|
279 |
].
|
|
|
280 |
subject := anObject.
|
|
|
281 |
self changed:#value.
|
|
|
282 |
subject notNil ifTrue:[
|
|
231
|
283 |
subject addDependent:self
|
|
125
|
284 |
].
|
|
231
|
285 |
|
|
|
286 |
"Modified: 27.4.1996 / 16:21:09 / cg"
|
|
125
|
287 |
!
|
|
69
|
288 |
|
|
125
|
289 |
subjectChannel
|
|
231
|
290 |
"return the subjectChannel"
|
|
|
291 |
|
|
125
|
292 |
^ subjectChannel
|
|
231
|
293 |
|
|
|
294 |
"Modified: 27.4.1996 / 16:21:21 / cg"
|
|
69
|
295 |
!
|
|
|
296 |
|
|
|
297 |
subjectChannel:aValueHolder
|
|
231
|
298 |
"set the subjectChannel"
|
|
|
299 |
|
|
69
|
300 |
|oldChannel|
|
|
|
301 |
|
|
100
|
302 |
subjectChannel notNil ifTrue:[
|
|
231
|
303 |
subjectChannel removeDependent:self
|
|
100
|
304 |
].
|
|
69
|
305 |
oldChannel := subjectChannel.
|
|
|
306 |
subjectChannel := aValueHolder.
|
|
100
|
307 |
subjectChannel notNil ifTrue:[
|
|
231
|
308 |
subjectChannel addDependent:self
|
|
100
|
309 |
].
|
|
69
|
310 |
oldChannel notNil ifTrue:[
|
|
231
|
311 |
self changed:#value.
|
|
69
|
312 |
].
|
|
100
|
313 |
|
|
|
314 |
"Modified: 6.9.1995 / 01:19:27 / claus"
|
|
231
|
315 |
"Modified: 27.4.1996 / 16:21:26 / cg"
|
|
69
|
316 |
!
|
|
|
317 |
|
|
125
|
318 |
subjectSendsUpdates
|
|
|
319 |
"return true, if the subject sends updates itself
|
|
|
320 |
If true, the receiver will not send updates on changes"
|
|
|
321 |
|
|
|
322 |
^ subjectSendsUpdates
|
|
69
|
323 |
!
|
|
|
324 |
|
|
125
|
325 |
subjectSendsUpdates:aBoolean
|
|
|
326 |
"set/clear the flag which states if the subject sends updates itself.
|
|
|
327 |
If true, the receiver will not send updates on changes"
|
|
69
|
328 |
|
|
125
|
329 |
subjectSendsUpdates := aBoolean.
|
|
69
|
330 |
! !
|
|
|
331 |
|
|
125
|
332 |
!ProtocolAdaptor methodsFor:'change & update'!
|
|
|
333 |
|
|
|
334 |
update:something with:aPArameter from:changedObject
|
|
|
335 |
"translate updates from my subject into value-changes towards
|
|
|
336 |
my dependents. Since I have no specific aspect, every change is forwarded"
|
|
|
337 |
|
|
|
338 |
(changedObject == subject
|
|
|
339 |
or:[changedObject == subjectChannel]) ifTrue:[
|
|
|
340 |
self changed:#value.
|
|
|
341 |
^ self
|
|
|
342 |
].
|
|
|
343 |
! !
|
|
|
344 |
|
|
733
|
345 |
!ProtocolAdaptor ignoredMethodsFor:'change notification'!
|
|
125
|
346 |
|
|
|
347 |
changed:aspect
|
|
231
|
348 |
"redefined to suppress change notifications, if my subject already did it"
|
|
|
349 |
|
|
125
|
350 |
subjectSendsUpdates ifFalse:[
|
|
231
|
351 |
super changed:aspect
|
|
125
|
352 |
]
|
|
231
|
353 |
|
|
|
354 |
"Modified: 27.4.1996 / 16:20:28 / cg"
|
|
125
|
355 |
! !
|
|
|
356 |
|
|
|
357 |
!ProtocolAdaptor methodsFor:'initialization'!
|
|
|
358 |
|
|
|
359 |
initialize
|
|
231
|
360 |
"setup, assuming that the subject does not send change notifications"
|
|
|
361 |
|
|
125
|
362 |
super initialize.
|
|
231
|
363 |
subjectSendsUpdates := false.
|
|
|
364 |
|
|
|
365 |
"Modified: 27.4.1996 / 16:21:56 / cg"
|
|
125
|
366 |
! !
|
|
|
367 |
|
|
129
|
368 |
!ProtocolAdaptor class methodsFor:'documentation'!
|
|
|
369 |
|
|
|
370 |
version
|
|
733
|
371 |
^ '$Header: /cvs/stx/stx/libview2/ProtocolAdaptor.st,v 1.13 1997-11-02 17:50:19 cg Exp $'
|
|
129
|
372 |
! !
|