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/grouping-content.html#the-figure-element">&lt;figure&gt;</a>
024 * element.
025 *
026 * <p>
027 * The figure element represents self-contained content, potentially with a caption, that is
028 * typically referenced as a single unit from the main flow of the document. It is used to
029 * group related content such as images, diagrams, code snippets, or other media that can
030 * be moved away from the main flow of the document without affecting the document's meaning.
031 * The figure element can contain a figcaption element to provide a caption for the content.
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 figure with image</jc>
038 *    Figure <jv>simple</jv> = <jsm>figure</jsm>(
039 *       <jsm>img</jsm>(<js>"/images/sunset.jpg"</js>, <js>"Sunset"</js>),
040 *       <jsm>figcaption</jsm>(<js>"A beautiful sunset over the mountains."</js>)
041 *    );
042 * 
043 *    <jc>// Figure with code snippet</jc>
044 *    Figure <jv>codeFigure</jv> = <jsm>figure</jsm>(
045 *       <jsm>pre</jsm>(<jsm>code</jsm>(<js>"function hello() {\n  return 'Hello World';\n}"</js>)),
046 *       <jsm>figcaption</jsm>(<js>"A simple JavaScript function."</js>)
047 *    );
048 * 
049 *    <jc>// Figure with styling</jc>
050 *    Figure <jv>styled</jv> = <jsm>figure</jsm>(
051 *       <jsm>img</jsm>(<js>"/charts/sales.png"</js>, <js>"Sales Chart"</js>),
052 *       <jsm>figcaption</jsm>(<js>"Monthly sales data for 2024."</js>)
053 *    )._class(<js>"chart-figure"</js>);
054 * 
055 *    <jc>// Figure with multiple elements</jc>
056 *    Figure <jv>complex</jv> = <jsm>figure</jsm>(
057 *       <jsm>img</jsm>(<js>"/images/diagram.png"</js>, <js>"Process Diagram"</js>),
058 *       <jsm>p</jsm>(<js>"This diagram shows the complete workflow."</js>),
059 *       <jsm>figcaption</jsm>(<js>"Figure 1: System Architecture Overview."</js>)
060 *    );
061 * 
062 *    <jc>// Figure with ID</jc>
063 *    Figure <jv>withId</jv> = <jsm>figure</jsm>(
064 *       <jsm>img</jsm>(<js>"/charts/main.png"</js>, <js>"Main Chart"</js>),
065 *       <jsm>figcaption</jsm>(<js>"Primary performance metrics."</js>)
066 *    ).id(<js>"main-chart"</js>);
067 * 
068 *    <jc>// Figure with styling</jc>
069 *    Figure <jv>styled2</jv> = <jsm>figure</jsm>(
070 *       <jsm>img</jsm>(<js>"/images/example.png"</js>, <js>"Example"</js>),
071 *       <jsm>figcaption</jsm>(<js>"An example of the new feature."</js>)
072 *    ).style(<js>"border: 1px solid #ccc; padding: 10px; margin: 20px 0;"</js>);
073 * 
074 *    <jc>// Figure with table</jc>
075 *    Figure <jv>tableFigure</jv> = <jsm>figure</jsm>(
076 *       <jsm>table</jsm>(
077 *          <jsm>tr</jsm>(
078 *             <jsm>th</jsm>(<js>"Name"</js>),
079 *             <jsm>th</jsm>(<js>"Value"</js>)
080 *          ),
081 *          <jsm>tr</jsm>(
082 *             <jsm>td</jsm>(<js>"Item 1"</js>),
083 *             <jsm>td</jsm>(<js>"100"</js>)
084 *          )
085 *       ),
086 *       <jsm>figcaption</jsm>(<js>"Data summary table."</js>)
087 *    );
088 * </p>
089 *
090 * <p>
091 * The following convenience methods are provided for constructing instances of this bean:
092 * <ul class='javatree'>
093 *    <li class='jc'>{@link HtmlBuilder}
094 *    <ul class='javatree'>
095 *       <li class='jm'>{@link HtmlBuilder#figure() figure()}
096 *       <li class='jm'>{@link HtmlBuilder#figure(Object, Object...) figure(Object, Object...)}
097 *    </ul>
098 * </ul>
099 * </p>
100 *
101 * <h5 class='section'>See Also:</h5><ul>
102 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauBeanHtml5">juneau-bean-html5</a>
103 * </ul>
104 */
105@Bean(typeName="figure")
106public class Figure extends HtmlElementContainer {
107
108   /**
109    * Creates an empty {@link Figure} element.
110    */
111   public Figure() {}
112
113   /**
114    * Creates a {@link Figure} element with the specified child nodes.
115    *
116    * @param children The child nodes.
117    */
118   public Figure(Object...children) {
119      children(children);
120   }
121
122   //-----------------------------------------------------------------------------------------------------------------
123   // Overridden methods
124   //-----------------------------------------------------------------------------------------------------------------
125   @Override /* Overridden from HtmlElement */
126   public Figure _class(String value) {  // NOSONAR - Intentional naming.
127      super._class(value);
128      return this;
129   }
130
131   @Override /* Overridden from HtmlElement */
132   public Figure accesskey(String value) {
133      super.accesskey(value);
134      return this;
135   }
136
137   @Override /* Overridden from HtmlElement */
138   public Figure contenteditable(Object value) {
139      super.contenteditable(value);
140      return this;
141   }
142
143   @Override /* Overridden from HtmlElement */
144   public Figure dir(String value) {
145      super.dir(value);
146      return this;
147   }
148
149   @Override /* Overridden from HtmlElement */
150   public Figure hidden(Object value) {
151      super.hidden(value);
152      return this;
153   }
154
155   @Override /* Overridden from HtmlElement */
156   public Figure id(String value) {
157      super.id(value);
158      return this;
159   }
160
161   @Override /* Overridden from HtmlElement */
162   public Figure lang(String value) {
163      super.lang(value);
164      return this;
165   }
166
167   @Override /* Overridden from HtmlElement */
168   public Figure onabort(String value) {
169      super.onabort(value);
170      return this;
171   }
172
173   @Override /* Overridden from HtmlElement */
174   public Figure onblur(String value) {
175      super.onblur(value);
176      return this;
177   }
178
179   @Override /* Overridden from HtmlElement */
180   public Figure oncancel(String value) {
181      super.oncancel(value);
182      return this;
183   }
184
185   @Override /* Overridden from HtmlElement */
186   public Figure oncanplay(String value) {
187      super.oncanplay(value);
188      return this;
189   }
190
191   @Override /* Overridden from HtmlElement */
192   public Figure oncanplaythrough(String value) {
193      super.oncanplaythrough(value);
194      return this;
195   }
196
197   @Override /* Overridden from HtmlElement */
198   public Figure onchange(String value) {
199      super.onchange(value);
200      return this;
201   }
202
203   @Override /* Overridden from HtmlElement */
204   public Figure onclick(String value) {
205      super.onclick(value);
206      return this;
207   }
208
209   @Override /* Overridden from HtmlElement */
210   public Figure oncuechange(String value) {
211      super.oncuechange(value);
212      return this;
213   }
214
215   @Override /* Overridden from HtmlElement */
216   public Figure ondblclick(String value) {
217      super.ondblclick(value);
218      return this;
219   }
220
221   @Override /* Overridden from HtmlElement */
222   public Figure ondurationchange(String value) {
223      super.ondurationchange(value);
224      return this;
225   }
226
227   @Override /* Overridden from HtmlElement */
228   public Figure onemptied(String value) {
229      super.onemptied(value);
230      return this;
231   }
232
233   @Override /* Overridden from HtmlElement */
234   public Figure onended(String value) {
235      super.onended(value);
236      return this;
237   }
238
239   @Override /* Overridden from HtmlElement */
240   public Figure onerror(String value) {
241      super.onerror(value);
242      return this;
243   }
244
245   @Override /* Overridden from HtmlElement */
246   public Figure onfocus(String value) {
247      super.onfocus(value);
248      return this;
249   }
250
251   @Override /* Overridden from HtmlElement */
252   public Figure oninput(String value) {
253      super.oninput(value);
254      return this;
255   }
256
257   @Override /* Overridden from HtmlElement */
258   public Figure oninvalid(String value) {
259      super.oninvalid(value);
260      return this;
261   }
262
263   @Override /* Overridden from HtmlElement */
264   public Figure onkeydown(String value) {
265      super.onkeydown(value);
266      return this;
267   }
268
269   @Override /* Overridden from HtmlElement */
270   public Figure onkeypress(String value) {
271      super.onkeypress(value);
272      return this;
273   }
274
275   @Override /* Overridden from HtmlElement */
276   public Figure onkeyup(String value) {
277      super.onkeyup(value);
278      return this;
279   }
280
281   @Override /* Overridden from HtmlElement */
282   public Figure onload(String value) {
283      super.onload(value);
284      return this;
285   }
286
287   @Override /* Overridden from HtmlElement */
288   public Figure onloadeddata(String value) {
289      super.onloadeddata(value);
290      return this;
291   }
292
293   @Override /* Overridden from HtmlElement */
294   public Figure onloadedmetadata(String value) {
295      super.onloadedmetadata(value);
296      return this;
297   }
298
299   @Override /* Overridden from HtmlElement */
300   public Figure onloadstart(String value) {
301      super.onloadstart(value);
302      return this;
303   }
304
305   @Override /* Overridden from HtmlElement */
306   public Figure onmousedown(String value) {
307      super.onmousedown(value);
308      return this;
309   }
310
311   @Override /* Overridden from HtmlElement */
312   public Figure onmouseenter(String value) {
313      super.onmouseenter(value);
314      return this;
315   }
316
317   @Override /* Overridden from HtmlElement */
318   public Figure onmouseleave(String value) {
319      super.onmouseleave(value);
320      return this;
321   }
322
323   @Override /* Overridden from HtmlElement */
324   public Figure onmousemove(String value) {
325      super.onmousemove(value);
326      return this;
327   }
328
329   @Override /* Overridden from HtmlElement */
330   public Figure onmouseout(String value) {
331      super.onmouseout(value);
332      return this;
333   }
334
335   @Override /* Overridden from HtmlElement */
336   public Figure onmouseover(String value) {
337      super.onmouseover(value);
338      return this;
339   }
340
341   @Override /* Overridden from HtmlElement */
342   public Figure onmouseup(String value) {
343      super.onmouseup(value);
344      return this;
345   }
346
347   @Override /* Overridden from HtmlElement */
348   public Figure onmousewheel(String value) {
349      super.onmousewheel(value);
350      return this;
351   }
352
353   @Override /* Overridden from HtmlElement */
354   public Figure onpause(String value) {
355      super.onpause(value);
356      return this;
357   }
358
359   @Override /* Overridden from HtmlElement */
360   public Figure onplay(String value) {
361      super.onplay(value);
362      return this;
363   }
364
365   @Override /* Overridden from HtmlElement */
366   public Figure onplaying(String value) {
367      super.onplaying(value);
368      return this;
369   }
370
371   @Override /* Overridden from HtmlElement */
372   public Figure onprogress(String value) {
373      super.onprogress(value);
374      return this;
375   }
376
377   @Override /* Overridden from HtmlElement */
378   public Figure onratechange(String value) {
379      super.onratechange(value);
380      return this;
381   }
382
383   @Override /* Overridden from HtmlElement */
384   public Figure onreset(String value) {
385      super.onreset(value);
386      return this;
387   }
388
389   @Override /* Overridden from HtmlElement */
390   public Figure onresize(String value) {
391      super.onresize(value);
392      return this;
393   }
394
395   @Override /* Overridden from HtmlElement */
396   public Figure onscroll(String value) {
397      super.onscroll(value);
398      return this;
399   }
400
401   @Override /* Overridden from HtmlElement */
402   public Figure onseeked(String value) {
403      super.onseeked(value);
404      return this;
405   }
406
407   @Override /* Overridden from HtmlElement */
408   public Figure onseeking(String value) {
409      super.onseeking(value);
410      return this;
411   }
412
413   @Override /* Overridden from HtmlElement */
414   public Figure onselect(String value) {
415      super.onselect(value);
416      return this;
417   }
418
419   @Override /* Overridden from HtmlElement */
420   public Figure onshow(String value) {
421      super.onshow(value);
422      return this;
423   }
424
425   @Override /* Overridden from HtmlElement */
426   public Figure onstalled(String value) {
427      super.onstalled(value);
428      return this;
429   }
430
431   @Override /* Overridden from HtmlElement */
432   public Figure onsubmit(String value) {
433      super.onsubmit(value);
434      return this;
435   }
436
437   @Override /* Overridden from HtmlElement */
438   public Figure onsuspend(String value) {
439      super.onsuspend(value);
440      return this;
441   }
442
443   @Override /* Overridden from HtmlElement */
444   public Figure ontimeupdate(String value) {
445      super.ontimeupdate(value);
446      return this;
447   }
448
449   @Override /* Overridden from HtmlElement */
450   public Figure ontoggle(String value) {
451      super.ontoggle(value);
452      return this;
453   }
454
455   @Override /* Overridden from HtmlElement */
456   public Figure onvolumechange(String value) {
457      super.onvolumechange(value);
458      return this;
459   }
460
461   @Override /* Overridden from HtmlElement */
462   public Figure onwaiting(String value) {
463      super.onwaiting(value);
464      return this;
465   }
466
467   @Override /* Overridden from HtmlElement */
468   public Figure spellcheck(Object value) {
469      super.spellcheck(value);
470      return this;
471   }
472
473   @Override /* Overridden from HtmlElement */
474   public Figure style(String value) {
475      super.style(value);
476      return this;
477   }
478
479   @Override /* Overridden from HtmlElement */
480   public Figure tabindex(Object value) {
481      super.tabindex(value);
482      return this;
483   }
484
485   @Override /* Overridden from HtmlElement */
486   public Figure title(String value) {
487      super.title(value);
488      return this;
489   }
490
491   @Override /* Overridden from HtmlElement */
492   public Figure translate(Object value) {
493      super.translate(value);
494      return this;
495   }
496
497   @Override /* Overridden from HtmlElementContainer */
498   public Figure child(Object value) {
499      super.child(value);
500      return this;
501   }
502
503   @Override /* Overridden from HtmlElementContainer */
504   public Figure children(Object...value) {
505      super.children(value);
506      return this;
507   }
508}