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