hg/stx-libwidg: comparison EditField.st

equal deleted inserted replaced

-:4e63bbdb266a
+:04ec3fda7c11
 "
 'From Smalltalk/X, Version:2.10.5 on 4-may-1995 at 8:46:55 am'!
 EditTextView subclass:#EditField
-	 instanceVariableNames:'leaveAction enabled enableAction alwaysAccept crAction tabAction
+	 instanceVariableNames:'leaveAction enabled enableAction crAction tabAction
-		converter acceptAction leaveKeys'
+		converter acceptAction leaveKeys alwaysAccept acceptOnLeave acceptOnReturn'
 	 classVariableNames:'DefaultForegroundColor DefaultBackgroundColor
 		DefaultSelectionForegroundColor DefaultSelectionBackgroundColor
 		DefaultFont'
 	 poolDictionaries:''
 	 category:'Views-Text'
 EditField comment:'
 COPYRIGHT (c) 1990 by Claus Gittinger
 	      All Rights Reserved
-$Header: /cvs/stx/stx/libwidg/EditField.st,v 1.19 1995-05-06 14:16:58 claus Exp $
+$Header: /cvs/stx/stx/libwidg/EditField.st,v 1.20 1995-05-07 00:15:56 claus Exp $
 '!
 !EditField class methodsFor:'documentation'!
 copyright
 "
 !
 version
 "
-$Header: /cvs/stx/stx/libwidg/EditField.st,v 1.19 1995-05-06 14:16:58 claus Exp $
+$Header: /cvs/stx/stx/libwidg/EditField.st,v 1.20 1995-05-07 00:15:56 claus Exp $
 "
 !
 documentation
 "
 						 field has to be enabled next)
 enabled        <Boolean>                  if false, input is ignored.
 enableAction   <Block | nil>
+crAction       <Block | nil>              if non-nil, keyboard input of a cr are not
+						handled specially, instead this block is evaluated
+						(however, this block can perform additional checks and send
+						 a #accept then)
+tabAction      <Block | nil>              if non-nil, keyboard input of a tab character
+						is not entered into the text, instead this block
+						is evaluated.
+converter      <PrintConverter | nil>     if non-nil, this is supposed to convert between
+						the object and its printed representation.
+						Defaults to nil i.e. assume that strings are edited.
+acceptAction   <Block | nil>              if non-nil, this is performed in addition to
+						the leaveAction.
+leaveKeys      <Collection>               keys which are interpreted as 'leving the field'
 alwaysAccept   <Boolean>                  if true, every change of the text is immediately
 						forwardd to the model/acceptBlock.
 						Default is false i.e. only forward changes
 						on accept.
-crAction       <Block | nil>              if non-nil, keyboard input of a cr are not
+acceptOnLeave  <Boolean>                  if true, leaving the field (via cursor keys)
-						handled specially, instead this block is evaluated
+						automatically accepts the value into the model.
-						(however, this block can perform additional checks and send
+						Default is false.
-						 a #accept then)
+acceptOnReturn <Boolean>                  if true, leaving the field via return
-tabAction      <Block | nil>              if non-nil, keyboard input of a tab character
+						automatically accepts the value into the model.
-						is not entered into the text, instead this block
+						Default is true.
-						is evaluated.
-converter      <PrintConverter | nil>     if non-nil, this is supposed to convert between
-						the object and its printed representation.
-						Defaults to nil i.e. assume that strings are edited.
-acceptAction   <Block | nil>              if non-nil, this is performed in addition to
-						the leaveAction.
-leaveKeys      <Collection>               keys which are interpreted as 'leving the field'
 "
 !
 examples
 "
-basic field:
+see more examples in EnterFieldGroup>>examples.
+basic field in a view:
 	|top field|
 	top := StandardSystemView new.
 	top extent:200@100.
 	field := EditField origin:0.0@0.0 in:top.
 	field width:1.0.        'let its height as-is'.
 	top open
+forward input in topView to field:
+	|top field|
+	top := StandardSystemView new.
+	top extent:200@100.
+	field := EditField origin:0.0@0.0 in:top.
+	field width:1.0.        'let its height as-is'.
+	top delegate:(KeyboardForwarder toView:field).
+	top open
 just to make it look better: set some inset:
 	|top field|
 	field leftInset:ViewSpacing;
 	      rightInset:ViewSpacing.
 	top open
 give it an initial contents:
 	|top field|
 	top := StandardSystemView new.
 	      rightInset:ViewSpacing.
 	field editValue:'hello world'.
 	top open
 and have it preselected:
 	|top field|
 	top := StandardSystemView new.
 	      rightInset:ViewSpacing.
 	field editValue:'hello world' selected:true.
 	top open
 have part of it preselected:
 	|top field|
 	top := StandardSystemView new.
 	      rightInset:ViewSpacing.
 	field editValue:'hello world';
 	      selectFromCharacterPosition:1 to:5.
 	top open
 use a converter:
 - numbers:
 	|top field|
 	field converter:(PrintConverter new initForDate).
 	field editValue:Date today.
 	field acceptAction:[:value | Transcript show:value class name; space; showCr:value].
 	field crAction:[field accept. top destroy].
 	top open.
 setting alwaysAccept, makes the field update with every key:
 - numbers:
 	|top field|
 	field editValue:1234.
 	field acceptAction:[:value | Transcript showCr:value].
 	field crAction:[field accept. top destroy].
 	top open.
 use a model:
 (see changing model value in inspector when return is pressed in the field)
 	|top field model|
 	      rightInset:ViewSpacing.
 	field model:model.
 	top open.
 	model inspect.
 two views on the same model:
 	|top1 top2 field1 field2 model|
 	field2 width:1.0.
 	field2 leftInset:ViewSpacing;
 	      rightInset:ViewSpacing.
 	field2 model:model.
 	top2 open.
 just an example; a checkBox and an editField on the same model:
 	|top1 top2 field1 box model|
 enabled := true.
 fixedSize := true.
 nFullLinesShown := 1.
 nLinesShown := 1.
 alwaysAccept := false.
+acceptOnLeave := false.
+acceptOnReturn := true.
 leaveKeys := self class defaultLeaveKeys.
 cursorShown := true
 !
 initStyle
 ]
 !
 contents:someText
 "set the contents from a string
-- redefined to place the cursor to the end"
+- redefined to place the cursor to the end.
+In your application, please use #editValue:;
+it uses a converter (if any) and is compatible to ST-80."
 super contents:someText.
 self cursorCol:(someText size + 1).
 !
 contents
 "return contents as a string
-- redefined since EditFields hold only one line of text"
+- redefined since EditFields hold only one line of text.
+In your application, please use #editValue;
+it uses a converter (if any) and is compatible to ST-80."
 list isNil ifTrue:[^ ''].
 (list size == 0) ifTrue:[^ ''].
 ^ list at:1
 !
 "define an action to be evaluated when field is left by return key"
 leaveAction := aBlock
 !
+leaveKeys:aCollectionOfKeySymbols
+"define the set of keys which are interpreted as leaveKeys.
+I.e. those that make the field inactive and accept (if acceptOnLeave is true).
+The default is a set of #CursorUp, #CursorDown, #Next, #Prior and #Return."
+leaveKeys := aCollectionOfKeySymbols
+!
 crAction:aBlock
 "define an action to be evaluated when the return key is pressed."
 crAction := aBlock
 !
 tabAction := aBlock
 !
 alwaysAccept:aBoolean
-"set/clear the alwaysAccept flag"
+"set/clear the alwaysAccept flag. The default is false."
 alwaysAccept := aBoolean
+!
+acceptOnReturn:aBoolean
+"set/clear the acceptOnReturn flag. The default is true."
+acceptOnReturn := aBoolean
+!
+acceptOnLeave:aBoolean
+"set/clear the acceptOnLeave flag. The default is false."
+acceptOnLeave := aBoolean
 !
 converter
 "return the converter (if any)."
 leave ifTrue:[
 	leaveAction notNil ifTrue:[
 	    leaveAction value:key
 	].
-	self accept.
+	((key == #Return and:[acceptOnReturn])
+	or:[key ~~ #Return and:[acceptOnLeave]]) ifTrue:[
+	    self accept.
+	].
 	x >= 0 ifTrue:[
 	    "
 	     let superview know about the leave ...
 	     This is a temporary kludge for the tableWidget -
 	     it is no clean coding style. Should make the tableWidget

changeset 122	04ec3fda7c11
parent 121	4e63bbdb266a
child 125	3ffa271732f7