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