HelpSource/Classes/TextField.schelp

   1 CLASS:: TextField
   2 redirect:: implClass
   3 summary:: A view displaying editable text
   4 categories:: GUI>Views
   5
   6 DESCRIPTION::
   7 A view displaying editable text.
   8
   9
  10 CLASSMETHODS::
  11
  12 PRIVATE:: key
  13
  14
  15
  16 INSTANCEMETHODS::
  17
  18
  19 SUBSECTION:: Data
  20
  21 METHOD:: string
  22         The text displayed in the view.
  23
  24         argument::
  25                 A String.
  26
  27 METHOD:: object
  28         If link::#-setBoth:: is true, setting this variable also sets link::#-string:: to the value interpreted link::Classes/Object#-asString#as String::.
  29
  30         argument::
  31                 Any object, typically one which makes sense to display as a string, such as a Float.
  32
  33 METHOD:: setBoth
  34         A variable stating whether setting link::#-object:: will also set link::#-string::.
  35
  36         argument::
  37                 A Boolean.
  38
  39 METHOD:: value
  40         Gets the same as link::#-string::, but when setting also sets link::#-string:: to the value interpreted link::Classes/Object#-asString#as String:: regardless of the link::#-setBoth:: flag.
  41
  42         argument::
  43                 Any object, typically one which makes sense to display as a string, such as a Float.
  44
  45 METHOD:: valueAction
  46         Sets link::#-value:: and triggeres link::#-action::.
  47
  48
  49 SUBSECTION:: Appearance
  50
  51 METHOD:: align
  52         The alignment of the displayed text.
  53
  54         argument::
  55                 One of the following symbols: \centered, \left, or \right.
  56
  57 METHOD:: font
  58         The font used to display the text.
  59
  60         argument::
  61                 A Font.
  62
  63 METHOD:: stringColor
  64         The color used to display the text.
  65
  66         argument::
  67                 A Color.
  68
  69 METHOD:: background
  70         Setting this variable colors the inside of the field under the text with the given color.
  71
  72         argument::
  73                 A Color.
  74
  75
  76 SUBSECTION:: Actions
  77
  78 METHOD:: action
  79         The action object evaluated whenever the user changes the text.
  80
  81
  82 SUBSECTION:: Drag and drop
  83
  84 METHOD:: defaultGetDrag
  85         returns::
  86                 The displayed link::#-string::.
  87
  88 METHOD:: defaultCanReceiveDrag
  89         returns::
  90                 Always true.
  91
  92 METHOD:: defaultReceiveDrag
  93         Sets link::#-valueAction:: to the current drag data.