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