Source code

001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.bean.html5;
018
019import org.apache.juneau.annotation.*;
020
021/**
022 * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#the-label-element">&lt;label&gt;</a>
023 * element.
024 *
025 * <p>
026 * The label element represents a caption for a form control. It provides a programmatic association
027 * between the label and the form control, improving accessibility and user experience. When a label
028 * is associated with a form control, clicking the label will focus or activate the control.
029 *
030 * <h5 class='section'>Examples:</h5>
031 * <p class='bcode w800'>
032 *    <jk>import static</jk> org.apache.juneau.bean.html5.HtmlBuilder.*;
033 *
034 *    <jc>// Label with explicit association</jc>
035 *    Label <jv>label1</jv> = <jsm>label</jsm>(<js>"Username:"</js>)
036 *       ._for(<js>"username"</js>);
037 *
038 *    <jc>// Label wrapping form control</jc>
039 *    Label <jv>label2</jv> = <jsm>label</jsm>(
040 *       <jsm>input</jsm>(<js>"checkbox"</js>).name(<js>"agree"</js>),
041 *       <jsm>span</jsm>(<js>"I agree to the terms and conditions"</js>)
042 *    );
043 *
044 *    <jc>// Label with form association</jc>
045 *    Label <jv>label3</jv> = <jsm>label</jsm>(<js>"Email Address:"</js>)
046 *       ._for(<js>"email"</js>)
047 *       .form(<js>"contactForm"</js>);
048 *
049 *    <jc>// Label with styling</jc>
050 *    Label <jv>label4</jv> = <jsm>label</jsm>(<js>"Password:"</js>)
051 *       ._for(<js>"password"</js>)
052 *       ._class(<js>"required"</js>);
053 * </p>
054 *
055 * <h5 class='section'>See Also:</h5><ul>
056 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauBeanHtml5">juneau-bean-html5</a>
057 * </ul>
058 */
059@Bean(typeName = "label")
060public class Label extends HtmlElementMixed {
061
062   /**
063    * Creates an empty {@link Label} element.
064    */
065   public Label() {}
066
067   /**
068    * Creates a {@link Label} element with the specified child nodes.
069    *
070    * @param children The child nodes.
071    */
072   public Label(Object...children) {
073      children(children);
074   }
075
076   @Override /* Overridden from HtmlElement */
077   public Label _class(String value) { // NOSONAR - Intentional naming.
078      super._class(value);
079      return this;
080   }
081
082   /**
083    * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-label-for">for</a> attribute.
084    *
085    * <p>
086    * Associates the label with a form control by specifying the control's ID. This creates
087    * a programmatic relationship between the label and the form control for accessibility.
088    *
089    * <p>
090    * The value should match the ID of a form control element in the same document.
091    *
092    * @param value The ID of the form control to associate with this label.
093    * @return This object.
094    */
095   public Label _for(String value) { // NOSONAR - Intentional naming.
096      attr("for", value);
097      return this;
098   }
099
100   @Override /* Overridden from HtmlElement */
101   public Label accesskey(String value) {
102      super.accesskey(value);
103      return this;
104   }
105
106   @Override /* Overridden from HtmlElement */
107   public Label attr(String key, Object val) {
108      super.attr(key, val);
109      return this;
110   }
111
112   @Override /* Overridden from HtmlElement */
113   public Label attrUri(String key, Object val) {
114      super.attrUri(key, val);
115      return this;
116   }
117
118   @Override /* Overridden from HtmlElementMixed */
119   public Label child(Object value) {
120      super.child(value);
121      return this;
122   }
123
124   @Override /* Overridden from HtmlElementMixed */
125   public Label children(Object...value) {
126      super.children(value);
127      return this;
128   }
129
130   @Override /* Overridden from HtmlElement */
131   public Label contenteditable(Object value) {
132      super.contenteditable(value);
133      return this;
134   }
135
136   @Override /* Overridden from HtmlElement */
137   public Label dir(String value) {
138      super.dir(value);
139      return this;
140   }
141
142   /**
143    * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fae-form">form</a> attribute.
144    *
145    * <p>
146    * Associates the label with a form element by specifying the form's ID. This allows the label
147    * to be placed outside the form element while still being part of the form.
148    *
149    * <p>
150    * The value should match the ID of a form element in the same document.
151    *
152    * @param value The ID of the form element to associate with this label.
153    * @return This object.
154    */
155   public Label form(String value) {
156      attr("form", value);
157      return this;
158   }
159
160   @Override /* Overridden from HtmlElement */
161   public Label hidden(Object value) {
162      super.hidden(value);
163      return this;
164   }
165
166   @Override /* Overridden from HtmlElement */
167   public Label id(String value) {
168      super.id(value);
169      return this;
170   }
171
172   @Override /* Overridden from HtmlElement */
173   public Label lang(String value) {
174      super.lang(value);
175      return this;
176   }
177
178   @Override /* Overridden from HtmlElement */
179   public Label onabort(String value) {
180      super.onabort(value);
181      return this;
182   }
183
184   @Override /* Overridden from HtmlElement */
185   public Label onblur(String value) {
186      super.onblur(value);
187      return this;
188   }
189
190   @Override /* Overridden from HtmlElement */
191   public Label oncancel(String value) {
192      super.oncancel(value);
193      return this;
194   }
195
196   @Override /* Overridden from HtmlElement */
197   public Label oncanplay(String value) {
198      super.oncanplay(value);
199      return this;
200   }
201
202   @Override /* Overridden from HtmlElement */
203   public Label oncanplaythrough(String value) {
204      super.oncanplaythrough(value);
205      return this;
206   }
207
208   @Override /* Overridden from HtmlElement */
209   public Label onchange(String value) {
210      super.onchange(value);
211      return this;
212   }
213
214   @Override /* Overridden from HtmlElement */
215   public Label onclick(String value) {
216      super.onclick(value);
217      return this;
218   }
219
220   @Override /* Overridden from HtmlElement */
221   public Label oncuechange(String value) {
222      super.oncuechange(value);
223      return this;
224   }
225
226   @Override /* Overridden from HtmlElement */
227   public Label ondblclick(String value) {
228      super.ondblclick(value);
229      return this;
230   }
231
232   @Override /* Overridden from HtmlElement */
233   public Label ondurationchange(String value) {
234      super.ondurationchange(value);
235      return this;
236   }
237
238   @Override /* Overridden from HtmlElement */
239   public Label onemptied(String value) {
240      super.onemptied(value);
241      return this;
242   }
243
244   @Override /* Overridden from HtmlElement */
245   public Label onended(String value) {
246      super.onended(value);
247      return this;
248   }
249
250   @Override /* Overridden from HtmlElement */
251   public Label onerror(String value) {
252      super.onerror(value);
253      return this;
254   }
255
256   @Override /* Overridden from HtmlElement */
257   public Label onfocus(String value) {
258      super.onfocus(value);
259      return this;
260   }
261
262   @Override /* Overridden from HtmlElement */
263   public Label oninput(String value) {
264      super.oninput(value);
265      return this;
266   }
267
268   @Override /* Overridden from HtmlElement */
269   public Label oninvalid(String value) {
270      super.oninvalid(value);
271      return this;
272   }
273
274   @Override /* Overridden from HtmlElement */
275   public Label onkeydown(String value) {
276      super.onkeydown(value);
277      return this;
278   }
279
280   @Override /* Overridden from HtmlElement */
281   public Label onkeypress(String value) {
282      super.onkeypress(value);
283      return this;
284   }
285
286   @Override /* Overridden from HtmlElement */
287   public Label onkeyup(String value) {
288      super.onkeyup(value);
289      return this;
290   }
291
292   @Override /* Overridden from HtmlElement */
293   public Label onload(String value) {
294      super.onload(value);
295      return this;
296   }
297
298   @Override /* Overridden from HtmlElement */
299   public Label onloadeddata(String value) {
300      super.onloadeddata(value);
301      return this;
302   }
303
304   @Override /* Overridden from HtmlElement */
305   public Label onloadedmetadata(String value) {
306      super.onloadedmetadata(value);
307      return this;
308   }
309
310   @Override /* Overridden from HtmlElement */
311   public Label onloadstart(String value) {
312      super.onloadstart(value);
313      return this;
314   }
315
316   @Override /* Overridden from HtmlElement */
317   public Label onmousedown(String value) {
318      super.onmousedown(value);
319      return this;
320   }
321
322   @Override /* Overridden from HtmlElement */
323   public Label onmouseenter(String value) {
324      super.onmouseenter(value);
325      return this;
326   }
327
328   @Override /* Overridden from HtmlElement */
329   public Label onmouseleave(String value) {
330      super.onmouseleave(value);
331      return this;
332   }
333
334   @Override /* Overridden from HtmlElement */
335   public Label onmousemove(String value) {
336      super.onmousemove(value);
337      return this;
338   }
339
340   @Override /* Overridden from HtmlElement */
341   public Label onmouseout(String value) {
342      super.onmouseout(value);
343      return this;
344   }
345
346   @Override /* Overridden from HtmlElement */
347   public Label onmouseover(String value) {
348      super.onmouseover(value);
349      return this;
350   }
351
352   @Override /* Overridden from HtmlElement */
353   public Label onmouseup(String value) {
354      super.onmouseup(value);
355      return this;
356   }
357
358   @Override /* Overridden from HtmlElement */
359   public Label onmousewheel(String value) {
360      super.onmousewheel(value);
361      return this;
362   }
363
364   @Override /* Overridden from HtmlElement */
365   public Label onpause(String value) {
366      super.onpause(value);
367      return this;
368   }
369
370   @Override /* Overridden from HtmlElement */
371   public Label onplay(String value) {
372      super.onplay(value);
373      return this;
374   }
375
376   @Override /* Overridden from HtmlElement */
377   public Label onplaying(String value) {
378      super.onplaying(value);
379      return this;
380   }
381
382   @Override /* Overridden from HtmlElement */
383   public Label onprogress(String value) {
384      super.onprogress(value);
385      return this;
386   }
387
388   @Override /* Overridden from HtmlElement */
389   public Label onratechange(String value) {
390      super.onratechange(value);
391      return this;
392   }
393
394   @Override /* Overridden from HtmlElement */
395   public Label onreset(String value) {
396      super.onreset(value);
397      return this;
398   }
399
400   @Override /* Overridden from HtmlElement */
401   public Label onresize(String value) {
402      super.onresize(value);
403      return this;
404   }
405
406   @Override /* Overridden from HtmlElement */
407   public Label onscroll(String value) {
408      super.onscroll(value);
409      return this;
410   }
411
412   @Override /* Overridden from HtmlElement */
413   public Label onseeked(String value) {
414      super.onseeked(value);
415      return this;
416   }
417
418   @Override /* Overridden from HtmlElement */
419   public Label onseeking(String value) {
420      super.onseeking(value);
421      return this;
422   }
423
424   @Override /* Overridden from HtmlElement */
425   public Label onselect(String value) {
426      super.onselect(value);
427      return this;
428   }
429
430   @Override /* Overridden from HtmlElement */
431   public Label onshow(String value) {
432      super.onshow(value);
433      return this;
434   }
435
436   @Override /* Overridden from HtmlElement */
437   public Label onstalled(String value) {
438      super.onstalled(value);
439      return this;
440   }
441
442   @Override /* Overridden from HtmlElement */
443   public Label onsubmit(String value) {
444      super.onsubmit(value);
445      return this;
446   }
447
448   @Override /* Overridden from HtmlElement */
449   public Label onsuspend(String value) {
450      super.onsuspend(value);
451      return this;
452   }
453
454   @Override /* Overridden from HtmlElement */
455   public Label ontimeupdate(String value) {
456      super.ontimeupdate(value);
457      return this;
458   }
459
460   @Override /* Overridden from HtmlElement */
461   public Label ontoggle(String value) {
462      super.ontoggle(value);
463      return this;
464   }
465
466   @Override /* Overridden from HtmlElement */
467   public Label onvolumechange(String value) {
468      super.onvolumechange(value);
469      return this;
470   }
471
472   @Override /* Overridden from HtmlElement */
473   public Label onwaiting(String value) {
474      super.onwaiting(value);
475      return this;
476   }
477
478   @Override /* Overridden from HtmlElement */
479   public Label spellcheck(Object value) {
480      super.spellcheck(value);
481      return this;
482   }
483
484   @Override /* Overridden from HtmlElement */
485   public Label style(String value) {
486      super.style(value);
487      return this;
488   }
489
490   @Override /* Overridden from HtmlElement */
491   public Label tabindex(Object value) {
492      super.tabindex(value);
493      return this;
494   }
495
496   @Override /* Overridden from HtmlElement */
497   public Label title(String value) {
498      super.title(value);
499      return this;
500   }
501
502   @Override /* Overridden from HtmlElement */
503   public Label translate(Object value) {
504      super.translate(value);
505      return this;
506   }
507}