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-datalist-element">&lt;datalist&gt;</a>
025 * element.
026 *
027 * <p>
028 * The datalist element represents a set of option elements that represent predefined options for other
029 * controls. It is used to provide a list of suggested values for input elements, allowing users to
030 * either select from the predefined options or enter their own custom value. The datalist element
031 * is typically associated with an input element through the list attribute, and the options within
032 * the datalist provide autocomplete suggestions.
033 *
034 * <h5 class='section'>Examples:</h5>
035 * <p class='bcode w800'>
036 *    <jk>import static</jk> org.apache.juneau.bean.html5.HtmlBuilder.*;
037 *
038 *    <jc>// Simple datalist</jc>
039 *    Datalist <jv>simple</jv> = <jsm>datalist</jsm>(<js>"colors"</js>,
040 *       <jsm>option</jsm>(<js>"red"</js>, <js>"Red"</js>),
041 *       <jsm>option</jsm>(<js>"green"</js>, <js>"Green"</js>),
042 *       <jsm>option</jsm>(<js>"blue"</js>, <js>"Blue"</js>)
043 *    );
044 *
045 *    <jc>// Datalist with styling</jc>
046 *    Datalist <jv>styled</jv> = <jsm>datalist</jsm>(<js>"countries"</js>,
047 *       <jsm>option</jsm>(<js>"us"</js>, <js>"United States"</js>),
048 *       <jsm>option</jsm>(<js>"ca"</js>, <js>"Canada"</js>),
049 *       <jsm>option</jsm>(<js>"mx"</js>, <js>"Mexico"</js>)
050 *    )._class(<js>"country-list"</js>);
051 *
052 *    <jc>// Datalist with multiple options</jc>
053 *    Datalist <jv>multiple</jv> = <jsm>datalist</jsm>(<js>"fruits"</js>,
054 *       <jsm>option</jsm>(<js>"apple"</js>, <js>"Apple"</js>),
055 *       <jsm>option</jsm>(<js>"banana"</js>, <js>"Banana"</js>),
056 *       <jsm>option</jsm>(<js>"cherry"</js>, <js>"Cherry"</js>),
057 *       <jsm>option</jsm>(<js>"date"</js>, <js>"Date"</js>),
058 *       <jsm>option</jsm>(<js>"elderberry"</js>, <js>"Elderberry"</js>)
059 *    );
060 *
061 *    <jc>// Datalist with complex options</jc>
062 *    Datalist <jv>complex</jv> = <jsm>datalist</jsm>(<js>"products"</js>,
063 *       <jsm>option</jsm>(<js>"laptop-001"</js>, <js>"Laptop Pro 15\" - $1,299"</js>),
064 *       <jsm>option</jsm>(<js>"laptop-002"</js>, <js>"Laptop Air 13\" - $999"</js>),
065 *       <jsm>option</jsm>(<js>"tablet-001"</js>, <js>"Tablet 10\" - $499"</js>)
066 *    );
067 *
068 *    <jc>// Datalist with ID</jc>
069 *    Datalist <jv>withId</jv> = <jsm>datalist</jsm>(<js>"cities"</js>,
070 *       <jsm>option</jsm>(<js>"new-york"</js>, <js>"New York"</js>),
071 *       <jsm>option</jsm>(<js>"los-angeles"</js>, <js>"Los Angeles"</js>),
072 *       <jsm>option</jsm>(<js>"chicago"</js>, <js>"Chicago"</js>)
073 *    );
074 *
075 *    <jc>// Datalist with styling</jc>
076 *    Datalist <jv>styled2</jv> = <jsm>datalist</jsm>(<js>"sizes"</js>,
077 *       <jsm>option</jsm>(<js>"xs"</js>, <js>"Extra Small"</js>),
078 *       <jsm>option</jsm>(<js>"s"</js>, <js>"Small"</js>),
079 *       <jsm>option</jsm>(<js>"m"</js>, <js>"Medium"</js>),
080 *       <jsm>option</jsm>(<js>"l"</js>, <js>"Large"</js>),
081 *       <jsm>option</jsm>(<js>"xl"</js>, <js>"Extra Large"</js>)
082 *    ).style(<js>"display: none;"</js>);
083 * </p>
084 *
085 * <p>
086 * The following convenience methods are provided for constructing instances of this bean:
087 * <ul class='javatree'>
088 *    <li class='jc'>{@link HtmlBuilder}
089 *    <ul class='javatree'>
090 *       <li class='jm'>{@link HtmlBuilder#datalist() datalist()}
091 *       <li class='jm'>{@link HtmlBuilder#datalist(String, Option...) datalist(String, Option...)}
092 *    </ul>
093 * </ul>
094 * </p>
095 *
096 * <h5 class='section'>See Also:</h5><ul>
097 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauBeanHtml5">juneau-bean-html5</a>
098 * </ul>
099 */
100@Bean(typeName = "datalist")
101public class Datalist extends HtmlElementContainer {
102
103   /**
104    * Creates an empty {@link Datalist} element.
105    */
106   public Datalist() {}
107
108   /**
109    * Creates a {@link Datalist} element with the specified {@link Datalist#id(String)} attribute and child nodes.
110    *
111    * @param id The {@link Datalist#id(String)} attribute.
112    * @param children The child nodes.
113    */
114   public Datalist(String id, Option...children) {
115      id(id).children((Object[])children);
116   }
117
118   @Override /* Overridden from HtmlElement */
119   public Datalist _class(String value) { // NOSONAR - Intentional naming.
120      super._class(value);
121      return this;
122   }
123
124   @Override /* Overridden from HtmlElement */
125   public Datalist accesskey(String value) {
126      super.accesskey(value);
127      return this;
128   }
129
130   @Override /* Overridden from HtmlElement */
131   public Datalist attr(String key, Object val) {
132      super.attr(key, val);
133      return this;
134   }
135
136   @Override /* Overridden from HtmlElement */
137   public Datalist attrUri(String key, Object val) {
138      super.attrUri(key, val);
139      return this;
140   }
141
142   @Override /* Overridden from HtmlElementContainer */
143   public Datalist child(Object value) {
144      super.child(value);
145      return this;
146   }
147
148   @Override /* Overridden from HtmlElementContainer */
149   public Datalist children(Object...value) {
150      super.children(value);
151      return this;
152   }
153
154   @Override /* Overridden from HtmlElement */
155   public Datalist contenteditable(Object value) {
156      super.contenteditable(value);
157      return this;
158   }
159
160   @Override /* Overridden from HtmlElement */
161   public Datalist dir(String value) {
162      super.dir(value);
163      return this;
164   }
165
166   @Override /* Overridden from HtmlElement */
167   public Datalist hidden(Object value) {
168      super.hidden(value);
169      return this;
170   }
171
172   @Override /* Overridden from HtmlElement */
173   public Datalist id(String value) {
174      super.id(value);
175      return this;
176   }
177
178   @Override /* Overridden from HtmlElement */
179   public Datalist lang(String value) {
180      super.lang(value);
181      return this;
182   }
183
184   @Override /* Overridden from HtmlElement */
185   public Datalist onabort(String value) {
186      super.onabort(value);
187      return this;
188   }
189
190   @Override /* Overridden from HtmlElement */
191   public Datalist onblur(String value) {
192      super.onblur(value);
193      return this;
194   }
195
196   @Override /* Overridden from HtmlElement */
197   public Datalist oncancel(String value) {
198      super.oncancel(value);
199      return this;
200   }
201
202   @Override /* Overridden from HtmlElement */
203   public Datalist oncanplay(String value) {
204      super.oncanplay(value);
205      return this;
206   }
207
208   @Override /* Overridden from HtmlElement */
209   public Datalist oncanplaythrough(String value) {
210      super.oncanplaythrough(value);
211      return this;
212   }
213
214   @Override /* Overridden from HtmlElement */
215   public Datalist onchange(String value) {
216      super.onchange(value);
217      return this;
218   }
219
220   @Override /* Overridden from HtmlElement */
221   public Datalist onclick(String value) {
222      super.onclick(value);
223      return this;
224   }
225
226   @Override /* Overridden from HtmlElement */
227   public Datalist oncuechange(String value) {
228      super.oncuechange(value);
229      return this;
230   }
231
232   @Override /* Overridden from HtmlElement */
233   public Datalist ondblclick(String value) {
234      super.ondblclick(value);
235      return this;
236   }
237
238   @Override /* Overridden from HtmlElement */
239   public Datalist ondurationchange(String value) {
240      super.ondurationchange(value);
241      return this;
242   }
243
244   @Override /* Overridden from HtmlElement */
245   public Datalist onemptied(String value) {
246      super.onemptied(value);
247      return this;
248   }
249
250   @Override /* Overridden from HtmlElement */
251   public Datalist onended(String value) {
252      super.onended(value);
253      return this;
254   }
255
256   @Override /* Overridden from HtmlElement */
257   public Datalist onerror(String value) {
258      super.onerror(value);
259      return this;
260   }
261
262   @Override /* Overridden from HtmlElement */
263   public Datalist onfocus(String value) {
264      super.onfocus(value);
265      return this;
266   }
267
268   @Override /* Overridden from HtmlElement */
269   public Datalist oninput(String value) {
270      super.oninput(value);
271      return this;
272   }
273
274   @Override /* Overridden from HtmlElement */
275   public Datalist oninvalid(String value) {
276      super.oninvalid(value);
277      return this;
278   }
279
280   @Override /* Overridden from HtmlElement */
281   public Datalist onkeydown(String value) {
282      super.onkeydown(value);
283      return this;
284   }
285
286   @Override /* Overridden from HtmlElement */
287   public Datalist onkeypress(String value) {
288      super.onkeypress(value);
289      return this;
290   }
291
292   @Override /* Overridden from HtmlElement */
293   public Datalist onkeyup(String value) {
294      super.onkeyup(value);
295      return this;
296   }
297
298   @Override /* Overridden from HtmlElement */
299   public Datalist onload(String value) {
300      super.onload(value);
301      return this;
302   }
303
304   @Override /* Overridden from HtmlElement */
305   public Datalist onloadeddata(String value) {
306      super.onloadeddata(value);
307      return this;
308   }
309
310   @Override /* Overridden from HtmlElement */
311   public Datalist onloadedmetadata(String value) {
312      super.onloadedmetadata(value);
313      return this;
314   }
315
316   @Override /* Overridden from HtmlElement */
317   public Datalist onloadstart(String value) {
318      super.onloadstart(value);
319      return this;
320   }
321
322   @Override /* Overridden from HtmlElement */
323   public Datalist onmousedown(String value) {
324      super.onmousedown(value);
325      return this;
326   }
327
328   @Override /* Overridden from HtmlElement */
329   public Datalist onmouseenter(String value) {
330      super.onmouseenter(value);
331      return this;
332   }
333
334   @Override /* Overridden from HtmlElement */
335   public Datalist onmouseleave(String value) {
336      super.onmouseleave(value);
337      return this;
338   }
339
340   @Override /* Overridden from HtmlElement */
341   public Datalist onmousemove(String value) {
342      super.onmousemove(value);
343      return this;
344   }
345
346   @Override /* Overridden from HtmlElement */
347   public Datalist onmouseout(String value) {
348      super.onmouseout(value);
349      return this;
350   }
351
352   @Override /* Overridden from HtmlElement */
353   public Datalist onmouseover(String value) {
354      super.onmouseover(value);
355      return this;
356   }
357
358   @Override /* Overridden from HtmlElement */
359   public Datalist onmouseup(String value) {
360      super.onmouseup(value);
361      return this;
362   }
363
364   @Override /* Overridden from HtmlElement */
365   public Datalist onmousewheel(String value) {
366      super.onmousewheel(value);
367      return this;
368   }
369
370   @Override /* Overridden from HtmlElement */
371   public Datalist onpause(String value) {
372      super.onpause(value);
373      return this;
374   }
375
376   @Override /* Overridden from HtmlElement */
377   public Datalist onplay(String value) {
378      super.onplay(value);
379      return this;
380   }
381
382   @Override /* Overridden from HtmlElement */
383   public Datalist onplaying(String value) {
384      super.onplaying(value);
385      return this;
386   }
387
388   @Override /* Overridden from HtmlElement */
389   public Datalist onprogress(String value) {
390      super.onprogress(value);
391      return this;
392   }
393
394   @Override /* Overridden from HtmlElement */
395   public Datalist onratechange(String value) {
396      super.onratechange(value);
397      return this;
398   }
399
400   @Override /* Overridden from HtmlElement */
401   public Datalist onreset(String value) {
402      super.onreset(value);
403      return this;
404   }
405
406   @Override /* Overridden from HtmlElement */
407   public Datalist onresize(String value) {
408      super.onresize(value);
409      return this;
410   }
411
412   @Override /* Overridden from HtmlElement */
413   public Datalist onscroll(String value) {
414      super.onscroll(value);
415      return this;
416   }
417
418   @Override /* Overridden from HtmlElement */
419   public Datalist onseeked(String value) {
420      super.onseeked(value);
421      return this;
422   }
423
424   @Override /* Overridden from HtmlElement */
425   public Datalist onseeking(String value) {
426      super.onseeking(value);
427      return this;
428   }
429
430   @Override /* Overridden from HtmlElement */
431   public Datalist onselect(String value) {
432      super.onselect(value);
433      return this;
434   }
435
436   @Override /* Overridden from HtmlElement */
437   public Datalist onshow(String value) {
438      super.onshow(value);
439      return this;
440   }
441
442   @Override /* Overridden from HtmlElement */
443   public Datalist onstalled(String value) {
444      super.onstalled(value);
445      return this;
446   }
447
448   @Override /* Overridden from HtmlElement */
449   public Datalist onsubmit(String value) {
450      super.onsubmit(value);
451      return this;
452   }
453
454   @Override /* Overridden from HtmlElement */
455   public Datalist onsuspend(String value) {
456      super.onsuspend(value);
457      return this;
458   }
459
460   @Override /* Overridden from HtmlElement */
461   public Datalist ontimeupdate(String value) {
462      super.ontimeupdate(value);
463      return this;
464   }
465
466   @Override /* Overridden from HtmlElement */
467   public Datalist ontoggle(String value) {
468      super.ontoggle(value);
469      return this;
470   }
471
472   @Override /* Overridden from HtmlElement */
473   public Datalist onvolumechange(String value) {
474      super.onvolumechange(value);
475      return this;
476   }
477
478   @Override /* Overridden from HtmlElement */
479   public Datalist onwaiting(String value) {
480      super.onwaiting(value);
481      return this;
482   }
483
484   @Override /* Overridden from HtmlElementContainer */
485   public Datalist setChildren(List<Object> children) {
486      super.setChildren(children);
487      return this;
488   }
489
490   @Override /* Overridden from HtmlElement */
491   public Datalist spellcheck(Object value) {
492      super.spellcheck(value);
493      return this;
494   }
495
496   @Override /* Overridden from HtmlElement */
497   public Datalist style(String value) {
498      super.style(value);
499      return this;
500   }
501
502   @Override /* Overridden from HtmlElement */
503   public Datalist tabindex(Object value) {
504      super.tabindex(value);
505      return this;
506   }
507
508   @Override /* Overridden from HtmlElement */
509   public Datalist title(String value) {
510      super.title(value);
511      return this;
512   }
513
514   @Override /* Overridden from HtmlElement */
515   public Datalist translate(Object value) {
516      super.translate(value);
517      return this;
518   }
519}