"

 COPYRIGHT (c) 1990 by 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.

"

EditTextView subclass:#EditField

	 instanceVariableNames:'leaveAction enabled enableAction crAction tabAction converter

		leaveKeys immediateAccept acceptOnLeave acceptOnReturn

		lengthLimit entryCompletionBlock passwordCharacter

		cursorMovementWhenUpdating'

	 classVariableNames:'DefaultForegroundColor DefaultBackgroundColor

		DefaultSelectionForegroundColor DefaultSelectionBackgroundColor

		DefaultFont'

	 poolDictionaries:''

	 category:'Views-Text'

!

!EditField class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1990 by 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

"

    an editable text-field. Realized by using an EditTextView,

    and forcing its size to 1 line - disabling cursor movement

    in the vertical direction.

    Instance variables:

      leaveAction    <Block | nil>              if non-nil, this is evaluated with

						the key (#Return, #CursorUp etc.) when

						the field is left via keyboard keys.

						(fieldGroups use this to decide which

						 field has to be enabled next)

      enabled        <Boolean>                  if false, input is ignored.

      enableAction   <Block | nil>              action performed if the field is

						enabled via an explicit click.

						(this is used by the group to

						 set the active field to the clicked upon field)

      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.

      leaveKeys      <Collection>               keys which are interpreted as 'leving the field'

      immediateAccept   <Boolean>               if true, every change of the text is immediately

						forwarded to the model/acceptBlock. If false,

						the changed value is only stored in the model

						if the field is left or accepted.

						Default is false.

      acceptOnLeave  <Boolean>                  if true, leaving the field (via cursor keys)

						automatically accepts the value into the model.

						Default is true.

      acceptOnReturn <Boolean>                  if true, leaving the field via return

						automatically accepts the value into the model.

						Default is true.

"

!

examples 

"

    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 the field:

    (currently, the field does not know this - therefore,

     its been told here ... this may change)

	|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).

	field hasKeyboardFocus:true.

	top open

    to make it look better: set some inset:

	|top field|

	top := StandardSystemView new.

	top extent:200@100.

	field := EditField origin:0.0@ViewSpacing in:top.

	field width:1.0.        'let its height as-is'.

	field leftInset:ViewSpacing;

	      rightInset:ViewSpacing.

	top open

    give it an initial contents:

	|top field|

	top := StandardSystemView new.

	top extent:200@100.

	field := EditField origin:0.0@ViewSpacing in:top.

	field width:1.0.       

	field leftInset:ViewSpacing;

	      rightInset:ViewSpacing.

	field editValue:'hello world'.

	top open

    have it preselected:

	|top field|

	top := StandardSystemView new.

	top extent:200@100.

	field := EditField origin:0.0@ViewSpacing in:top.

	field width:1.0.     

	field leftInset:ViewSpacing;

	      rightInset:ViewSpacing.

	field editValue:'hello world' selected:true.

	top open

    have part of it preselected:

	|top field|

	top := StandardSystemView new.

	top extent:200@100.

	field := EditField origin:0.0@ViewSpacing in:top.

	field width:1.0.     

	field leftInset:ViewSpacing;

	      rightInset:ViewSpacing.

	field editValue:'hello world';

	      selectFromCharacterPosition:1 to:5.

	top open

    set a size limit:

	|top field|

	top := StandardSystemView new.

	top extent:200@100.

	field := EditField origin:0.0@ViewSpacing in:top.

	field width:1.0.     

	field leftInset:ViewSpacing;

	      rightInset:ViewSpacing.

	field editValue:'hello';

	      maxChars:8.

	top open

    use a converter:

      - numbers (default to 0):

	|top field|

	top := StandardSystemView new.

	top extent:200@100.

	field := EditField origin:0.0@ViewSpacing in:top.

	field width:1.0.

	field leftInset:ViewSpacing;

	      rightInset:ViewSpacing.

	field converter:(PrintConverter new initForNumber).

	field editValue:1234.

	field acceptAction:[:value | Transcript showCr:value].

	field crAction:[field accept. top destroy].

	top open.

      - dates:

	|top field|

	top := StandardSystemView new.

	top extent:200@100.

	field := EditField origin:0.0@ViewSpacing in:top.

	field width:1.0.

	field leftInset:ViewSpacing;

	      rightInset:ViewSpacing.

	field converter:(PrintConverter new initForDate).

	field editValue:Date today.

	field acceptAction:[:value | Transcript showCr:value class name , ' ' , value printString].

	field crAction:[field accept. top destroy].

	top open.

    setting immediateAccept, makes the field update with every key:

      - immediate accept numbers, defaulting to nil:

	|top field|

	top := StandardSystemView new.

	top extent:200@100.

	field := EditField origin:0.0@ViewSpacing in:top.

	field width:1.0.

	field leftInset:ViewSpacing;

	      rightInset:ViewSpacing.

	field converter:(PrintConverter new initForNumberOrNil).

	field immediateAccept:true.

	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|

	model := 'hello world' asValue.

	top := StandardSystemView new.

	top extent:200@100.

	field := EditField origin:0.0@ViewSpacing in:top.

	field width:1.0.

	field leftInset:ViewSpacing;

	      rightInset:ViewSpacing.

	field model:model.

	field acceptOnReturn:true.

	top open.

	model inspect.

    two views on the same model (each accepts on return):

	|top1 top2 field1 field2 model|

	model := 'hello world' asValue.

	top1 := StandardSystemView new.

	top1 extent:200@100.

	field1 := EditField origin:0.0@ViewSpacing in:top1.

	field1 width:1.0.

	field1 leftInset:ViewSpacing;

	      rightInset:ViewSpacing.

	field1 model:model.

	field1 acceptOnReturn:true.

	top1 open.

	top2 := StandardSystemView new.

	top2 extent:200@100.

	field2 := EditField origin:0.0@ViewSpacing in:top2.

	field2 width:1.0.

	field2 leftInset:ViewSpacing;

	      rightInset:ViewSpacing.

	field2 model:model.

	field2 acceptOnReturn:true.

	top2 open.

    two views on the same model (no accept on return):

	|top1 top2 field1 field2 model|

	model := 'hello world' asValue.

	top1 := StandardSystemView new.

	top1 extent:200@100.

	field1 := EditField origin:0.0@ViewSpacing in:top1.

	field1 width:1.0.

	field1 leftInset:ViewSpacing;

	      rightInset:ViewSpacing.

	field1 model:model; acceptOnReturn:false.

	top1 open.

	top2 := StandardSystemView new.

	top2 extent:200@100.

	field2 := EditField origin:0.0@ViewSpacing in:top2.

	field2 width:1.0.

	field2 leftInset:ViewSpacing;

	      rightInset:ViewSpacing.

	field2 model:model; acceptOnReturn:false.

	top2 open.

    with immediate accept:

	|top1 top2 field1 field2 model|

	model := 'hello world' asValue.

	top1 := StandardSystemView new.

	top1 extent:200@100.

	field1 := EditField origin:0.0@ViewSpacing in:top1.

	field1 width:1.0.

	field1 leftInset:ViewSpacing; rightInset:ViewSpacing.

	field1 model:model; immediateAccept:true.

	top1 open.

	top2 := StandardSystemView new.

	top2 extent:200@100.

	field2 := EditField origin:0.0@ViewSpacing in:top2.

	field2 width:1.0.

	field2 leftInset:ViewSpacing; rightInset:ViewSpacing.

	field2 model:model; immediateAccept:true.

	top2 open.

    just an example; a checkBox and an editField on the same model:

	|top1 top2 field1 box model|

	model := false asValue.

	top1 := StandardSystemView new.

	top1 extent:200@100.

	field1 := EditField origin:0.0@ViewSpacing in:top1.

	field1 width:1.0.

	field1 leftInset:ViewSpacing;

	      rightInset:ViewSpacing.

	field1 converter:(PrintConverter new initForYesNo).

	field1 model:model.

	top1 open.

	top2 := StandardSystemView new.

	top2 extent:200@100.

	box := CheckBox on:model.

	box label:'on/off'.

	top2 add:box.

	top2 open.

	model inspect.

    connecting fields:

    update field2 wehenever field1 is changed.

    (normally, the processing below (xChanged) is done in your application

     class, or in a complex model. For the demonstration below, we use

     a Plug to simulate the protocol.)

	|application top field1 field2 value1 value2|

	application := Plug new.

	application respondTo:#value1Changed

			 with:[value2 value:(value1 value isNil ifTrue:[nil]

								ifFalse:[value1 value squared])].

	value1 := 1 asValue.

	value2 := 1 asValue.

	top := Dialog new.

	top extent:200@200.

	(top addTextLabel:'some number:') layout:#left.

	top addVerticalSpace.

	(top addInputFieldOn:value1 tabable:false) 

	    converter:(PrintConverter new initForNumberOrNil);

	    immediateAccept:true.

	top addVerticalSpace.

	(top addTextLabel:'squared:') layout:#left.

	top addVerticalSpace.

	(top addInputFieldOn:value2 tabable:false) 

	    converter:(PrintConverter new initForNumberOrNil).

	value1 onChangeSend:#value1Changed to:application.

	top openModeless.

    two-way connect:

    each field updates the other (notice, that we have to turn off

    onChange: notification, to avoid an endless notification cycle)

	|application top field1 field2 value1 value2|

	application := Plug new.

	application respondTo:#value1Changed

			       value2 value:(value1 value isNil ifTrue:[nil]

								ifFalse:[value1 value squared]).

			       value2 onChangeSend:#value2Changed to:application.

			      ].

	application respondTo:#value2Changed

			       value1 value:(value2 value isNil ifTrue:[nil]

								ifFalse:[value2 value sqrt]).

			       value1 onChangeSend:#value1Changed to:application.

			      ].

	value1 := 1 asValue.

	value2 := 1 asValue.

	top := Dialog new.

	top extent:200@200.

	(top addTextLabel:'some number:') layout:#left.

	top addVerticalSpace.

	(top addInputFieldOn:value1 tabable:false) 

	    converter:(PrintConverter new initForNumberOrNil);

	    immediateAccept:true.

	top addVerticalSpace.

	(top addTextLabel:'squared:') layout:#left.

	top addVerticalSpace.

	(top addInputFieldOn:value2 tabable:false) 

	    converter:(PrintConverter new initForNumberOrNil);

	    immediateAccept:true.

	value1 onChangeSend:#value1Changed to:application.

	value2 onChangeSend:#value2Changed to:application.

	top openModeless.

"

!

version

! !

!EditField class methodsFor:'defaults'!

defaultLeaveKeys

    "return the set of keys which are taken as leave-keys.

     If the field is in an enterFieldGroup, all leave keys will be

     forwarded to the group and possible step to the next/previous field.

     Also, if acceptOnLeave is true, leave keys will store the current

     value into their model (if any)"

    ^ #(Return CursorUp CursorDown Next Previous Accept)

!

defaultNumberOfLines