EditField.st
changeset 586 032b3245e53a
parent 561 ef45086071c6
child 594 b9c5a5e5f905
equal deleted inserted replaced
585:8f395aba0173 586:032b3245e53a
    92     The physical completion-key is the Tab key (this one cannot be defined by
    92     The physical completion-key is the Tab key (this one cannot be defined by
    93     the keyboardTranslation mechanism, since that would disable the Tab-key on regular text views.
    93     the keyboardTranslation mechanism, since that would disable the Tab-key on regular text views.
    94 
    94 
    95 
    95 
    96 
    96 
    97     Instance variables:
    97     [Instance variables:]
    98 
    98 
    99       leaveAction    <Block | nil>              if non-nil, this is evaluated with
    99       leaveAction    <Block | nil>              if non-nil, this is evaluated with
   100 						the key (#Return, #CursorUp etc.) when
   100                                                 the key (#Return, #CursorUp etc.) when
   101 						the field is left via keyboard keys.
   101                                                 the field is left via keyboard keys.
   102 						(fieldGroups use this to decide which
   102                                                 (fieldGroups use this to decide which
   103 						 field has to be enabled next)
   103                                                  field has to be enabled next)
   104 
   104 
   105       enabled        <Boolean>                  if false, input is ignored.
   105       enabled        <Boolean>                  if false, input is ignored.
   106 
   106 
   107       clickAction    <Block | nil>              action performed if the field is
   107       clickAction    <Block | nil>              action performed if the field is
   108 						clicked upon.
   108                                                 clicked upon.
   109 						(this is used by the group to
   109                                                 (this is used by the group to
   110 						 set the active field to the clicked upon field)
   110                                                  set the active field to the clicked upon field)
   111 
   111 
   112       crAction       <Block | nil>              if non-nil, keyboard input of a cr are not
   112       crAction       <Block | nil>              if non-nil, keyboard input of a cr are not
   113 						handled specially, instead this block is evaluated
   113                                                 handled specially, instead this block is evaluated
   114 						(however, this block can perform additional checks and send
   114                                                 (however, this block can perform additional checks and send
   115 						 a #accept then)
   115                                                  a #accept then)
   116 
   116 
   117       tabAction      <Block | nil>              if non-nil, keyboard input of a tab character
   117       tabAction      <Block | nil>              if non-nil, keyboard input of a tab character
   118 						is not entered into the text, instead this block
   118                                                 is not entered into the text, instead this block
   119 						is evaluated. Also, no input completion is performed if
   119                                                 is evaluated. Also, no input completion is performed if
   120 						tabAction is nonNil.
   120                                                 tabAction is nonNil.
   121 
   121 
   122       converter      <PrintConverter | nil>     if non-nil, this is supposed to convert between
   122       converter      <PrintConverter | nil>     if non-nil, this is supposed to convert between
   123 						the object and its printed representation and vice versa.
   123                                                 the object and its printed representation and vice versa.
   124 						Defaults to nil i.e. assume that strings are edited.
   124                                                 Defaults to nil i.e. assume that strings are edited.
   125 
   125 
   126       leaveKeys      <Collection>               keys which are interpreted as 'leaving the field'
   126       leaveKeys      <Collection>               keys which are interpreted as 'leaving the field'
   127 
   127 
   128       immediateAccept   <Boolean>               if true, every change of the text is immediately
   128       immediateAccept   <Boolean>               if true, every change of the text is immediately
   129 						forwarded to the model/acceptBlock. If false,
   129                                                 forwarded to the model/acceptBlock. If false,
   130 						the changed value is only stored in the model
   130                                                 the changed value is only stored in the model
   131 						if the field is left or accepted.
   131                                                 if the field is left or accepted.
   132 						Default is false.
   132                                                 Default is false.
   133 
   133 
   134       acceptOnLeave  <Boolean>                  if true, leaving the field (via cursor keys)
   134       acceptOnLeave  <Boolean>                  if true, leaving the field (via cursor keys)
   135 						automatically accepts the value into the model.
   135                                                 automatically accepts the value into the model.
   136 						Default is true.
   136                                                 Default is true.
   137 
   137 
   138       acceptOnReturn <Boolean>                  if true, leaving the field via return
   138       acceptOnReturn <Boolean>                  if true, leaving the field via return
   139 						automatically accepts the value into the model.
   139                                                 automatically accepts the value into the model.
   140 						Default is true.
   140                                                 Default is true.
   141 
   141 
   142       acceptOnTab    <Boolean>                  if true, the Tab key accepts and leaves the field.
   142       acceptOnTab    <Boolean>                  if true, the Tab key accepts and leaves the field.
   143 						If false, Tabs are entered into the contents field like
   143                                                 If false, Tabs are entered into the contents field like
   144 						ordinary non-control keys.
   144                                                 ordinary non-control keys.
   145 						AcceptOnTab is ignored if the entryCompletion block is nonNil.
   145                                                 AcceptOnTab is ignored if the entryCompletion block is nonNil.
   146 						Default is true.
   146                                                 Default is true.
   147 
   147 
   148       lengthLimit    <Number>                   the max. number of allowed characters
   148       lengthLimit    <Number>                   the max. number of allowed characters
   149 
   149 
   150       entryCompletionBlock <BlockOrNil>         if non-nil, this is evaluated to complete the entry
   150       entryCompletionBlock <BlockOrNil>         if non-nil, this is evaluated to complete the entry
   151 						when Tab is pressed.
   151                                                 when Tab is pressed.
   152 						Entry completion is used with Filenamefields or in the
   152                                                 Entry completion is used with Filenamefields or in the
   153 						browser for classname/selector completion.
   153                                                 browser for classname/selector completion.
   154 						Setting a nonNil entryCompletion disables acceptOnTab.
   154                                                 Setting a nonNil entryCompletion disables acceptOnTab.
   155 
   155 
   156       passwordCharacter     <CharacterOrNil>    if non-nil, typed input is replaced by this character
   156       passwordCharacter     <CharacterOrNil>    if non-nil, typed input is replaced by this character
   157 						for display. Used for secret-input fields (such as password entry).
   157                                                 for display. Used for secret-input fields (such as password entry).
   158 						Default is nil.
   158                                                 Default is nil.
   159 
   159 
   160 
   160 
   161       cursorMovementWhenUpdating <Symbol>       defines where the cursor is to be positioned if the
   161       cursorMovementWhenUpdating <Symbol>       defines where the cursor is to be positioned if the
   162 						model changes its value by some outside activity
   162                                                 model changes its value by some outside activity
   163 						(i.e. not by user input into the field).
   163                                                 (i.e. not by user input into the field).
   164 						Can be one of:
   164                                                 Can be one of:
   165 						    #keep / nil     -> stay where it was
   165                                                     #keep / nil     -> stay where it was
   166 						    #endOfLine      -> position cursor after the string
   166                                                     #endOfLine      -> position cursor after the string
   167 						    #beginOfLine    -> position cursor to the beginning
   167                                                     #beginOfLine    -> position cursor to the beginning
   168 						The default is nil (i.e. stay where it was before).
   168                                                 The default is nil (i.e. stay where it was before).
       
   169 
       
   170     [author:]
       
   171         Claus Gittinger
       
   172 
       
   173     [see also:]
       
   174         DialogBox
   169 "
   175 "
   170 !
   176 !
   171 
   177 
   172 examples 
   178 examples 
   173 "
   179 "
  1628 ! !
  1634 ! !
  1629 
  1635 
  1630 !EditField class methodsFor:'documentation'!
  1636 !EditField class methodsFor:'documentation'!
  1631 
  1637 
  1632 version
  1638 version
  1633     ^ '$Header: /cvs/stx/stx/libwidg/EditField.st,v 1.53 1996-04-20 12:39:32 ca Exp $'
  1639     ^ '$Header: /cvs/stx/stx/libwidg/EditField.st,v 1.54 1996-04-25 17:33:04 cg Exp $'
  1634 ! !
  1640 ! !