"

 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 cursorType undoAction typeOfSelection

		lastString lastReplacement lastAction replacing

		showMatchingParenthesis hasKeyboardFocus acceptAction lockUpdates

		tabMeansNextField autoIndent insertMode'

	classVariableNames:'DefaultCursorForegroundColor DefaultCursorBackgroundColor

		DefaultCursorType'

	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

        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)

        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.

        lockUpdates             <Boolean>       internal, private

        prevCursorState         <Boolean>       temporary, private

    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

        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]

  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 model:model;

                 changeMessage:#accepted:;

                 listMessage:#getList;

                 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 model:model;

                  aspect:#contents;

                  changeMessage:#accepted:;

                  listMessage:#getList.

        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 model:model;

                  aspect:#contents;

                  changeMessage:#accepted:;

                  listMessage:#getList.

        top2 open.

                                                                        [exEnd]

"

! !

!EditTextView class methodsFor:'defaults'!

updateStyleCache

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

    <resource: #style (#textCursorForegroundColor #textCursorBackgroundColor

                       #textCursorType )>

    DefaultCursorForegroundColor := StyleSheet colorAt:'textCursorForegroundColor'.

    DefaultCursorBackgroundColor := StyleSheet colorAt:'textCursorBackgroundColor'.

    DefaultCursorType := StyleSheet at:'textCursorType' default:#block.

    "Modified: 1.3.1996 / 13:45:41 / cg"

! !

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

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.

    "

! !

!EditTextView methodsFor:'accessing-behavior'!

acceptAction

    "return the action to be performed on accept (or nil)"

    ^ acceptAction

!

acceptAction:aBlock

    "set the action to be performed on accept"

    acceptAction := aBlock

!

autoIndent:aBoolean

    autoIndent := aBoolean

    "Created: 5.3.1996 / 14:37:50 / cg"

!

exceptionBlock:aBlock

    "define the action to be triggered when user tries to modify

     readonly text"

    exceptionBlock := aBlock

!

insertMode:aBoolean

    insertMode := aBoolean

    "Created: 6.3.1996 / 12:24:05 / cg"

!

tabMeansNextField:aBoolean

    "set/clear tabbing to the next field.

     If true, Tab is ignored and shifts the keyboard focus.

     If false, tabs can be entered into the text.

     The default is true for editTextView, false for single-line

     input fields."

    tabMeansNextField := aBoolean

! !

!EditTextView methodsFor:'accessing-contents'!

at:lineNr put:aLine

    (self at:lineNr) = aLine ifFalse:[

        super at:lineNr put:aLine.

        self textChanged

    ].

!

characterUnderCursor

    "return the character under the cursor - space if behond line.

     For non-block cursors, this is the character immediately to the right

     of the insertion-bar or caret."

    ^ self characterAtLine:cursorLine col:cursorCol

!

contents

    "return the contents as a String"

    list isNil ifTrue:[^ ''].

    self removeTrailingBlankLines.

    ^ list asStringWithCRs

!

cursorCol

    "return the cursors col (1..).

     This is the absolute col; NOT the visible col"

    ^ cursorCol

!

cursorLine

    "return the cursors line (1..). 

     This is the absolute line; NOT the visible line"

    ^ cursorLine

!

fixedSize

    "make the texts size fixed (no lines may be added).

     OBSOLETE: use readOnly"

    readOnly ifFalse:[

	readOnly := true.

	middleButtonMenu notNil ifTrue:[

	    middleButtonMenu disableAll:#(cut paste replace indent)

	]

    ]

!

fromFile:aFileName

    "take contents from a named file"

    self contents:(aFileName asFilename readStream contents)

!

list:something

    "position cursor home when setting contents"

    super list:something.

    self cursorHome

!

modified

    "return true if text was modified"

    ^ modifiedChannel value

!

modified:aBoolean

    "set the modified flag"

    modifiedChannel value:aBoolean

!

modifiedChannel

    "return the valueHolder holding true if text was modified"

    ^ modifiedChannel

!

readOnly

    "make the text readonly"

    readOnly := true

! !

!EditTextView methodsFor:'accessing-look'!

cursorForegroundColor:color1 backgroundColor:color2

    "set both cursor foreground and cursor background colors"

    |wasOn|

    wasOn := self hideCursor.

    cursorFgColor := color1 on:device.

    cursorBgColor := color2 on:device.

    wasOn ifTrue:[self showCursor]

! !

!EditTextView methodsFor:'change & update '!

accept

    "accept the current contents by executing the accept-action and/or

     changeMessage."

    lockUpdates := true.

     "/

     "/ ST/X way of doing things

     "/ as a historic (and temporary) leftover,

     "/ the block is called with a stringCollection

     "/ - not with the actual string

     "/

     acceptAction notNil ifTrue:[

	 acceptAction value:self list

     ].

     "/

     "/ ST-80 way of doing it

     "/

     self sendChangeMessageWith:self argForChangeMessage.

    lockUpdates := false.

!