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/tabular-data.html#the-caption-element">&lt;caption&gt;</a>
023 * element.
024 *
025 * <p>
026 * The caption element represents the title of a table. It is used to provide a brief description or
027 * title for the table content, making it easier for users to understand what the table contains.
028 * The caption element should be placed as the first child of a table element and is typically
029 * rendered above the table by default.
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 table caption</jc>
036 *    Caption <jv>simple</jv> = <jsm>caption</jsm>(<js>"Monthly Sales Report"</js>);
037 *
038 *    <jc>// Table caption with styling</jc>
039 *    Caption <jv>styled</jv> = <jsm>caption</jsm>(<js>"Employee Directory"</js>)
040 *       ._class(<js>"table-title"</js>);
041 *
042 *    <jc>// Table caption with complex content</jc>
043 *    Caption <jv>complex</jv> = <jsm>caption</jsm>(
044 *       <js>"Sales Data for "</js>,
045 *       <jsm>strong</jsm>(<js>"Q1 2024"</js>),
046 *       <js>" - "</js>,
047 *       <jsm>em</jsm>(<js>"Preliminary Results"</js>)
048 *    );
049 *
050 *    <jc>// Table caption with links</jc>
051 *    Caption <jv>withLinks</jv> = <jsm>caption</jsm>(
052 *       <js>"Product Inventory - "</js>,
053 *       <jsm>a</jsm>(<js>"/help/inventory"</js>, <js>"Help"</js>),
054 *       <js>" | "</js>,
055 *       <jsm>a</jsm>(<js>"/export/inventory"</js>, <js>"Export"</js>)
056 *    );
057 *
058 *    <jc>// Table caption with icons</jc>
059 *    Caption <jv>withIcons</jv> = <jsm>caption</jsm>(
060 *       <js>"📊 "</js>,
061 *       <js>"Financial Summary"</js>,
062 *       <js>" "</js>,
063 *       <jsm>span</jsm>()._class(<js>"icon"</js>).children(<js>"💰"</js>)
064 *    );
065 *
066 *    <jc>// Table caption with multiple lines</jc>
067 *    Caption <jv>multiLine</jv> = <jsm>caption</jsm>(
068 *       <js>"Customer Contact Information"</js>,
069 *       <jsm>br</jsm>(),
070 *       <js>"Last Updated: "</js>,
071 *       <jsm>time</jsm>(<js>"2024-01-15"</js>, <js>"January 15, 2024"</js>)
072 *    );
073 * </p>
074 *
075 * <p>
076 * The following convenience methods are provided for constructing instances of this bean:
077 * <ul class='javatree'>
078 *    <li class='jc'>{@link HtmlBuilder}
079 *    <ul class='javatree'>
080 *       <li class='jm'>{@link HtmlBuilder#caption() caption()}
081 *       <li class='jm'>{@link HtmlBuilder#caption(Object...) caption(Object...)}
082 *    </ul>
083 * </ul>
084 * </p>
085 *
086 * <h5 class='section'>See Also:</h5><ul>
087 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauBeanHtml5">juneau-bean-html5</a>
088 * </ul>
089 */
090@Bean(typeName = "caption")
091public class Caption extends HtmlElementMixed {
092
093   /**
094    * Creates an empty {@link Caption} element.
095    */
096   public Caption() {}
097
098   /**
099    * Creates a {@link Caption} element with the specified child nodes.
100    *
101    * @param children The child nodes.
102    */
103   public Caption(Object...children) {
104      children(children);
105   }
106
107   @Override /* Overridden from HtmlElement */
108   public Caption _class(String value) { // NOSONAR - Intentional naming.
109      super._class(value);
110      return this;
111   }
112
113   @Override /* Overridden from HtmlElement */
114   public Caption accesskey(String value) {
115      super.accesskey(value);
116      return this;
117   }
118
119   @Override /* Overridden from HtmlElement */
120   public Caption attr(String key, Object val) {
121      super.attr(key, val);
122      return this;
123   }
124
125   @Override /* Overridden from HtmlElement */
126   public Caption attrUri(String key, Object val) {
127      super.attrUri(key, val);
128      return this;
129   }
130
131   @Override /* Overridden from HtmlElementMixed */
132   public Caption child(Object value) {
133      super.child(value);
134      return this;
135   }
136
137   @Override /* Overridden from HtmlElementMixed */
138   public Caption children(Object...value) {
139      super.children(value);
140      return this;
141   }
142
143   @Override /* Overridden from HtmlElement */
144   public Caption contenteditable(Object value) {
145      super.contenteditable(value);
146      return this;
147   }
148
149   @Override /* Overridden from HtmlElement */
150   public Caption dir(String value) {
151      super.dir(value);
152      return this;
153   }
154
155   @Override /* Overridden from HtmlElement */
156   public Caption hidden(Object value) {
157      super.hidden(value);
158      return this;
159   }
160
161   @Override /* Overridden from HtmlElement */
162   public Caption id(String value) {
163      super.id(value);
164      return this;
165   }
166
167   @Override /* Overridden from HtmlElement */
168   public Caption lang(String value) {
169      super.lang(value);
170      return this;
171   }
172
173   @Override /* Overridden from HtmlElement */
174   public Caption onabort(String value) {
175      super.onabort(value);
176      return this;
177   }
178
179   @Override /* Overridden from HtmlElement */
180   public Caption onblur(String value) {
181      super.onblur(value);
182      return this;
183   }
184
185   @Override /* Overridden from HtmlElement */
186   public Caption oncancel(String value) {
187      super.oncancel(value);
188      return this;
189   }
190
191   @Override /* Overridden from HtmlElement */
192   public Caption oncanplay(String value) {
193      super.oncanplay(value);
194      return this;
195   }
196
197   @Override /* Overridden from HtmlElement */
198   public Caption oncanplaythrough(String value) {
199      super.oncanplaythrough(value);
200      return this;
201   }
202
203   @Override /* Overridden from HtmlElement */
204   public Caption onchange(String value) {
205      super.onchange(value);
206      return this;
207   }
208
209   @Override /* Overridden from HtmlElement */
210   public Caption onclick(String value) {
211      super.onclick(value);
212      return this;
213   }
214
215   @Override /* Overridden from HtmlElement */
216   public Caption oncuechange(String value) {
217      super.oncuechange(value);
218      return this;
219   }
220
221   @Override /* Overridden from HtmlElement */
222   public Caption ondblclick(String value) {
223      super.ondblclick(value);
224      return this;
225   }
226
227   @Override /* Overridden from HtmlElement */
228   public Caption ondurationchange(String value) {
229      super.ondurationchange(value);
230      return this;
231   }
232
233   @Override /* Overridden from HtmlElement */
234   public Caption onemptied(String value) {
235      super.onemptied(value);
236      return this;
237   }
238
239   @Override /* Overridden from HtmlElement */
240   public Caption onended(String value) {
241      super.onended(value);
242      return this;
243   }
244
245   @Override /* Overridden from HtmlElement */
246   public Caption onerror(String value) {
247      super.onerror(value);
248      return this;
249   }
250
251   @Override /* Overridden from HtmlElement */
252   public Caption onfocus(String value) {
253      super.onfocus(value);
254      return this;
255   }
256
257   @Override /* Overridden from HtmlElement */
258   public Caption oninput(String value) {
259      super.oninput(value);
260      return this;
261   }
262
263   @Override /* Overridden from HtmlElement */
264   public Caption oninvalid(String value) {
265      super.oninvalid(value);
266      return this;
267   }
268
269   @Override /* Overridden from HtmlElement */
270   public Caption onkeydown(String value) {
271      super.onkeydown(value);
272      return this;
273   }
274
275   @Override /* Overridden from HtmlElement */
276   public Caption onkeypress(String value) {
277      super.onkeypress(value);
278      return this;
279   }
280
281   @Override /* Overridden from HtmlElement */
282   public Caption onkeyup(String value) {
283      super.onkeyup(value);
284      return this;
285   }
286
287   @Override /* Overridden from HtmlElement */
288   public Caption onload(String value) {
289      super.onload(value);
290      return this;
291   }
292
293   @Override /* Overridden from HtmlElement */
294   public Caption onloadeddata(String value) {
295      super.onloadeddata(value);
296      return this;
297   }
298
299   @Override /* Overridden from HtmlElement */
300   public Caption onloadedmetadata(String value) {
301      super.onloadedmetadata(value);
302      return this;
303   }
304
305   @Override /* Overridden from HtmlElement */
306   public Caption onloadstart(String value) {
307      super.onloadstart(value);
308      return this;
309   }
310
311   @Override /* Overridden from HtmlElement */
312   public Caption onmousedown(String value) {
313      super.onmousedown(value);
314      return this;
315   }
316
317   @Override /* Overridden from HtmlElement */
318   public Caption onmouseenter(String value) {
319      super.onmouseenter(value);
320      return this;
321   }
322
323   @Override /* Overridden from HtmlElement */
324   public Caption onmouseleave(String value) {
325      super.onmouseleave(value);
326      return this;
327   }
328
329   @Override /* Overridden from HtmlElement */
330   public Caption onmousemove(String value) {
331      super.onmousemove(value);
332      return this;
333   }
334
335   @Override /* Overridden from HtmlElement */
336   public Caption onmouseout(String value) {
337      super.onmouseout(value);
338      return this;
339   }
340
341   @Override /* Overridden from HtmlElement */
342   public Caption onmouseover(String value) {
343      super.onmouseover(value);
344      return this;
345   }
346
347   @Override /* Overridden from HtmlElement */
348   public Caption onmouseup(String value) {
349      super.onmouseup(value);
350      return this;
351   }
352
353   @Override /* Overridden from HtmlElement */
354   public Caption onmousewheel(String value) {
355      super.onmousewheel(value);
356      return this;
357   }
358
359   @Override /* Overridden from HtmlElement */
360   public Caption onpause(String value) {
361      super.onpause(value);
362      return this;
363   }
364
365   @Override /* Overridden from HtmlElement */
366   public Caption onplay(String value) {
367      super.onplay(value);
368      return this;
369   }
370
371   @Override /* Overridden from HtmlElement */
372   public Caption onplaying(String value) {
373      super.onplaying(value);
374      return this;
375   }
376
377   @Override /* Overridden from HtmlElement */
378   public Caption onprogress(String value) {
379      super.onprogress(value);
380      return this;
381   }
382
383   @Override /* Overridden from HtmlElement */
384   public Caption onratechange(String value) {
385      super.onratechange(value);
386      return this;
387   }
388
389   @Override /* Overridden from HtmlElement */
390   public Caption onreset(String value) {
391      super.onreset(value);
392      return this;
393   }
394
395   @Override /* Overridden from HtmlElement */
396   public Caption onresize(String value) {
397      super.onresize(value);
398      return this;
399   }
400
401   @Override /* Overridden from HtmlElement */
402   public Caption onscroll(String value) {
403      super.onscroll(value);
404      return this;
405   }
406
407   @Override /* Overridden from HtmlElement */
408   public Caption onseeked(String value) {
409      super.onseeked(value);
410      return this;
411   }
412
413   @Override /* Overridden from HtmlElement */
414   public Caption onseeking(String value) {
415      super.onseeking(value);
416      return this;
417   }
418
419   @Override /* Overridden from HtmlElement */
420   public Caption onselect(String value) {
421      super.onselect(value);
422      return this;
423   }
424
425   @Override /* Overridden from HtmlElement */
426   public Caption onshow(String value) {
427      super.onshow(value);
428      return this;
429   }
430
431   @Override /* Overridden from HtmlElement */
432   public Caption onstalled(String value) {
433      super.onstalled(value);
434      return this;
435   }
436
437   @Override /* Overridden from HtmlElement */
438   public Caption onsubmit(String value) {
439      super.onsubmit(value);
440      return this;
441   }
442
443   @Override /* Overridden from HtmlElement */
444   public Caption onsuspend(String value) {
445      super.onsuspend(value);
446      return this;
447   }
448
449   @Override /* Overridden from HtmlElement */
450   public Caption ontimeupdate(String value) {
451      super.ontimeupdate(value);
452      return this;
453   }
454
455   @Override /* Overridden from HtmlElement */
456   public Caption ontoggle(String value) {
457      super.ontoggle(value);
458      return this;
459   }
460
461   @Override /* Overridden from HtmlElement */
462   public Caption onvolumechange(String value) {
463      super.onvolumechange(value);
464      return this;
465   }
466
467   @Override /* Overridden from HtmlElement */
468   public Caption onwaiting(String value) {
469      super.onwaiting(value);
470      return this;
471   }
472
473   @Override /* Overridden from HtmlElement */
474   public Caption spellcheck(Object value) {
475      super.spellcheck(value);
476      return this;
477   }
478
479   @Override /* Overridden from HtmlElement */
480   public Caption style(String value) {
481      super.style(value);
482      return this;
483   }
484
485   @Override /* Overridden from HtmlElement */
486   public Caption tabindex(Object value) {
487      super.tabindex(value);
488      return this;
489   }
490
491   @Override /* Overridden from HtmlElement */
492   public Caption title(String value) {
493      super.title(value);
494      return this;
495   }
496
497   @Override /* Overridden from HtmlElement */
498   public Caption translate(Object value) {
499      super.translate(value);
500      return this;
501   }
502}