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