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