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