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 FormButton 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-9F99492D-B232-4A78-BAED-BD284839B367" name="DC.Identifier" /> |
|
12 <meta content="en" name="DC.Language" /> |
|
13 <link href="commonltr.css" type="text/css" rel="stylesheet" /> |
|
14 <title> |
|
15 WRTKit FormButton Class</title> |
|
16 </head> |
|
17 <body id="GUID-9F99492D-B232-4A78-BAED-BD284839B367"><a name="GUID-9F99492D-B232-4A78-BAED-BD284839B367"><!-- --></a> |
|
18 |
|
19 |
|
20 |
|
21 <h1 class="topictitle1"> |
|
22 WRTKit FormButton Class</h1> |
|
23 |
|
24 <div> |
|
25 |
|
26 <div class="section"><h2 class="sectiontitle"> |
|
27 Description</h2> |
|
28 |
|
29 |
|
30 <p> |
|
31 |
|
32 The FormButton class implements a control that is intended for use in form-style |
|
33 user interfaces. A form button is typically used to let users trigger actions. |
|
34 </p> |
|
35 |
|
36 <div class="fignone" id="GUID-9F99492D-B232-4A78-BAED-BD284839B367__GUID-90873EC3-1248-4FC8-A318-06F71E370C67"><a name="GUID-9F99492D-B232-4A78-BAED-BD284839B367__GUID-90873EC3-1248-4FC8-A318-06F71E370C67"><!-- --></a><span class="figcap">Figure 1. |
|
37 FormButton controls</span> |
|
38 |
|
39 |
|
40 <br /><img src="FormButton_Controls_Screenshot_1.png" /><br /> |
|
41 </div> |
|
42 |
|
43 </div> |
|
44 |
|
45 <div class="section"><h2 class="sectiontitle"> |
|
46 Inherits from</h2> |
|
47 |
|
48 |
|
49 <p> |
|
50 |
|
51 <a href="WRTKit_ActionControl_Class-GUID-6a7cb034-d676-4119-b799-7b3e3b5948e4.html"> |
|
52 ActionControl</a> |
|
53 </p> |
|
54 |
|
55 </div> |
|
56 |
|
57 </div> |
|
58 |
|
59 <div> |
|
60 <div class="familylinks"> |
|
61 <div class="parentlink"><strong>Parent topic:</strong> <a href="WRTKit_API_Reference-GUID-00e47c27-0a1a-443f-ae85-cf3381635170.html">WRTKit API Reference</a></div> |
|
62 </div> |
|
63 </div> |
|
64 <div class="nested1" id="GUID-C6970E99-D851-4FC1-BB92-BAA26FD83DB7"><a name="GUID-C6970E99-D851-4FC1-BB92-BAA26FD83DB7"><!-- --></a> |
|
65 |
|
66 <h2 class="topictitle2"> |
|
67 Constructor</h2> |
|
68 |
|
69 <div> |
|
70 |
|
71 <div class="section"><h3 class="sectiontitle"> |
|
72 Syntax</h3> |
|
73 |
|
74 |
|
75 <pre> |
|
76 [FormButton] new FormButton(String id, String text)</pre> |
|
77 |
|
78 </div> |
|
79 |
|
80 <div class="section"><h3 class="sectiontitle"> |
|
81 Description</h3> |
|
82 |
|
83 |
|
84 <p> |
|
85 |
|
86 Creates a new instance of the FormButton class. |
|
87 </p> |
|
88 |
|
89 </div> |
|
90 |
|
91 <div class="section"><h3 class="sectiontitle"> |
|
92 Arguments</h3> |
|
93 |
|
94 |
|
95 <br /><ul> |
|
96 |
|
97 <li> |
|
98 |
|
99 <p> |
|
100 id</p> |
|
101 |
|
102 |
|
103 |
|
104 <p> |
|
105 |
|
106 Unique identifier for the control. Can be retrieved using the id property defined |
|
107 in the UIElement class that this control inherits from. Useful for example to |
|
108 identify the source of an event in event callback functions or to apply a CSS |
|
109 rule to only this particular control. The identifier can be null, in which case |
|
110 no id will be set for the control. |
|
111 </p> |
|
112 |
|
113 |
|
114 </li> |
|
115 |
|
116 <li> |
|
117 |
|
118 <p> |
|
119 text</p> |
|
120 |
|
121 |
|
122 |
|
123 <p> |
|
124 |
|
125 Text that is displayed on the face of the button. Typically this should be |
|
126 a verb that indicates what happens when the button is pressed. |
|
127 The value is an XHTML string. |
|
128 </p> |
|
129 |
|
130 |
|
131 </li> |
|
132 |
|
133 </ul> |
|
134 |
|
135 </div> |
|
136 |
|
137 <div class="section"><h3 class="sectiontitle"> |
|
138 Return value</h3> |
|
139 |
|
140 |
|
141 <p> |
|
142 |
|
143 A new instance of the FormButton class. |
|
144 </p> |
|
145 |
|
146 </div> |
|
147 |
|
148 </div> |
|
149 |
|
150 </div> |
|
151 |
|
152 <div class="nested1" id="GUID-26359B98-7773-43B5-A788-E15FCC1F0E41"><a name="GUID-26359B98-7773-43B5-A788-E15FCC1F0E41"><!-- --></a> |
|
153 |
|
154 <h2 class="topictitle2"> |
|
155 getText()</h2> |
|
156 |
|
157 <div> |
|
158 |
|
159 <div class="section"><h3 class="sectiontitle"> |
|
160 Syntax</h3> |
|
161 |
|
162 |
|
163 <pre> |
|
164 [String] FormButton.getText(void)</pre> |
|
165 |
|
166 </div> |
|
167 |
|
168 <div class="section"><h3 class="sectiontitle"> |
|
169 Description</h3> |
|
170 |
|
171 |
|
172 <p> |
|
173 |
|
174 Retrieves the current text of the button. |
|
175 The value is an XHTML string. |
|
176 </p> |
|
177 |
|
178 </div> |
|
179 |
|
180 <div class="section"><h3 class="sectiontitle"> |
|
181 Arguments</h3> |
|
182 |
|
183 |
|
184 <p> |
|
185 |
|
186 This method does not take any arguments. |
|
187 </p> |
|
188 |
|
189 </div> |
|
190 |
|
191 <div class="section"><h3 class="sectiontitle"> |
|
192 Return value</h3> |
|
193 |
|
194 |
|
195 <p> |
|
196 |
|
197 The current text of the button. |
|
198 </p> |
|
199 |
|
200 </div> |
|
201 |
|
202 </div> |
|
203 |
|
204 </div> |
|
205 |
|
206 <div class="nested1" id="GUID-0ACF25DA-ECF5-4D0A-8480-609497840FE4"><a name="GUID-0ACF25DA-ECF5-4D0A-8480-609497840FE4"><!-- --></a> |
|
207 |
|
208 <h2 class="topictitle2"> |
|
209 setText()</h2> |
|
210 |
|
211 <div> |
|
212 |
|
213 <div class="section"><h3 class="sectiontitle"> |
|
214 Syntax</h3> |
|
215 |
|
216 |
|
217 <pre> |
|
218 [void] FormButton.setText(String text)</pre> |
|
219 |
|
220 </div> |
|
221 |
|
222 <div class="section"><h3 class="sectiontitle"> |
|
223 Description</h3> |
|
224 |
|
225 |
|
226 <p> |
|
227 |
|
228 Sets the text of the button. The text is displayed on the face |
|
229 of the button and indicates what happens when the button is pressed. |
|
230 The value is an XHTML string. |
|
231 </p> |
|
232 |
|
233 </div> |
|
234 |
|
235 <div class="section"><h3 class="sectiontitle"> |
|
236 Arguments</h3> |
|
237 |
|
238 |
|
239 <br /><ul> |
|
240 |
|
241 <li> |
|
242 |
|
243 <p> |
|
244 text</p> |
|
245 |
|
246 |
|
247 |
|
248 <p> |
|
249 |
|
250 The text to be displayed on the face of the button. Passing null |
|
251 results in no text. |
|
252 </p> |
|
253 |
|
254 |
|
255 </li> |
|
256 |
|
257 </ul> |
|
258 |
|
259 </div> |
|
260 |
|
261 <div class="section"><h3 class="sectiontitle"> |
|
262 Return value</h3> |
|
263 |
|
264 |
|
265 <p> |
|
266 |
|
267 This method does not return a value. |
|
268 </p> |
|
269 |
|
270 </div> |
|
271 |
|
272 </div> |
|
273 |
|
274 </div> |
|
275 |
|
276 |
|
277 </body> |
|
278 </html> |
|