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