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