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