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.
  63
  64
  65 EXAMPLES::
  66
  67 subsection:: Basic Example
  68
  69 code::
  70 (
  71 w = Window.new.front;
  72 a = StaticText(w, Rect(10, 10, 200, 20));
  73 a.string = "Rolof's Rolex";
  74 )
  75
  76 // adjust look , alignment and content
  77 a.background=Color.grey;
  78 a.align = \center;
  79 a.font = Font("Monaco", 11);
  80 a.string = "Your Rolex";
  81 ::
  82
  83
  84 subsection:: Monitoring Values in a Synth
  85
  86 code::
  87 (
  88
  89 w = Window("Frequency Monitor", Rect(200, Window.screenBounds.height-200,300,150)).front;
  90
  91 a = StaticText(w, Rect(45, 10, 200, 20)).background_(Color.rand);
  92
  93 a.string = " Current Frequency ";
  94
  95 Button.new(w, Rect(45, 70, 200, 20)).states_([["close",Color.black,Color.rand]]).action_({w.close});
  96
  97 s.waitForBoot({
  98
  99     b=Bus.new(\control,0,1);
 100
 101     q=SynthDef(\Docs_FreqMonitor, {var freq,snd;
 102         freq=LFNoise0.ar(2, 400, 650);
 103         snd=SinOsc.ar(freq,0,0.2);
 104         Out.ar(0,snd);
 105         Out.kr(b.index,freq); // output the frequency to a control bus
 106     }).play;
 107
 108     r= Routine{
 109         {           // Set the value of the StaticText to the value in the control bus.
 110                     // Setting GUI values is asynchronous, so you must use .defer in the system clock.
 111                     // Also you must check if the window is still open, since Routine will continue for at least
 112                     // one step after you close the window.
 113         b.get( {arg v; {w.isClosed.not.if{ a.string= " Current Frequency: "++v.round(0.01)}; }.defer} );
 114
 115         0.01.wait;
 116         }.loop
 117
 118     }.play
 119 });
 120
 121 CmdPeriod.doOnce({w.close});
 122 w.onClose={r.stop; q.free; b.free }; //clean up if the window closes
 123
 124 )
 125 ::
 126
 127
 128 subsection:: Dynamic Text
 129
 130 code::
 131 (
 132 w = Window.new.front;
 133 w.view.background=Color.white;
 134 a = Array.fill(20, {StaticText(w, Rect(w.bounds.extent.x.rand, w.bounds.extent.y.rand, 160, 16))
 135     .string_("Rolof's Rolex".scramble)
 136     .align_(\center)
 137     .stringColor_(Color.rand)
 138     .font_(Font([
 139         "Helvetica-Bold",
 140         "Helvetica",
 141         "Monaco",
 142         "Arial",
 143         "Gadget",
 144         "MarkerFelt-Thin"
 145     ].choose, 11))
 146 });
 147
 148 r = {inf.do{|i|
 149     thisThread.randSeed_(1284);
 150     a.do{|item|
 151         // setting GUI values is asynchronous, so you must use .defer
 152         {item.bounds = Rect(5+w.bounds.extent.x.rand * (cos(i*0.01)).abs,
 153                     w.bounds.extent.y.rand * sin(i*0.01),
 154                     160, 20)}.defer;
 155     };
 156     0.15.wait;
 157 }}.fork;
 158 CmdPeriod.doOnce({w.close});
 159 w.onClose_({r.stop});
 160 )
 161 ::