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