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 NavigationButton 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-3C5AABA9-899D-463A-8337-B6F7C09E190B" name="DC.Identifier" /> |
|
12 <meta content="en" name="DC.Language" /> |
|
13 <link href="commonltr.css" type="text/css" rel="stylesheet" /> |
|
14 <title> |
|
15 WRTKit NavigationButton Class</title> |
|
16 </head> |
|
17 <body id="GUID-3C5AABA9-899D-463A-8337-B6F7C09E190B"><a name="GUID-3C5AABA9-899D-463A-8337-B6F7C09E190B"><!-- --></a> |
|
18 |
|
19 |
|
20 |
|
21 <h1 class="topictitle1"> |
|
22 WRTKit NavigationButton Class</h1> |
|
23 |
|
24 <div> |
|
25 |
|
26 <div class="section"><h2 class="sectiontitle"> |
|
27 Description</h2> |
|
28 |
|
29 |
|
30 <p> |
|
31 |
|
32 The NavigationButton class implements a control that is intended for use in navigation |
|
33 menu -style user interfaces. A navigation button is typically used to let users move |
|
34 between views. |
|
35 </p> |
|
36 |
|
37 <div class="fignone" id="GUID-3C5AABA9-899D-463A-8337-B6F7C09E190B__GUID-63D51F0D-3760-4F4B-9B59-0B594D79A927"><a name="GUID-3C5AABA9-899D-463A-8337-B6F7C09E190B__GUID-63D51F0D-3760-4F4B-9B59-0B594D79A927"><!-- --></a><span class="figcap">Figure 1. |
|
38 NavigationButton controls</span> |
|
39 |
|
40 |
|
41 <br /><img src="NavigationButton_Controls_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_ActionControl_Class-GUID-6a7cb034-d676-4119-b799-7b3e3b5948e4.html"> |
|
53 ActionControl</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-F759C60D-D535-47D8-BB64-5F1403236F2A"><a name="GUID-F759C60D-D535-47D8-BB64-5F1403236F2A"><!-- --></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 [NavigationButton] new NavigationButton(String id, String image, 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 NavigationButton 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 image</p> |
|
121 |
|
122 |
|
123 |
|
124 <p> |
|
125 |
|
126 Icon image that is displayed on the face of the button. No size is enforced but |
|
127 the image should be about 30x30 pixels. PNG images with transparency are |
|
128 recommended. If null is passed for the image then no image will be displayed. |
|
129 </p> |
|
130 |
|
131 |
|
132 </li> |
|
133 |
|
134 <li> |
|
135 |
|
136 <p> |
|
137 text</p> |
|
138 |
|
139 |
|
140 |
|
141 <p> |
|
142 |
|
143 Text that is displayed on the face of the button. Typically this should be |
|
144 the view that the widget navigates to when the button is pressed. |
|
145 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 NavigationButton class. |
|
162 </p> |
|
163 |
|
164 </div> |
|
165 |
|
166 </div> |
|
167 |
|
168 </div> |
|
169 |
|
170 <div class="nested1" id="GUID-9199B58D-5A98-4A6D-AF18-D6FF1CAAA5EC"><a name="GUID-9199B58D-5A98-4A6D-AF18-D6FF1CAAA5EC"><!-- --></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] NavigationButton.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 of the button. |
|
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 of the button. |
|
216 </p> |
|
217 |
|
218 </div> |
|
219 |
|
220 </div> |
|
221 |
|
222 </div> |
|
223 |
|
224 <div class="nested1" id="GUID-B44BA4D5-E5E0-4711-B295-8039AC7A50A8"><a name="GUID-B44BA4D5-E5E0-4711-B295-8039AC7A50A8"><!-- --></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] NavigationButton.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 of the button. The text is displayed on the face |
|
247 of the button and typically should indicate where the widget navigates |
|
248 when the button is pressed. |
|
249 The value is an XHTML string. |
|
250 </p> |
|
251 |
|
252 </div> |
|
253 |
|
254 <div class="section"><h3 class="sectiontitle"> |
|
255 Arguments</h3> |
|
256 |
|
257 |
|
258 <br /><ul> |
|
259 |
|
260 <li> |
|
261 |
|
262 <p> |
|
263 text</p> |
|
264 |
|
265 |
|
266 |
|
267 <p> |
|
268 |
|
269 The text to be displayed on the face of the button. Passing null |
|
270 results in no text. |
|
271 </p> |
|
272 |
|
273 |
|
274 </li> |
|
275 |
|
276 </ul> |
|
277 |
|
278 </div> |
|
279 |
|
280 <div class="section"><h3 class="sectiontitle"> |
|
281 Return value</h3> |
|
282 |
|
283 |
|
284 <p> |
|
285 |
|
286 This method does not return a value. |
|
287 </p> |
|
288 |
|
289 </div> |
|
290 |
|
291 </div> |
|
292 |
|
293 </div> |
|
294 |
|
295 <div class="nested1" id="GUID-47A43DA5-CE78-438C-928D-0F5579A707B3"><a name="GUID-47A43DA5-CE78-438C-928D-0F5579A707B3"><!-- --></a> |
|
296 |
|
297 <h2 class="topictitle2"> |
|
298 getImage()</h2> |
|
299 |
|
300 <div> |
|
301 |
|
302 <div class="section"><h3 class="sectiontitle"> |
|
303 Syntax</h3> |
|
304 |
|
305 |
|
306 <pre> |
|
307 [String] NavigationButton.getImage(void)</pre> |
|
308 |
|
309 </div> |
|
310 |
|
311 <div class="section"><h3 class="sectiontitle"> |
|
312 Description</h3> |
|
313 |
|
314 |
|
315 <p> |
|
316 |
|
317 Retrieves the icon image URL of the button. |
|
318 </p> |
|
319 |
|
320 </div> |
|
321 |
|
322 <div class="section"><h3 class="sectiontitle"> |
|
323 Arguments</h3> |
|
324 |
|
325 |
|
326 <p> |
|
327 |
|
328 This method does not take any arguments. |
|
329 </p> |
|
330 |
|
331 </div> |
|
332 |
|
333 <div class="section"><h3 class="sectiontitle"> |
|
334 Return value</h3> |
|
335 |
|
336 |
|
337 <p> |
|
338 |
|
339 The icon image URL of the button or null if none. |
|
340 </p> |
|
341 |
|
342 </div> |
|
343 |
|
344 </div> |
|
345 |
|
346 </div> |
|
347 |
|
348 <div class="nested1" id="GUID-24F9C276-B75B-45E2-AB2D-ED751CAB18AA"><a name="GUID-24F9C276-B75B-45E2-AB2D-ED751CAB18AA"><!-- --></a> |
|
349 |
|
350 <h2 class="topictitle2"> |
|
351 setImage()</h2> |
|
352 |
|
353 <div> |
|
354 |
|
355 <div class="section"><h3 class="sectiontitle"> |
|
356 Syntax</h3> |
|
357 |
|
358 |
|
359 <pre> |
|
360 [void] NavigationButton.setImage(String image)</pre> |
|
361 |
|
362 </div> |
|
363 |
|
364 <div class="section"><h3 class="sectiontitle"> |
|
365 Description</h3> |
|
366 |
|
367 |
|
368 <p> |
|
369 |
|
370 Sets the icon image URL for the button. Passing null to this method |
|
371 hides the icon image. |
|
372 </p> |
|
373 |
|
374 </div> |
|
375 |
|
376 <div class="section"><h3 class="sectiontitle"> |
|
377 Arguments</h3> |
|
378 |
|
379 |
|
380 <br /><ul> |
|
381 |
|
382 <li> |
|
383 |
|
384 <p> |
|
385 image</p> |
|
386 |
|
387 |
|
388 |
|
389 <p> |
|
390 |
|
391 The URL of the icon image to display on the button or null for no image. |
|
392 </p> |
|
393 |
|
394 |
|
395 </li> |
|
396 |
|
397 </ul> |
|
398 |
|
399 </div> |
|
400 |
|
401 <div class="section"><h3 class="sectiontitle"> |
|
402 Return value</h3> |
|
403 |
|
404 |
|
405 <p> |
|
406 |
|
407 This method does not return a value. |
|
408 </p> |
|
409 |
|
410 </div> |
|
411 |
|
412 </div> |
|
413 |
|
414 </div> |
|
415 |
|
416 |
|
417 </body> |
|
418 </html> |
|