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