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