"

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

"

TextView subclass:#EditTextView

	instanceVariableNames:'cursorLine cursorVisibleLine cursorCol cursorShown

		prevCursorState readOnly modifiedChannel fixedSize exceptionBlock

		cursorFgColor cursorBgColor cursorNoFocusFgColor cursorType

		cursorTypeNoFocus undoAction typeOfSelection lastString

		lastReplacement lastAction replacing showMatchingParenthesis

		hasKeyboardFocus acceptAction lockUpdates tabMeansNextField

		autoIndent insertMode trimBlankLines wordWrap

		replacementWordSelectStyle acceptChannel acceptEnabled st80Mode'

	classVariableNames:'DefaultCursorForegroundColor DefaultCursorBackgroundColor

		DefaultCursorType DefaultCursorNoFocusForegroundColor ST80Mode

		DefaultCursorTypeNoFocus'

	poolDictionaries:''

	category:'Views-Text'

!

!EditTextView class methodsFor:'documentation'!

copyright

"

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

"

    a view for editable text - adds editing functionality to TextView

    Also, it adds accept functionality, and defines a new actionBlock: 

    acceptAction to be performed for accept

    If used with a model, this is informed by sending it a changeMsg with

    the current contents as argument.

    (however, it is possible to define both changeMsg and acceptAction)

    Please read the historic notice in the ListView class.

    [Instance variables:]

	cursorLine              <Number>        line where cursor sits (1..)

	cursorVisibleLine       <Number>        visible line where cursor sits (1..nLinesShown)

	cursorCol               <Number>        col where cursor sits (1..)

	cursorShown             <Boolean>       true, if cursor is currently shown

	readOnly                <Boolean>       true, if text may not be edited

	modifiedChannel         <ValueHolder>   holding true, if text has been modified.

						cleared on accept.

	acceptChannel           <ValueHolder>   holding true, if text has been accepted.

	fixedSize               <Boolean>       true, if no lines may be added/removed

	exceptionBlock          <Block>         block to be evaluated when readonly text is about to be modified

						if it returns true, the modification will be done anyway.

						if it returns anything else, the modification is not done.

	cursorFgColor           <Color>         color used for cursor drawing

	cursorBgColor           <Color>         color used for cursor drawing

	cursorType              <Symbol>        how the cursor is drawn; currently implemented

						are #block (solid-block cursor), #ibeam

						(vertical bar at insertion point) 

						and #caret (caret below insertion-point)

	cursorTypeNoFocus       <Symbol>        like above, if view has no focus

						nil means: hide the cursor.

	undoAction              <Block>         block which undoes last cut, paste or replace

						(not yet fully implemented)

	typeOfSelection         <Symbol>        #paste, if selection created by paste, nil otherwise

						this affects the next keyPress: if #paste it does not

						replace; otherwise it replaces the selection.

	lastCut                 <String>        last cut or replaced string

	lastReplacement         <String>        last replacement

	replacing               <Boolean>       true if entered characters replace last selection

	showMatchingParenthesis <Boolean>       if true, shows matching parenthesis

						when entering one; this is the default.

	hasKeyboardFocus        <Boolean>       true if this view has the focus

	acceptAction            <Block>         accept action - evaluated passing the contents as 

						argument 

	tabMeansNextField       <Boolean>       if true, Tab is ignored as input and shifts keyboard

						focus to the next field. For editTextViews, this is false

						by default (i.e. tabs can be entered into the text).

						For some subclasses (inputFields), this may be true.

	trimBlankLines          <Boolean>       if true, trailing blanks are

						removed when editing.

						Default is true.

	wordWrap                <Boolean>       Currently not used.

	lockUpdates             <Boolean>       internal, private

	prevCursorState         <Boolean>       temporary, private

    class variables:

	ST80Mode                <Boolean>       if true, cursor positioning is

						done as in vi or ST80; i.e.

						wysiwyg mode is somewhat relaxed,

						in that the cursor cannot be

						positioned behind a lines end.

						This is not yet completely implemented.

    used globals:

	DeleteHistory           <Text>          last 1000 lines of deleted text

						(but only if this variable exists already)

    [styleSheet parameters:]

	textCursorForegroundColor <Color>       cursor fg color; default: text background

	textCursorBackgroundColor <Color>       cursor bg color; default: text foreground

	textCursorNoFocusForegroundColor 

				  <Color>       cursor fg color if no focus; default: cursor fg color

	textCursorType            <Symbol>      cursor type; default:  #block

    [author:]

	Claus Gittinger

    [see also:]

	CodeView Workspace TextView ListView

	EditField

"

!

examples

"

  non MVC operation:

    basic setup:

									[exBegin]

	|top textView|

	top := StandardSystemView new.

	top extent:300@200.

	textView := EditTextView new.

	textView origin:0.0 @ 0.0 corner:1.0 @ 1.0.

	top addSubView:textView.

	textView contents:('/etc/hosts' asFilename contentsOfEntireFile).

	top open.

									[exEnd]

    with vertical scrollbar:

									[exBegin]

	|top scrollView textView|

	top := StandardSystemView new.

	top extent:300@200.

	scrollView := ScrollableView for:EditTextView.

	textView := scrollView scrolledView.

	scrollView origin:0.0 @ 0.0 corner:1.0 @ 1.0.

	top addSubView:scrollView.

	textView contents:('/etc/hosts' asFilename contentsOfEntireFile).

	top open.

									[exEnd]

    with horizontal & vertical scrollbars:

									[exBegin]

	|top scrollView textView|

	top := StandardSystemView new.

	top extent:300@200.

	scrollView := HVScrollableView for:EditTextView.

	textView := scrollView scrolledView.

	scrollView origin:0.0 @ 0.0 corner:1.0 @ 1.0.

	top addSubView:scrollView.

	textView contents:('/etc/hosts' asFilename contentsOfEntireFile).

	top open.

									[exEnd]

    set the action for accept:

									[exBegin]

	|top textView|

	top := StandardSystemView new.

	top extent:300@200.

	textView := EditTextView new.

	textView origin:0.0 @ 0.0 corner:1.0 @ 1.0.

	top addSubView:textView.

	textView contents:('/etc/hosts' asFilename contentsOfEntireFile).

	textView acceptAction:[:contents |

				Transcript showCR:'will not overwrite the file with:'.

				Transcript showCR:contents asString

			      ].

	top open.

									[exEnd]

    non-string (text) items:

									[exBegin]

	|top textView list|

	list := '/etc/hosts' asFilename contentsOfEntireFile asStringCollection.

	1 to:list size by:2 do:[:nr |

	    list at:nr put:(Text string:(list at:nr)

				 emphasis:(Array with:#bold with:(#color->Color red)))

	].

	top := StandardSystemView new.

	top extent:300@200.

	textView := EditTextView new.

	textView origin:0.0 @ 0.0 corner:1.0 @ 1.0.

	top addSubView:textView.

	textView contents:list.

	top open.

									[exEnd]

  MVC operation:

    (the examples model here is a plug simulating a real model;

     real world applications would not use a plug ..)

									[exBegin]

	|top textView model|

	model := Plug new.

	model respondTo:#accepted:

		   with:[:newContents | 

				Transcript showCR:'will not overwrite the file with:'.

				Transcript showCR:newContents asString

			].

	model respondTo:#getList

		   with:['/etc/hosts' asFilename contentsOfEntireFile].

	top := StandardSystemView new.

	top extent:300@200.

	textView := EditTextView new.

	textView origin:0.0 @ 0.0 corner:1.0 @ 1.0.

	top addSubView:textView.

	textView listMessage:#getList;

		 model:model;

		 changeMessage:#accepted:;

		 aspect:#list.

	top open.

									[exEnd]

    two textViews on the same model:

									[exBegin]

	|top1 textView1 top2 textView2 model currentContents|

	model := Plug new.

	model respondTo:#accepted:

		   with:[:newContents |

				Transcript showCR:'accepted:'.

				Transcript showCR:newContents asString.

				currentContents := newContents.

				model changed:#contents

			].

	model respondTo:#getList

		   with:[Transcript showCR:'query'.

			 currentContents].

	top1 := StandardSystemView new.

	top1 extent:300@200.

	textView1 := EditTextView new.

	textView1 origin:0.0 @ 0.0 corner:1.0 @ 1.0.

	top1 addSubView:textView1.

	textView1 listMessage:#getList;

		  model:model;

		  aspect:#contents;

		  changeMessage:#accepted:.

	top1 open.

	top2 := StandardSystemView new.

	top2 extent:300@200.

	textView2 := EditTextView new.

	textView2 origin:0.0 @ 0.0 corner:1.0 @ 1.0.

	top2 addSubView:textView2.

	textView2 listMessage:#getList;

		  model:model;

		  aspect:#contents;

		  changeMessage:#accepted:.

	top2 open.

									[exEnd]

"

! !

!EditTextView class methodsFor:'defaults'!

st80Mode

    "return true, if the st80 editing mode is turned on.

     This setting affects the behavior of the cursor, when positioned

     behond the end of a line or the end of the text.

     The default is initialized from the viewStyle."

    ^ ST80Mode

   "

    EditTextView st80Mode:true

    EditTextView st80Mode:false

   "

    "Modified: / 16.1.1998 / 22:54:57 / cg"

!

st80Mode:aBoolean

    "turns on/off st80 behavior, where the cursor cannot be positioned

     behond the end of a line or the last line"

    ST80Mode := aBoolean.

   "

    EditTextView st80Mode:true

    EditTextView st80Mode:false

   "

    "Modified: / 16.1.1998 / 22:55:19 / cg"

!

updateStyleCache

    "extract values from the styleSheet and cache them in class variables"

    <resource: #style (#'textCursor.foregroundColor' #'textCursor.backgroundColor'

                       #'textCursor.noFocusForegroundColor' 

                       #'textCursor.type' #'textCursor.typeNoFocus'

                       #'editText.st80Mode')>

    DefaultCursorForegroundColor := StyleSheet colorAt:'textCursor.foregroundColor'.

    DefaultCursorBackgroundColor := StyleSheet colorAt:'textCursor.backgroundColor'.

    DefaultCursorNoFocusForegroundColor := StyleSheet colorAt:'textCursor.noFocusForegroundColor'.

    DefaultCursorType := StyleSheet at:'textCursor.type' default:#block.

    DefaultCursorTypeNoFocus := StyleSheet at:'textCursor.typeNoFocus'.

    ST80Mode := StyleSheet at:'editText.st80Mode' default:false.

    "

     self updateStyleCache

    "

    "Modified: / 20.5.1998 / 04:27:41 / cg"

! !

!EditTextView methodsFor:'ST-80 compatibility'!

autoAccept:aBoolean

    "ignored for now"

    "Created: / 5.6.1998 / 15:30:32 / cg"

!

continuousAccept:aBoolean

    "ignored for now"

    "Created: / 19.6.1998 / 00:03:49 / cg"

!

disable

    self readOnly:true

    "Created: / 19.6.1998 / 02:34:14 / cg"

!

textHasChanged

    ^ self modified

    "Created: / 19.6.1998 / 00:09:43 / cg"

! !

!EditTextView methodsFor:'ST-80 compatibility editing'!

cutSelection

    self cut

    "Created: / 31.10.1997 / 03:29:50 / cg"

!

deselect

    "remove the selection"

    ^ self unselect

    "Created: / 19.6.1998 / 02:41:54 / cg"

!

insert:aString at:aCharacterPosition

    "insert a string at aCharacterPosition."

    |line col|

    line := self lineOfCharacterPosition:aCharacterPosition.

    col := aCharacterPosition - (self characterPositionOfLine:line col:1) + 1.

    col < 1 ifTrue:[

        col := 1

    ].

    self insertString:aString atLine:line col:col.

    "

     |top v|

     top := StandardSystemView new.

     top extent:300@300.

     v := EditTextView origin:0.0@0.0 corner:1.0@1.0 in:top.

     top openAndWait.

     v contents:'1234567890\1234567890\1234567890\' withCRs.

     v insert:'<- hello there' at:5.

    "

    "Modified: / 5.4.1998 / 17:20:08 / cg"

!

insertAndSelect:aString at:aCharacterPosition

    "insert a selected string at aCharacterPosition."

    |line col|

    line := self lineOfCharacterPosition:aCharacterPosition.

    col := aCharacterPosition - (self characterPositionOfLine:line col:1) + 1.

    self insertString:aString atLine:line col:col.

    self selectFromLine:line col:col toLine:line col:col + aString size - 1

    "

     |v|

     v := EditTextView new openAndWait.

     v contents:'1234567890\1234567890\1234567890\' withCRs.

     v insertAndSelect:'<- hello there' at:5.

    "

!

pasteSelection

    self paste

    "Created: / 31.10.1997 / 03:28:53 / cg"

!

replaceSelectionWith:aString

    ^ self replaceSelectionBy:aString

    "Created: / 19.6.1998 / 02:42:32 / cg"

!

selectAt:pos

    "move the cursor before cursorPosition."