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