1 <?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
2 <html lang="en" xml:lang="en"> |
|
3 <head> |
|
4 <meta content="text/html; charset=utf-8" http-equiv="Content-Type" /> |
|
5 <meta name="copyright" content="(C) Copyright 2005" /> |
|
6 <meta name="DC.rights.owner" content="(C) Copyright 2005" /> |
|
7 <meta content="concept" name="DC.Type" /> |
|
8 <meta name="DC.Title" content="WRTKit Label Class" /> |
|
9 <meta scheme="URI" name="DC.Relation" content="WRTKit_API_Reference-GUID-00e47c27-0a1a-443f-ae85-cf3381635170.html" /> |
|
10 <meta content="XHTML" name="DC.Format" /> |
|
11 <meta content="GUID-64730E7F-835F-443A-9322-6753FA72FD09" name="DC.Identifier" /> |
|
12 <meta content="en" name="DC.Language" /> |
|
13 <link href="commonltr.css" type="text/css" rel="stylesheet" /> |
|
14 <title> |
|
15 WRTKit Label Class</title> |
|
16 </head> |
|
17 <body id="GUID-64730E7F-835F-443A-9322-6753FA72FD09"><a name="GUID-64730E7F-835F-443A-9322-6753FA72FD09"><!-- --></a> |
|
18 |
|
19 |
|
20 |
|
21 <h1 class="topictitle1"> |
|
22 WRTKit Label Class</h1> |
|
23 |
|
24 <div> |
|
25 |
|
26 <div class="section"><h2 class="sectiontitle"> |
|
27 Description</h2> |
|
28 |
|
29 |
|
30 <p> |
|
31 |
|
32 The Label class implements a control that displays a simple piece of text. A label |
|
33 is used in situations where there's a caption-value pair that needs to be displayed, |
|
34 e.g. "Name: John Smith". |
|
35 </p> |
|
36 |
|
37 <div class="fignone" id="GUID-64730E7F-835F-443A-9322-6753FA72FD09__GUID-E0AEA2A3-8D91-4211-AECA-B94DC6E75BC9"><a name="GUID-64730E7F-835F-443A-9322-6753FA72FD09__GUID-E0AEA2A3-8D91-4211-AECA-B94DC6E75BC9"><!-- --></a><span class="figcap">Figure 1. |
|
38 Label control</span> |
|
39 |
|
40 |
|
41 <br /><img src="Label_Control_Screenshot_1.png" /><br /> |
|
42 </div> |
|
43 |
|
44 </div> |
|
45 |
|
46 <div class="section"><h2 class="sectiontitle"> |
|
47 Inherits from</h2> |
|
48 |
|
49 |
|
50 <p> |
|
51 |
|
52 <a href="WRTKit_Control_Class-GUID-6ddb8154-3fed-40fc-b282-85e6d3ad494f.html"> |
|
53 Control</a> |
|
54 </p> |
|
55 |
|
56 </div> |
|
57 |
|
58 </div> |
|
59 |
|
60 <div> |
|
61 <div class="familylinks"> |
|
62 <div class="parentlink"><strong>Parent topic:</strong> <a href="WRTKit_API_Reference-GUID-00e47c27-0a1a-443f-ae85-cf3381635170.html">WRTKit API Reference</a></div> |
|
63 </div> |
|
64 </div> |
|
65 <div class="nested1" id="GUID-5AF89342-2A75-4FA0-8817-B34B40AB0D76"><a name="GUID-5AF89342-2A75-4FA0-8817-B34B40AB0D76"><!-- --></a> |
|
66 |
|
67 <h2 class="topictitle2"> |
|
68 Constructor</h2> |
|
69 |
|
70 <div> |
|
71 |
|
72 <div class="section"><h3 class="sectiontitle"> |
|
73 Syntax</h3> |
|
74 |
|
75 |
|
76 <pre> |
|
77 [Label] new Label(String id, String caption, String text)</pre> |
|
78 |
|
79 </div> |
|
80 |
|
81 <div class="section"><h3 class="sectiontitle"> |
|
82 Description</h3> |
|
83 |
|
84 |
|
85 <p> |
|
86 |
|
87 Creates a new instance of the Label class. |
|
88 </p> |
|
89 |
|
90 </div> |
|
91 |
|
92 <div class="section"><h3 class="sectiontitle"> |
|
93 Arguments</h3> |
|
94 |
|
95 |
|
96 <br /><ul> |
|
97 |
|
98 <li> |
|
99 |
|
100 <p> |
|
101 id</p> |
|
102 |
|
103 |
|
104 |
|
105 <p> |
|
106 |
|
107 Unique identifier for the control. Can be retrieved using the id property defined |
|
108 in the UIElement class that this control inherits from. Useful for example to |
|
109 identify the source of an event in event callback functions or to apply a CSS |
|
110 rule to only this particular control. The identifier can be null, in which case |
|
111 no id will be set for the control. |
|
112 </p> |
|
113 |
|
114 |
|
115 </li> |
|
116 |
|
117 <li> |
|
118 |
|
119 <p> |
|
120 caption</p> |
|
121 |
|
122 |
|
123 |
|
124 <p> |
|
125 |
|
126 The caption text for the control. A null caption can be used to hide the |
|
127 caption area. This is not recommended for a label since without a caption |
|
128 the value of the label doesn't make sense to the user. |
|
129 The value is an XHTML string. |
|
130 </p> |
|
131 |
|
132 |
|
133 </li> |
|
134 |
|
135 <li> |
|
136 |
|
137 <p> |
|
138 text</p> |
|
139 |
|
140 |
|
141 |
|
142 <p> |
|
143 |
|
144 The content for the label. If the argument is omitted or null then the content |
|
145 area will be empty. The value is an XHTML string. |
|
146 </p> |
|
147 |
|
148 |
|
149 </li> |
|
150 |
|
151 </ul> |
|
152 |
|
153 </div> |
|
154 |
|
155 <div class="section"><h3 class="sectiontitle"> |
|
156 Return value</h3> |
|
157 |
|
158 |
|
159 <p> |
|
160 |
|
161 A new instance of the Label class. |
|
162 </p> |
|
163 |
|
164 </div> |
|
165 |
|
166 </div> |
|
167 |
|
168 </div> |
|
169 |
|
170 <div class="nested1" id="GUID-7553A084-C1A7-4440-AC95-3CD1F9946419"><a name="GUID-7553A084-C1A7-4440-AC95-3CD1F9946419"><!-- --></a> |
|
171 |
|
172 <h2 class="topictitle2"> |
|
173 getText()</h2> |
|
174 |
|
175 <div> |
|
176 |
|
177 <div class="section"><h3 class="sectiontitle"> |
|
178 Syntax</h3> |
|
179 |
|
180 |
|
181 <pre> |
|
182 [String] Label.getText(void)</pre> |
|
183 |
|
184 </div> |
|
185 |
|
186 <div class="section"><h3 class="sectiontitle"> |
|
187 Description</h3> |
|
188 |
|
189 |
|
190 <p> |
|
191 |
|
192 Retrieves the current text value of the label. |
|
193 The value is an XHTML string. |
|
194 </p> |
|
195 |
|
196 </div> |
|
197 |
|
198 <div class="section"><h3 class="sectiontitle"> |
|
199 Arguments</h3> |
|
200 |
|
201 |
|
202 <p> |
|
203 |
|
204 This method does not take any arguments. |
|
205 </p> |
|
206 |
|
207 </div> |
|
208 |
|
209 <div class="section"><h3 class="sectiontitle"> |
|
210 Return value</h3> |
|
211 |
|
212 |
|
213 <p> |
|
214 |
|
215 The current text value of the label. |
|
216 </p> |
|
217 |
|
218 </div> |
|
219 |
|
220 </div> |
|
221 |
|
222 </div> |
|
223 |
|
224 <div class="nested1" id="GUID-A253368B-0ACB-4F98-992C-93AE4A11245C"><a name="GUID-A253368B-0ACB-4F98-992C-93AE4A11245C"><!-- --></a> |
|
225 |
|
226 <h2 class="topictitle2"> |
|
227 setText()</h2> |
|
228 |
|
229 <div> |
|
230 |
|
231 <div class="section"><h3 class="sectiontitle"> |
|
232 Syntax</h3> |
|
233 |
|
234 |
|
235 <pre> |
|
236 [void] Label.setText(String text)</pre> |
|
237 |
|
238 </div> |
|
239 |
|
240 <div class="section"><h3 class="sectiontitle"> |
|
241 Description</h3> |
|
242 |
|
243 |
|
244 <p> |
|
245 |
|
246 Sets the text value of the label. |
|
247 The value is an XHTML string. |
|
248 </p> |
|
249 |
|
250 </div> |
|
251 |
|
252 <div class="section"><h3 class="sectiontitle"> |
|
253 Arguments</h3> |
|
254 |
|
255 |
|
256 <br /><ul> |
|
257 |
|
258 <li> |
|
259 |
|
260 <p> |
|
261 text</p> |
|
262 |
|
263 |
|
264 |
|
265 <p> |
|
266 |
|
267 The text to be displayed as the value of the label. Passing null |
|
268 results in no text. |
|
269 </p> |
|
270 |
|
271 |
|
272 </li> |
|
273 |
|
274 </ul> |
|
275 |
|
276 </div> |
|
277 |
|
278 <div class="section"><h3 class="sectiontitle"> |
|
279 Return value</h3> |
|
280 |
|
281 |
|
282 <p> |
|
283 |
|
284 This method does not return a value. |
|
285 </p> |
|
286 |
|
287 </div> |
|
288 |
|
289 </div> |
|
290 |
|
291 </div> |
|
292 |
|
293 |
|
294 </body> |
|
295 </html> |
|