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