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-fieldset-element">&lt;fieldset&gt;</a>
023 * element.
024 *
025 * <p>
026 * The fieldset element groups related form controls together. It provides a visual and semantic
027 * grouping mechanism that helps organize complex forms and improves accessibility. The legend
028 * element is typically used as the first child to provide a caption for the fieldset.
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>// Simple fieldset with legend</jc>
035 *    Fieldset <jv>fieldset1</jv> = <jsm>fieldset</jsm>(
036 *       <jsm>legend</jsm>(<js>"Personal Information"</js>),
037 *       <jsm>input</jsm>(<js>"text"</js>).name(<js>"firstName"</js>).placeholder(<js>"First Name"</js>),
038 *       <jsm>input</jsm>(<js>"text"</js>).name(<js>"lastName"</js>).placeholder(<js>"Last Name"</js>)
039 *    );
040 *
041 *    <jc>// Disabled fieldset</jc>
042 *    Fieldset <jv>fieldset2</jv> = <jsm>fieldset</jsm>(
043 *       <jsm>legend</jsm>(<js>"Disabled Section"</js>),
044 *       <jsm>input</jsm>(<js>"text"</js>).name(<js>"disabledField"</js>).value(<js>"Cannot edit"</js>)
045 *    ).disabled(<jk>true</jk>);
046 *
047 *    <jc>// Fieldset with custom styling</jc>
048 *    Fieldset <jv>fieldset3</jv> = <jsm>fieldset</jsm>(
049 *       <jsm>legend</jsm>(<js>"Contact Details"</js>),
050 *       <jsm>input</jsm>(<js>"email"</js>).name(<js>"email"</js>).placeholder(<js>"Email"</js>),
051 *       <jsm>input</jsm>(<js>"tel"</js>).name(<js>"phone"</js>).placeholder(<js>"Phone"</js>)
052 *    )._class(<js>"form-group"</js>);
053 * </p>
054 *
055 * <p>
056 * The following convenience methods are provided for constructing instances of this bean:
057 * <ul class='javatree'>
058 *    <li class='jc'>{@link HtmlBuilder}
059 *    <ul class='javatree'>
060 *       <li class='jm'>{@link HtmlBuilder#fieldset() fieldset()}
061 *       <li class='jm'>{@link HtmlBuilder#fieldset(Object...) fieldset(Object...)}
062 *    </ul>
063 * </ul>
064 * </p>
065 *
066 * <h5 class='section'>See Also:</h5><ul>
067 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauBeanHtml5">juneau-bean-html5</a>
068 * </ul>
069 */
070@Bean(typeName = "fieldset")
071public class Fieldset extends HtmlElementMixed {
072
073   /**
074    * Creates an empty {@link Fieldset} element.
075    */
076   public Fieldset() {}
077
078   /**
079    * Creates a {@link Fieldset} element with the specified child nodes.
080    *
081    * @param children The child nodes.
082    */
083   public Fieldset(Object...children) {
084      children(children);
085   }
086
087   @Override /* Overridden from HtmlElement */
088   public Fieldset _class(String value) { // NOSONAR - Intentional naming.
089      super._class(value);
090      return this;
091   }
092
093   @Override /* Overridden from HtmlElement */
094   public Fieldset accesskey(String value) {
095      super.accesskey(value);
096      return this;
097   }
098
099   @Override /* Overridden from HtmlElement */
100   public Fieldset attr(String key, Object val) {
101      super.attr(key, val);
102      return this;
103   }
104
105   @Override /* Overridden from HtmlElement */
106   public Fieldset attrUri(String key, Object val) {
107      super.attrUri(key, val);
108      return this;
109   }
110
111   @Override /* Overridden from HtmlElementMixed */
112   public Fieldset child(Object value) {
113      super.child(value);
114      return this;
115   }
116
117   @Override /* Overridden from HtmlElementMixed */
118   public Fieldset children(Object...value) {
119      super.children(value);
120      return this;
121   }
122
123   @Override /* Overridden from HtmlElement */
124   public Fieldset contenteditable(Object value) {
125      super.contenteditable(value);
126      return this;
127   }
128
129   @Override /* Overridden from HtmlElement */
130   public Fieldset dir(String value) {
131      super.dir(value);
132      return this;
133   }
134
135   /**
136    * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fieldset-disabled">disabled</a> attribute.
137    *
138    * <p>
139    * Whether the form control is disabled.
140    *
141    * <p>
142    * This attribute uses deminimized values:
143    * <ul>
144    *    <li><jk>false</jk> - Attribute is not added</li>
145    *    <li><jk>true</jk> - Attribute is added as <js>"disabled"</js></li>
146    *    <li>Other values - Passed through as-is</li>
147    * </ul>
148    *
149    * @param value
150    *    The new value for this attribute.
151    *    Typically a {@link Boolean} or {@link String}.
152    * @return This object.
153    */
154   public Fieldset disabled(Object value) {
155      attr("disabled", deminimize(value, "disabled"));
156      return this;
157   }
158
159   /**
160    * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fae-form">form</a> attribute.
161    *
162    * <p>
163    * Associates the fieldset with a form element by specifying the form's ID. This allows the fieldset
164    * to be placed outside the form element while still being part of the form.
165    *
166    * <p>
167    * The value should match the ID of a form element in the same document.
168    *
169    * @param value The ID of the form element to associate with this fieldset.
170    * @return This object.
171    */
172   public Fieldset form(String value) {
173      attr("form", value);
174      return this;
175   }
176
177   @Override /* Overridden from HtmlElement */
178   public Fieldset hidden(Object value) {
179      super.hidden(value);
180      return this;
181   }
182
183   @Override /* Overridden from HtmlElement */
184   public Fieldset id(String value) {
185      super.id(value);
186      return this;
187   }
188
189   @Override /* Overridden from HtmlElement */
190   public Fieldset lang(String value) {
191      super.lang(value);
192      return this;
193   }
194
195   /**
196    * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-name">name</a> attribute.
197    *
198    * <p>
199    * Specifies the name of the fieldset. This name can be used to access the fieldset
200    * via the form.elements API and for form submission.
201    *
202    * <p>
203    * The name should be unique within the form and should not contain spaces or special characters.
204    *
205    * @param value The name of the fieldset for API access and submission.
206    * @return This object.
207    */
208   public Fieldset name(String value) {
209      attr("name", value);
210      return this;
211   }
212
213   @Override /* Overridden from HtmlElement */
214   public Fieldset onabort(String value) {
215      super.onabort(value);
216      return this;
217   }
218
219   @Override /* Overridden from HtmlElement */
220   public Fieldset onblur(String value) {
221      super.onblur(value);
222      return this;
223   }
224
225   @Override /* Overridden from HtmlElement */
226   public Fieldset oncancel(String value) {
227      super.oncancel(value);
228      return this;
229   }
230
231   @Override /* Overridden from HtmlElement */
232   public Fieldset oncanplay(String value) {
233      super.oncanplay(value);
234      return this;
235   }
236
237   @Override /* Overridden from HtmlElement */
238   public Fieldset oncanplaythrough(String value) {
239      super.oncanplaythrough(value);
240      return this;
241   }
242
243   @Override /* Overridden from HtmlElement */
244   public Fieldset onchange(String value) {
245      super.onchange(value);
246      return this;
247   }
248
249   @Override /* Overridden from HtmlElement */
250   public Fieldset onclick(String value) {
251      super.onclick(value);
252      return this;
253   }
254
255   @Override /* Overridden from HtmlElement */
256   public Fieldset oncuechange(String value) {
257      super.oncuechange(value);
258      return this;
259   }
260
261   @Override /* Overridden from HtmlElement */
262   public Fieldset ondblclick(String value) {
263      super.ondblclick(value);
264      return this;
265   }
266
267   @Override /* Overridden from HtmlElement */
268   public Fieldset ondurationchange(String value) {
269      super.ondurationchange(value);
270      return this;
271   }
272
273   @Override /* Overridden from HtmlElement */
274   public Fieldset onemptied(String value) {
275      super.onemptied(value);
276      return this;
277   }
278
279   @Override /* Overridden from HtmlElement */
280   public Fieldset onended(String value) {
281      super.onended(value);
282      return this;
283   }
284
285   @Override /* Overridden from HtmlElement */
286   public Fieldset onerror(String value) {
287      super.onerror(value);
288      return this;
289   }
290
291   @Override /* Overridden from HtmlElement */
292   public Fieldset onfocus(String value) {
293      super.onfocus(value);
294      return this;
295   }
296
297   @Override /* Overridden from HtmlElement */
298   public Fieldset oninput(String value) {
299      super.oninput(value);
300      return this;
301   }
302
303   @Override /* Overridden from HtmlElement */
304   public Fieldset oninvalid(String value) {
305      super.oninvalid(value);
306      return this;
307   }
308
309   @Override /* Overridden from HtmlElement */
310   public Fieldset onkeydown(String value) {
311      super.onkeydown(value);
312      return this;
313   }
314
315   @Override /* Overridden from HtmlElement */
316   public Fieldset onkeypress(String value) {
317      super.onkeypress(value);
318      return this;
319   }
320
321   @Override /* Overridden from HtmlElement */
322   public Fieldset onkeyup(String value) {
323      super.onkeyup(value);
324      return this;
325   }
326
327   @Override /* Overridden from HtmlElement */
328   public Fieldset onload(String value) {
329      super.onload(value);
330      return this;
331   }
332
333   @Override /* Overridden from HtmlElement */
334   public Fieldset onloadeddata(String value) {
335      super.onloadeddata(value);
336      return this;
337   }
338
339   @Override /* Overridden from HtmlElement */
340   public Fieldset onloadedmetadata(String value) {
341      super.onloadedmetadata(value);
342      return this;
343   }
344
345   @Override /* Overridden from HtmlElement */
346   public Fieldset onloadstart(String value) {
347      super.onloadstart(value);
348      return this;
349   }
350
351   @Override /* Overridden from HtmlElement */
352   public Fieldset onmousedown(String value) {
353      super.onmousedown(value);
354      return this;
355   }
356
357   @Override /* Overridden from HtmlElement */
358   public Fieldset onmouseenter(String value) {
359      super.onmouseenter(value);
360      return this;
361   }
362
363   @Override /* Overridden from HtmlElement */
364   public Fieldset onmouseleave(String value) {
365      super.onmouseleave(value);
366      return this;
367   }
368
369   @Override /* Overridden from HtmlElement */
370   public Fieldset onmousemove(String value) {
371      super.onmousemove(value);
372      return this;
373   }
374
375   @Override /* Overridden from HtmlElement */
376   public Fieldset onmouseout(String value) {
377      super.onmouseout(value);
378      return this;
379   }
380
381   @Override /* Overridden from HtmlElement */
382   public Fieldset onmouseover(String value) {
383      super.onmouseover(value);
384      return this;
385   }
386
387   @Override /* Overridden from HtmlElement */
388   public Fieldset onmouseup(String value) {
389      super.onmouseup(value);
390      return this;
391   }
392
393   @Override /* Overridden from HtmlElement */
394   public Fieldset onmousewheel(String value) {
395      super.onmousewheel(value);
396      return this;
397   }
398
399   @Override /* Overridden from HtmlElement */
400   public Fieldset onpause(String value) {
401      super.onpause(value);
402      return this;
403   }
404
405   @Override /* Overridden from HtmlElement */
406   public Fieldset onplay(String value) {
407      super.onplay(value);
408      return this;
409   }
410
411   @Override /* Overridden from HtmlElement */
412   public Fieldset onplaying(String value) {
413      super.onplaying(value);
414      return this;
415   }
416
417   @Override /* Overridden from HtmlElement */
418   public Fieldset onprogress(String value) {
419      super.onprogress(value);
420      return this;
421   }
422
423   @Override /* Overridden from HtmlElement */
424   public Fieldset onratechange(String value) {
425      super.onratechange(value);
426      return this;
427   }
428
429   @Override /* Overridden from HtmlElement */
430   public Fieldset onreset(String value) {
431      super.onreset(value);
432      return this;
433   }
434
435   @Override /* Overridden from HtmlElement */
436   public Fieldset onresize(String value) {
437      super.onresize(value);
438      return this;
439   }
440
441   @Override /* Overridden from HtmlElement */
442   public Fieldset onscroll(String value) {
443      super.onscroll(value);
444      return this;
445   }
446
447   @Override /* Overridden from HtmlElement */
448   public Fieldset onseeked(String value) {
449      super.onseeked(value);
450      return this;
451   }
452
453   @Override /* Overridden from HtmlElement */
454   public Fieldset onseeking(String value) {
455      super.onseeking(value);
456      return this;
457   }
458
459   @Override /* Overridden from HtmlElement */
460   public Fieldset onselect(String value) {
461      super.onselect(value);
462      return this;
463   }
464
465   @Override /* Overridden from HtmlElement */
466   public Fieldset onshow(String value) {
467      super.onshow(value);
468      return this;
469   }
470
471   @Override /* Overridden from HtmlElement */
472   public Fieldset onstalled(String value) {
473      super.onstalled(value);
474      return this;
475   }
476
477   @Override /* Overridden from HtmlElement */
478   public Fieldset onsubmit(String value) {
479      super.onsubmit(value);
480      return this;
481   }
482
483   @Override /* Overridden from HtmlElement */
484   public Fieldset onsuspend(String value) {
485      super.onsuspend(value);
486      return this;
487   }
488
489   @Override /* Overridden from HtmlElement */
490   public Fieldset ontimeupdate(String value) {
491      super.ontimeupdate(value);
492      return this;
493   }
494
495   @Override /* Overridden from HtmlElement */
496   public Fieldset ontoggle(String value) {
497      super.ontoggle(value);
498      return this;
499   }
500
501   @Override /* Overridden from HtmlElement */
502   public Fieldset onvolumechange(String value) {
503      super.onvolumechange(value);
504      return this;
505   }
506
507   @Override /* Overridden from HtmlElement */
508   public Fieldset onwaiting(String value) {
509      super.onwaiting(value);
510      return this;
511   }
512
513   @Override /* Overridden from HtmlElement */
514   public Fieldset spellcheck(Object value) {
515      super.spellcheck(value);
516      return this;
517   }
518
519   @Override /* Overridden from HtmlElement */
520   public Fieldset style(String value) {
521      super.style(value);
522      return this;
523   }
524
525   @Override /* Overridden from HtmlElement */
526   public Fieldset tabindex(Object value) {
527      super.tabindex(value);
528      return this;
529   }
530
531   @Override /* Overridden from HtmlElement */
532   public Fieldset title(String value) {
533      super.title(value);
534      return this;
535   }
536
537   @Override /* Overridden from HtmlElement */
538   public Fieldset translate(Object value) {
539      super.translate(value);
540      return this;
541   }
542}