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-article-element">&lt;article&gt;</a>
023 * element.
024 *
025 * <p>
026 * The article element represents a self-contained composition in a document, page, application, or site,
027 * which is intended to be independently distributable or reusable. It is used for content that could
028 * stand alone, such as blog posts, news articles, forum posts, or other independent pieces of content.
029 * Each article should have its own heading structure and can contain other semantic elements.
030 *
031 * <h5 class='section'>Examples:</h5>
032 * <p class='bcode w800'>
033 *    <jk>import static</jk> org.apache.juneau.bean.html5.HtmlBuilder.*;
034 *
035 *    <jc>// Simple blog post article</jc>
036 *    Article <jv>blogPost</jv> = <jsm>article</jsm>(
037 *       <jsm>header</jsm>(
038 *          <jsm>h1</jsm>(<js>"How to Use HTML5 Semantic Elements"</js>),
039 *          <jsm>p</jsm>(<js>"Published on "</js>, <jsm>time</jsm>(<js>"2024-01-15"</js>, <js>"January 15, 2024"</js>))
040 *       ),
041 *       <jsm>p</jsm>(<js>"HTML5 introduced several semantic elements that help structure content..."</js>),
042 *       <jsm>footer</jsm>(
043 *          <jsm>p</jsm>(<js>"Author: John Doe"</js>),
044 *          <jsm>address</jsm>(<js>"Contact: john@example.com"</js>)
045 *       )
046 *    );
047 *
048 *    <jc>// News article</jc>
049 *    Article <jv>newsArticle</jv> = <jsm>article</jsm>(
050 *       <jsm>header</jsm>(
051 *          <jsm>h1</jsm>(<js>"Breaking: New Technology Released"</js>),
052 *          <jsm>p</jsm>(<js>"By Jane Smith, Technology Reporter"</js>)
053 *       ),
054 *       <jsm>p</jsm>(<js>"A revolutionary new technology was announced today..."</js>),
055 *       <jsm>section</jsm>(
056 *          <jsm>h2</jsm>(<js>"Technical Details"</js>),
057 *          <jsm>p</jsm>(<js>"The technology works by..."</js>)
058 *       )
059 *    );
060 *
061 *    <jc>// Forum post</jc>
062 *    Article <jv>forumPost</jv> = <jsm>article</jsm>(
063 *       <jsm>header</jsm>(
064 *          <jsm>h3</jsm>(<js>"Question about CSS Grid"</js>),
065 *          <jsm>p</jsm>(<js>"Posted by "</js>, <jsm>strong</jsm>(<js>"user123"</js>), <js>" on "</js>, <jsm>time</jsm>(<js>"2024-01-14"</js>, <js>"yesterday"</js>))
066 *       ),
067 *       <jsm>p</jsm>(<js>"I'm having trouble with CSS Grid layout..."</js>),
068 *       <jsm>footer</jsm>(
069 *          <jsm>p</jsm>(<js>"Tags: "</js>, <jsm>a</jsm>(<js>"/tag/css"</js>, <js>"CSS"</js>), <js>", "</js>, <jsm>a</jsm>(<js>"/tag/grid"</js>, <js>"Grid"</js>))
070 *       )
071 *    )._class(<js>"forum-post"</js>);
072 *
073 *    <jc>// Product review</jc>
074 *    Article <jv>review</jv> = <jsm>article</jsm>(
075 *       <jsm>header</jsm>(
076 *          <jsm>h1</jsm>(<js>"Review: Amazing Widget Pro"</js>),
077 *          <jsm>p</jsm>(<js>"Rating: "</js>, <jsm>strong</jsm>(<js>"5/5 stars"</js>))
078 *       ),
079 *       <jsm>p</jsm>(<js>"After using the Amazing Widget Pro for a month..."</js>),
080 *       <jsm>section</jsm>(
081 *          <jsm>h2</jsm>(<js>"Pros"</js>),
082 *          <jsm>ul</jsm>(
083 *             <jsm>li</jsm>(<js>"Easy to use"</js>),
084 *             <jsm>li</jsm>(<js>"Great performance"</js>),
085 *             <jsm>li</jsm>(<js>"Excellent support"</js>)
086 *          )
087 *       )
088 *    );
089 *
090 *    <jc>// Article with multiple sections</jc>
091 *    Article <jv>multiSection</jv> = <jsm>article</jsm>(
092 *       <jsm>header</jsm>(<jsm>h1</jsm>(<js>"Complete Guide to Web Development"</js>)),
093 *       <jsm>section</jsm>(
094 *          <jsm>h2</jsm>(<js>"Introduction"</js>),
095 *          <jsm>p</jsm>(<js>"Web development encompasses many technologies..."</js>)
096 *       ),
097 *       <jsm>section</jsm>(
098 *          <jsm>h2</jsm>(<js>"Frontend Development"</js>),
099 *          <jsm>p</jsm>(<js>"Frontend development focuses on..."</js>)
100 *       ),
101 *       <jsm>section</jsm>(
102 *          <jsm>h2</jsm>(<js>"Backend Development"</js>),
103 *          <jsm>p</jsm>(<js>"Backend development handles..."</js>)
104 *       )
105 *    );
106 * </p>
107 *
108 * <p>
109 * The following convenience methods are provided for constructing instances of this bean:
110 * <ul class='javatree'>
111 *    <li class='jc'>{@link HtmlBuilder}
112 *    <ul class='javatree'>
113 *       <li class='jm'>{@link HtmlBuilder#article() article()}
114 *       <li class='jm'>{@link HtmlBuilder#article(Object...) article(Object...)}
115 *    </ul>
116 * </ul>
117 * </p>
118 *
119 * <h5 class='section'>See Also:</h5><ul>
120 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauBeanHtml5">juneau-bean-html5</a>
121 * </ul>
122 */
123@Bean(typeName = "article")
124public class Article extends HtmlElementMixed {
125
126   /**
127    * Creates an empty {@link Article} element.
128    */
129   public Article() {}
130
131   /**
132    * Creates an {@link Article} element with the specified child nodes.
133    *
134    * @param children The child nodes.
135    */
136   public Article(Object...children) {
137      children(children);
138   }
139
140   @Override /* Overridden from HtmlElement */
141   public Article _class(String value) { // NOSONAR - Intentional naming.
142      super._class(value);
143      return this;
144   }
145
146   @Override /* Overridden from HtmlElement */
147   public Article accesskey(String value) {
148      super.accesskey(value);
149      return this;
150   }
151
152   @Override /* Overridden from HtmlElement */
153   public Article attr(String key, Object val) {
154      super.attr(key, val);
155      return this;
156   }
157
158   @Override /* Overridden from HtmlElement */
159   public Article attrUri(String key, Object val) {
160      super.attrUri(key, val);
161      return this;
162   }
163
164   @Override /* Overridden from HtmlElementMixed */
165   public Article child(Object value) {
166      super.child(value);
167      return this;
168   }
169
170   @Override /* Overridden from HtmlElementMixed */
171   public Article children(Object...value) {
172      super.children(value);
173      return this;
174   }
175
176   @Override /* Overridden from HtmlElement */
177   public Article contenteditable(Object value) {
178      super.contenteditable(value);
179      return this;
180   }
181
182   @Override /* Overridden from HtmlElement */
183   public Article dir(String value) {
184      super.dir(value);
185      return this;
186   }
187
188   /**
189    * Adds a footer node to this element.
190    *
191    * @param children The children inside the footer node.
192    * @return This object.
193    */
194   public Article footer(Object...children) {
195      super.child(HtmlBuilder.footer(children));
196      return this;
197   }
198
199   /**
200    * Adds a header node to this element.
201    *
202    * @param children The children inside the header node.
203    * @return This object.
204    */
205   public Article header(Object...children) {
206      super.child(HtmlBuilder.header(children));
207      return this;
208   }
209
210   @Override /* Overridden from HtmlElement */
211   public Article hidden(Object value) {
212      super.hidden(value);
213      return this;
214   }
215
216   @Override /* Overridden from HtmlElement */
217   public Article id(String value) {
218      super.id(value);
219      return this;
220   }
221
222   @Override /* Overridden from HtmlElement */
223   public Article lang(String value) {
224      super.lang(value);
225      return this;
226   }
227
228   /**
229    * Adds a link node to this element.
230    *
231    * @param value The link node to add to this article.
232    * @return This object.
233    */
234   public Article link(Link value) {
235      super.child(value);
236      return this;
237   }
238
239   @Override /* Overridden from HtmlElement */
240   public Article onabort(String value) {
241      super.onabort(value);
242      return this;
243   }
244
245   @Override /* Overridden from HtmlElement */
246   public Article onblur(String value) {
247      super.onblur(value);
248      return this;
249   }
250
251   @Override /* Overridden from HtmlElement */
252   public Article oncancel(String value) {
253      super.oncancel(value);
254      return this;
255   }
256
257   @Override /* Overridden from HtmlElement */
258   public Article oncanplay(String value) {
259      super.oncanplay(value);
260      return this;
261   }
262
263   @Override /* Overridden from HtmlElement */
264   public Article oncanplaythrough(String value) {
265      super.oncanplaythrough(value);
266      return this;
267   }
268
269   @Override /* Overridden from HtmlElement */
270   public Article onchange(String value) {
271      super.onchange(value);
272      return this;
273   }
274
275   @Override /* Overridden from HtmlElement */
276   public Article onclick(String value) {
277      super.onclick(value);
278      return this;
279   }
280
281   @Override /* Overridden from HtmlElement */
282   public Article oncuechange(String value) {
283      super.oncuechange(value);
284      return this;
285   }
286
287   @Override /* Overridden from HtmlElement */
288   public Article ondblclick(String value) {
289      super.ondblclick(value);
290      return this;
291   }
292
293   @Override /* Overridden from HtmlElement */
294   public Article ondurationchange(String value) {
295      super.ondurationchange(value);
296      return this;
297   }
298
299   @Override /* Overridden from HtmlElement */
300   public Article onemptied(String value) {
301      super.onemptied(value);
302      return this;
303   }
304
305   @Override /* Overridden from HtmlElement */
306   public Article onended(String value) {
307      super.onended(value);
308      return this;
309   }
310
311   @Override /* Overridden from HtmlElement */
312   public Article onerror(String value) {
313      super.onerror(value);
314      return this;
315   }
316
317   @Override /* Overridden from HtmlElement */
318   public Article onfocus(String value) {
319      super.onfocus(value);
320      return this;
321   }
322
323   @Override /* Overridden from HtmlElement */
324   public Article oninput(String value) {
325      super.oninput(value);
326      return this;
327   }
328
329   @Override /* Overridden from HtmlElement */
330   public Article oninvalid(String value) {
331      super.oninvalid(value);
332      return this;
333   }
334
335   @Override /* Overridden from HtmlElement */
336   public Article onkeydown(String value) {
337      super.onkeydown(value);
338      return this;
339   }
340
341   @Override /* Overridden from HtmlElement */
342   public Article onkeypress(String value) {
343      super.onkeypress(value);
344      return this;
345   }
346
347   @Override /* Overridden from HtmlElement */
348   public Article onkeyup(String value) {
349      super.onkeyup(value);
350      return this;
351   }
352
353   @Override /* Overridden from HtmlElement */
354   public Article onload(String value) {
355      super.onload(value);
356      return this;
357   }
358
359   @Override /* Overridden from HtmlElement */
360   public Article onloadeddata(String value) {
361      super.onloadeddata(value);
362      return this;
363   }
364
365   @Override /* Overridden from HtmlElement */
366   public Article onloadedmetadata(String value) {
367      super.onloadedmetadata(value);
368      return this;
369   }
370
371   @Override /* Overridden from HtmlElement */
372   public Article onloadstart(String value) {
373      super.onloadstart(value);
374      return this;
375   }
376
377   @Override /* Overridden from HtmlElement */
378   public Article onmousedown(String value) {
379      super.onmousedown(value);
380      return this;
381   }
382
383   @Override /* Overridden from HtmlElement */
384   public Article onmouseenter(String value) {
385      super.onmouseenter(value);
386      return this;
387   }
388
389   @Override /* Overridden from HtmlElement */
390   public Article onmouseleave(String value) {
391      super.onmouseleave(value);
392      return this;
393   }
394
395   @Override /* Overridden from HtmlElement */
396   public Article onmousemove(String value) {
397      super.onmousemove(value);
398      return this;
399   }
400
401   @Override /* Overridden from HtmlElement */
402   public Article onmouseout(String value) {
403      super.onmouseout(value);
404      return this;
405   }
406
407   @Override /* Overridden from HtmlElement */
408   public Article onmouseover(String value) {
409      super.onmouseover(value);
410      return this;
411   }
412
413   @Override /* Overridden from HtmlElement */
414   public Article onmouseup(String value) {
415      super.onmouseup(value);
416      return this;
417   }
418
419   @Override /* Overridden from HtmlElement */
420   public Article onmousewheel(String value) {
421      super.onmousewheel(value);
422      return this;
423   }
424
425   @Override /* Overridden from HtmlElement */
426   public Article onpause(String value) {
427      super.onpause(value);
428      return this;
429   }
430
431   @Override /* Overridden from HtmlElement */
432   public Article onplay(String value) {
433      super.onplay(value);
434      return this;
435   }
436
437   @Override /* Overridden from HtmlElement */
438   public Article onplaying(String value) {
439      super.onplaying(value);
440      return this;
441   }
442
443   @Override /* Overridden from HtmlElement */
444   public Article onprogress(String value) {
445      super.onprogress(value);
446      return this;
447   }
448
449   @Override /* Overridden from HtmlElement */
450   public Article onratechange(String value) {
451      super.onratechange(value);
452      return this;
453   }
454
455   @Override /* Overridden from HtmlElement */
456   public Article onreset(String value) {
457      super.onreset(value);
458      return this;
459   }
460
461   @Override /* Overridden from HtmlElement */
462   public Article onresize(String value) {
463      super.onresize(value);
464      return this;
465   }
466
467   @Override /* Overridden from HtmlElement */
468   public Article onscroll(String value) {
469      super.onscroll(value);
470      return this;
471   }
472
473   @Override /* Overridden from HtmlElement */
474   public Article onseeked(String value) {
475      super.onseeked(value);
476      return this;
477   }
478
479   @Override /* Overridden from HtmlElement */
480   public Article onseeking(String value) {
481      super.onseeking(value);
482      return this;
483   }
484
485   @Override /* Overridden from HtmlElement */
486   public Article onselect(String value) {
487      super.onselect(value);
488      return this;
489   }
490
491   @Override /* Overridden from HtmlElement */
492   public Article onshow(String value) {
493      super.onshow(value);
494      return this;
495   }
496
497   @Override /* Overridden from HtmlElement */
498   public Article onstalled(String value) {
499      super.onstalled(value);
500      return this;
501   }
502
503   @Override /* Overridden from HtmlElement */
504   public Article onsubmit(String value) {
505      super.onsubmit(value);
506      return this;
507   }
508
509   @Override /* Overridden from HtmlElement */
510   public Article onsuspend(String value) {
511      super.onsuspend(value);
512      return this;
513   }
514
515   @Override /* Overridden from HtmlElement */
516   public Article ontimeupdate(String value) {
517      super.ontimeupdate(value);
518      return this;
519   }
520
521   @Override /* Overridden from HtmlElement */
522   public Article ontoggle(String value) {
523      super.ontoggle(value);
524      return this;
525   }
526
527   @Override /* Overridden from HtmlElement */
528   public Article onvolumechange(String value) {
529      super.onvolumechange(value);
530      return this;
531   }
532
533   @Override /* Overridden from HtmlElement */
534   public Article onwaiting(String value) {
535      super.onwaiting(value);
536      return this;
537   }
538
539   /**
540    * Adds a section node to this element.
541    *
542    * @param value The section node to add to this article.
543    * @return This object.
544    */
545   public Article section(Section value) {
546      super.child(value);
547      return this;
548   }
549
550   @Override /* Overridden from HtmlElement */
551   public Article spellcheck(Object value) {
552      super.spellcheck(value);
553      return this;
554   }
555
556   @Override /* Overridden from HtmlElement */
557   public Article style(String value) {
558      super.style(value);
559      return this;
560   }
561
562   @Override /* Overridden from HtmlElement */
563   public Article tabindex(Object value) {
564      super.tabindex(value);
565      return this;
566   }
567
568   @Override /* Overridden from HtmlElement */
569   public Article title(String value) {
570      super.title(value);
571      return this;
572   }
573
574   @Override /* Overridden from HtmlElement */
575   public Article translate(Object value) {
576      super.translate(value);
577      return this;
578   }
579}