HelpSource/Classes/StaticText.schelp

   1 CLASS:: StaticText
   2 redirect:: implClass
   3 summary:: A view displaying non-editable text
   4 categories:: GUI>Views
   5
   6 DESCRIPTION::
   7 A view displaying non-editable text
   8
   9
  10 CLASSMETHODS::
  11
  12 PRIVATE:: key
  13
  14
  15
  16 INSTANCEMETHODS::
  17
  18 SUBSECTION:: Data
  19
  20 METHOD:: string
  21         The text displayed by the view.
  22
  23         argument::
  24                 A String.
  25
  26 METHOD:: object
  27         If link::#-setBoth:: is true, setting this variable also sets link::#-string:: to the value interpreted link::Classes/Object#-asString#as String::.
  28
  29         argument::
  30                 Any object, typically one which makes sense to display as a string, such as a Float.
  31
  32 METHOD:: setBoth
  33         A variable stating whether setting link::#-object:: will also set link::#-string::.
  34
  35         argument::
  36                 A Boolean.
  37
  38 SUBSECTION:: Appearance
  39
  40 METHOD:: align
  41         The alignment of the displayed text.
  42
  43         argument::
  44                 One of the following symbols: \centered, \left, or \right.
  45
  46 METHOD:: font
  47         The font used to display the text.
  48
  49         argument::
  50                 A Font.
  51
  52 METHOD:: stringColor
  53         The color used to display the text.
  54
  55         argument::
  56                 A Color.
  57
  58 METHOD:: background
  59         Setting this variable colors the whole area occupied by the view under the text with the given color.
  60
  61         argument::
  62                 A Color.