BufferedValueHolder.st
author Claus Gittinger <cg@exept.de>
Thu, 25 Apr 1996 18:43:54 +0200
changeset 223 b65dc250db8d
parent 129 f890eaabc487
child 231 2fec6188bd28
permissions -rw-r--r--
documentation
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
74
claus
parents: 72
diff changeset
     1
"
claus
parents: 72
diff changeset
     2
 COPYRIGHT (c) 1995 by Claus Gittinger
claus
parents: 72
diff changeset
     3
	      All Rights Reserved
claus
parents: 72
diff changeset
     4
claus
parents: 72
diff changeset
     5
 This software is furnished under a license and may be used
claus
parents: 72
diff changeset
     6
 only in accordance with the terms of that license and with the
claus
parents: 72
diff changeset
     7
 inclusion of the above copyright notice.   This software may not
claus
parents: 72
diff changeset
     8
 be provided or otherwise made available to, or used by, any
claus
parents: 72
diff changeset
     9
 other person.  No title to or ownership of the software is
claus
parents: 72
diff changeset
    10
 hereby transferred.
claus
parents: 72
diff changeset
    11
"
claus
parents: 72
diff changeset
    12
125
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
    13
ValueHolder subclass:#BufferedValueHolder
223
b65dc250db8d documentation
Claus Gittinger <cg@exept.de>
parents: 129
diff changeset
    14
	instanceVariableNames:'subject triggerChannel bufferedValue'
b65dc250db8d documentation
Claus Gittinger <cg@exept.de>
parents: 129
diff changeset
    15
	classVariableNames:'NotYetAssigned'
b65dc250db8d documentation
Claus Gittinger <cg@exept.de>
parents: 129
diff changeset
    16
	poolDictionaries:''
b65dc250db8d documentation
Claus Gittinger <cg@exept.de>
parents: 129
diff changeset
    17
	category:'Interface-Support-Models'
71
claus
parents:
diff changeset
    18
!
claus
parents:
diff changeset
    19
claus
parents:
diff changeset
    20
!BufferedValueHolder class methodsFor:'documentation'!
claus
parents:
diff changeset
    21
claus
parents:
diff changeset
    22
copyright
claus
parents:
diff changeset
    23
"
claus
parents:
diff changeset
    24
 COPYRIGHT (c) 1995 by Claus Gittinger
claus
parents:
diff changeset
    25
	      All Rights Reserved
claus
parents:
diff changeset
    26
claus
parents:
diff changeset
    27
 This software is furnished under a license and may be used
claus
parents:
diff changeset
    28
 only in accordance with the terms of that license and with the
claus
parents:
diff changeset
    29
 inclusion of the above copyright notice.   This software may not
claus
parents:
diff changeset
    30
 be provided or otherwise made available to, or used by, any
claus
parents:
diff changeset
    31
 other person.  No title to or ownership of the software is
claus
parents:
diff changeset
    32
 hereby transferred.
claus
parents:
diff changeset
    33
"
claus
parents:
diff changeset
    34
!
claus
parents:
diff changeset
    35
claus
parents:
diff changeset
    36
documentation
claus
parents:
diff changeset
    37
"
90
claus
parents: 74
diff changeset
    38
    a bufferedValueHolder keeps a temporary copy of the realHolders value,
71
claus
parents:
diff changeset
    39
    and only does a real store of the value when triggered.
claus
parents:
diff changeset
    40
    Triggering is done by depending on a trigger objects value, which is
claus
parents:
diff changeset
    41
    typically a ValueHolder for a boolean, which is set by an ok-button.
claus
parents:
diff changeset
    42
claus
parents:
diff changeset
    43
    Notice: this class was implemented using protocol information
claus
parents:
diff changeset
    44
    from alpha testers - it may not be complete or compatible to
claus
parents:
diff changeset
    45
    the corresponding ST-80 class. If you encounter any incompatibilities,
claus
parents:
diff changeset
    46
    please forward a note to the ST/X team.
223
b65dc250db8d documentation
Claus Gittinger <cg@exept.de>
parents: 129
diff changeset
    47
b65dc250db8d documentation
Claus Gittinger <cg@exept.de>
parents: 129
diff changeset
    48
    [author:]
b65dc250db8d documentation
Claus Gittinger <cg@exept.de>
parents: 129
diff changeset
    49
        Claus Gittinger
71
claus
parents:
diff changeset
    50
"
claus
parents:
diff changeset
    51
!
claus
parents:
diff changeset
    52
claus
parents:
diff changeset
    53
examples 
claus
parents:
diff changeset
    54
"
72
claus
parents: 71
diff changeset
    55
    unbuffered (values are changed, even if not accepted,
claus
parents: 71
diff changeset
    56
    iff a field is left with Return or accept is done in a field):
71
claus
parents:
diff changeset
    57
claus
parents:
diff changeset
    58
	|firstName lastName dialog|
claus
parents:
diff changeset
    59
72
claus
parents: 71
diff changeset
    60
	firstName :=  'foo' asValue.
claus
parents: 71
diff changeset
    61
	lastName := 'bar' asValue.
71
claus
parents:
diff changeset
    62
claus
parents:
diff changeset
    63
	dialog := Dialog new.
claus
parents:
diff changeset
    64
	(dialog addTextLabel:'Name:') layout:#left.
claus
parents:
diff changeset
    65
	dialog addInputFieldOn:firstName.
claus
parents:
diff changeset
    66
	dialog addVerticalSpace.
claus
parents:
diff changeset
    67
	(dialog addTextLabel:'Address:') layout:#left.
claus
parents:
diff changeset
    68
	dialog addInputFieldOn:lastName.
claus
parents:
diff changeset
    69
claus
parents:
diff changeset
    70
	dialog addAbortButton; addOkButton.
claus
parents:
diff changeset
    71
claus
parents:
diff changeset
    72
	dialog open.
claus
parents:
diff changeset
    73
claus
parents:
diff changeset
    74
	Transcript show:firstName value; show:' '; showCr:lastName value
claus
parents:
diff changeset
    75
72
claus
parents: 71
diff changeset
    76
claus
parents: 71
diff changeset
    77
    buffered (values are only stored when accepted; undo reloads old values)
claus
parents: 71
diff changeset
    78
    (use an instance of TriggerValue. If a ValueHolder was used, we had
claus
parents: 71
diff changeset
    79
     to temporarily set its value back to nil, to have the change really be
claus
parents: 71
diff changeset
    80
     forwarded to its dependends)
71
claus
parents:
diff changeset
    81
claus
parents:
diff changeset
    82
	|firstName lastName trigger dialog|
claus
parents:
diff changeset
    83
72
claus
parents: 71
diff changeset
    84
	firstName :=  'foo' asValue.
claus
parents: 71
diff changeset
    85
	lastName := 'bar' asValue.
claus
parents: 71
diff changeset
    86
	trigger := TriggerValue new.
71
claus
parents:
diff changeset
    87
claus
parents:
diff changeset
    88
	dialog := Dialog new.
claus
parents:
diff changeset
    89
	(dialog addTextLabel:'Name:') layout:#left.
claus
parents:
diff changeset
    90
	dialog addInputFieldOn:(BufferedValueHolder
claus
parents:
diff changeset
    91
				    subject:firstName
claus
parents:
diff changeset
    92
				    triggerChannel:trigger).
claus
parents:
diff changeset
    93
	dialog addVerticalSpace.
claus
parents:
diff changeset
    94
	(dialog addTextLabel:'Address:') layout:#left.
claus
parents:
diff changeset
    95
	dialog addInputFieldOn:(BufferedValueHolder
claus
parents:
diff changeset
    96
				    subject:lastName
claus
parents:
diff changeset
    97
				    triggerChannel:trigger).
claus
parents:
diff changeset
    98
claus
parents:
diff changeset
    99
	dialog addAbortButton; 
claus
parents:
diff changeset
   100
	       addButton:(Button new 
claus
parents:
diff changeset
   101
				label:'undo'; 
claus
parents:
diff changeset
   102
				action:[trigger value:false]);
claus
parents:
diff changeset
   103
	       addOkButton.
claus
parents:
diff changeset
   104
claus
parents:
diff changeset
   105
	dialog open.
72
claus
parents: 71
diff changeset
   106
	dialog accepted ifTrue:[
claus
parents: 71
diff changeset
   107
	    trigger value:true
claus
parents: 71
diff changeset
   108
	].
71
claus
parents:
diff changeset
   109
claus
parents:
diff changeset
   110
	Transcript show:firstName value; show:' '; showCr:lastName value
claus
parents:
diff changeset
   111
"
claus
parents:
diff changeset
   112
! !
claus
parents:
diff changeset
   113
claus
parents:
diff changeset
   114
!BufferedValueHolder class methodsFor:'initialization'!
claus
parents:
diff changeset
   115
claus
parents:
diff changeset
   116
intialize
claus
parents:
diff changeset
   117
    NotYetAssigned := Object new
claus
parents:
diff changeset
   118
! !
claus
parents:
diff changeset
   119
claus
parents:
diff changeset
   120
!BufferedValueHolder class methodsFor:'instance creation'!
claus
parents:
diff changeset
   121
claus
parents:
diff changeset
   122
subject:someModel triggerChannel:aTrigger
claus
parents:
diff changeset
   123
    "return a new BufferedValueHolder offering a buffered copy of someModels
claus
parents:
diff changeset
   124
     value - only updating this value, when aTrigger changes to true."
claus
parents:
diff changeset
   125
claus
parents:
diff changeset
   126
    ^ self new subject:someModel; triggerChannel:aTrigger
claus
parents:
diff changeset
   127
! !
claus
parents:
diff changeset
   128
125
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   129
!BufferedValueHolder methodsFor:'accessing'!
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   130
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   131
setValue:anObject
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   132
    "set my value without notification."
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   133
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   134
    bufferedValue := anObject.
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   135
!
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   136
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   137
subject:someModel
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   138
    subject notNil ifTrue:[
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   139
	subject removeDependent:self
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   140
    ].
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   141
    subject := someModel.
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   142
    subject notNil ifTrue:[
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   143
	subject addDependent:self
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   144
    ]
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   145
!
71
claus
parents:
diff changeset
   146
125
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   147
triggerChannel:aTrigger
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   148
    triggerChannel notNil ifTrue:[
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   149
	triggerChannel removeDependent:self
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   150
    ].
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   151
    triggerChannel := aTrigger.
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   152
    triggerChannel notNil ifTrue:[
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   153
	triggerChannel addDependent:self
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   154
    ]
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   155
!
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   156
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   157
value
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   158
    "return my value"
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   159
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   160
    bufferedValue == NotYetAssigned ifTrue:[
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   161
	bufferedValue := subject value
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   162
    ].
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   163
    ^ bufferedValue
71
claus
parents:
diff changeset
   164
! !
125
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   165
71
claus
parents:
diff changeset
   166
!BufferedValueHolder methodsFor:'change & update'!
claus
parents:
diff changeset
   167
claus
parents:
diff changeset
   168
update:something with:aParameter from:changedObject
claus
parents:
diff changeset
   169
    changedObject == triggerChannel ifTrue:[
claus
parents:
diff changeset
   170
	triggerChannel value == true ifTrue:[
claus
parents:
diff changeset
   171
	    "
claus
parents:
diff changeset
   172
	     now, store the buffered value into the subject
claus
parents:
diff changeset
   173
	    "
claus
parents:
diff changeset
   174
	    subject value:bufferedValue.
claus
parents:
diff changeset
   175
	    ^ self
claus
parents:
diff changeset
   176
	].
claus
parents:
diff changeset
   177
	triggerChannel value == false ifTrue:[
claus
parents:
diff changeset
   178
	    "
claus
parents:
diff changeset
   179
	     cancel: flush my buffered value
claus
parents:
diff changeset
   180
	    "
claus
parents:
diff changeset
   181
	    bufferedValue := NotYetAssigned.
claus
parents:
diff changeset
   182
	].
claus
parents:
diff changeset
   183
	self notifyChange:#value. 
claus
parents:
diff changeset
   184
	^ self
claus
parents:
diff changeset
   185
    ].
claus
parents:
diff changeset
   186
    changedObject == subject ifTrue:[
claus
parents:
diff changeset
   187
	bufferedValue := NotYetAssigned.
claus
parents:
diff changeset
   188
	self notifyChange:#value.
claus
parents:
diff changeset
   189
	^ self
claus
parents:
diff changeset
   190
    ].
claus
parents:
diff changeset
   191
! !
claus
parents:
diff changeset
   192
125
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   193
!BufferedValueHolder methodsFor:'initialization'!
71
claus
parents:
diff changeset
   194
125
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   195
initialize
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   196
    super initialize.
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   197
    bufferedValue := NotYetAssigned
fa5b5e4336bf checkin from browser
Claus Gittinger <cg@exept.de>
parents: 114
diff changeset
   198
! !
71
claus
parents:
diff changeset
   199
129
f890eaabc487 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 125
diff changeset
   200
!BufferedValueHolder class methodsFor:'documentation'!
f890eaabc487 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 125
diff changeset
   201
f890eaabc487 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 125
diff changeset
   202
version
223
b65dc250db8d documentation
Claus Gittinger <cg@exept.de>
parents: 129
diff changeset
   203
    ^ '$Header: /cvs/stx/stx/libview2/BufferedValueHolder.st,v 1.9 1996-04-25 16:42:50 cg Exp $'
129
f890eaabc487 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 125
diff changeset
   204
! !