|
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 TextField 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-799B7DEA-1E4D-4147-BC27-ACC4B91D8BF9" name="DC.Identifier" /> |
|
12 <meta content="en" name="DC.Language" /> |
|
13 <link href="commonltr.css" type="text/css" rel="stylesheet" /> |
|
14 <title> |
|
15 WRTKit TextField Class</title> |
|
16 </head> |
|
17 <body id="GUID-799B7DEA-1E4D-4147-BC27-ACC4B91D8BF9"><a name="GUID-799B7DEA-1E4D-4147-BC27-ACC4B91D8BF9"><!-- --></a> |
|
18 |
|
19 |
|
20 |
|
21 <h1 class="topictitle1"> |
|
22 WRTKit TextField Class</h1> |
|
23 |
|
24 <div> |
|
25 |
|
26 <div class="section"><h2 class="sectiontitle"> |
|
27 Description</h2> |
|
28 |
|
29 |
|
30 <p> |
|
31 |
|
32 The TextField class implements a single line text entry control. The control |
|
33 is useful for situations where text is relatively short and doesn't need to |
|
34 span multiple lines. The text field also supports masked entry, which is good |
|
35 in situations where passwords or other secret text is entered. |
|
36 </p> |
|
37 |
|
38 <div class="fignone" id="GUID-799B7DEA-1E4D-4147-BC27-ACC4B91D8BF9__GUID-5FDA8C14-4D9A-444B-9595-54284FB8EB01"><a name="GUID-799B7DEA-1E4D-4147-BC27-ACC4B91D8BF9__GUID-5FDA8C14-4D9A-444B-9595-54284FB8EB01"><!-- --></a><span class="figcap">Figure 1. |
|
39 TextField control</span> |
|
40 |
|
41 |
|
42 <br /><img src="TextField_Control_Screenshot_1.png" /><br /> |
|
43 </div> |
|
44 |
|
45 </div> |
|
46 |
|
47 <div class="section"><h2 class="sectiontitle"> |
|
48 Inherits from</h2> |
|
49 |
|
50 |
|
51 <p> |
|
52 |
|
53 <a href="WRTKit_TextEntryControl_Class-GUID-07359ff7-6015-4d2c-a9bf-b345fcf49090.html"> |
|
54 TextEntryControl</a> |
|
55 </p> |
|
56 |
|
57 </div> |
|
58 |
|
59 </div> |
|
60 |
|
61 <div> |
|
62 <div class="familylinks"> |
|
63 <div class="parentlink"><strong>Parent topic:</strong> <a href="WRTKit_API_Reference-GUID-00e47c27-0a1a-443f-ae85-cf3381635170.html">WRTKit API Reference</a></div> |
|
64 </div> |
|
65 </div> |
|
66 <div class="nested1" id="GUID-F3525C69-F5C8-4D20-BA8B-6EB52A8003F8"><a name="GUID-F3525C69-F5C8-4D20-BA8B-6EB52A8003F8"><!-- --></a> |
|
67 |
|
68 <h2 class="topictitle2"> |
|
69 Constructor</h2> |
|
70 |
|
71 <div> |
|
72 |
|
73 <div class="section"><h3 class="sectiontitle"> |
|
74 Syntax</h3> |
|
75 |
|
76 |
|
77 <pre> |
|
78 [TextField] new TextField(String id, String caption, String text, Boolean masked)</pre> |
|
79 |
|
80 </div> |
|
81 |
|
82 <div class="section"><h3 class="sectiontitle"> |
|
83 Description</h3> |
|
84 |
|
85 |
|
86 <p> |
|
87 |
|
88 Creates a new instance of the TextField class. |
|
89 </p> |
|
90 |
|
91 </div> |
|
92 |
|
93 <div class="section"><h3 class="sectiontitle"> |
|
94 Arguments</h3> |
|
95 |
|
96 |
|
97 <br /><ul> |
|
98 |
|
99 <li> |
|
100 |
|
101 <p> |
|
102 id</p> |
|
103 |
|
104 |
|
105 |
|
106 <p> |
|
107 |
|
108 Unique identifier for the control. Can be retrieved using the id property defined |
|
109 in the UIElement class that this control inherits from. Useful for example to |
|
110 identify the source of an event in event callback functions or to apply a CSS |
|
111 rule to only this particular control. The identifier can be null, in which case |
|
112 no id will be set for the control. |
|
113 </p> |
|
114 |
|
115 |
|
116 </li> |
|
117 |
|
118 <li> |
|
119 |
|
120 <p> |
|
121 caption</p> |
|
122 |
|
123 |
|
124 |
|
125 <p> |
|
126 |
|
127 The caption text for the control. A null caption can be used to hide the |
|
128 caption area. The value is an XHTML string. |
|
129 </p> |
|
130 |
|
131 |
|
132 </li> |
|
133 |
|
134 <li> |
|
135 |
|
136 <p> |
|
137 text</p> |
|
138 |
|
139 |
|
140 |
|
141 <p> |
|
142 |
|
143 The text to display in the text field. If the argument is omitted or null then |
|
144 the text field will not contain any text when created. |
|
145 The value is a plain text string (not XHTML). |
|
146 </p> |
|
147 |
|
148 |
|
149 </li> |
|
150 |
|
151 <li> |
|
152 |
|
153 <p> |
|
154 masked</p> |
|
155 |
|
156 |
|
157 |
|
158 <p> |
|
159 |
|
160 If the masked argument is true then the text field will be created in masked |
|
161 text entry mode. If the argument is omitted or false then the control will be |
|
162 created in normal text entry mode. |
|
163 </p> |
|
164 |
|
165 |
|
166 </li> |
|
167 |
|
168 </ul> |
|
169 |
|
170 </div> |
|
171 |
|
172 <div class="section"><h3 class="sectiontitle"> |
|
173 Return value</h3> |
|
174 |
|
175 |
|
176 <p> |
|
177 |
|
178 A new instance of the TextField class. |
|
179 </p> |
|
180 |
|
181 </div> |
|
182 |
|
183 </div> |
|
184 |
|
185 </div> |
|
186 |
|
187 |
|
188 </body> |
|
189 </html> |