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