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