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-dl-element">&lt;dl&gt;</a>
025 * element.
026 *
027 * <p>
028 * The dl element represents a description list (also known as a definition list or association list).
029 * It is used to group terms (dt elements) with their descriptions (dd elements), creating a list
030 * of term-description pairs. The dl element is commonly used for glossaries, metadata lists, or
031 * any other content where you need to associate terms with their definitions or descriptions.
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 description list</jc>
038 *    Dl <jv>simple</jv> = <jsm>dl</jsm>(
039 *       <jsm>dt</jsm>(<js>"HTML"</js>),
040 *       <jsm>dd</jsm>(<js>"HyperText Markup Language"</js>),
041 *       <jsm>dt</jsm>(<js>"CSS"</js>),
042 *       <jsm>dd</jsm>(<js>"Cascading Style Sheets"</js>)
043 *    );
044 *
045 *    <jc>// Description list with styling</jc>
046 *    Dl <jv>styled</jv> = <jsm>dl</jsm>(
047 *       <jsm>dt</jsm>(<js>"API"</js>),
048 *       <jsm>dd</jsm>(<js>"Application Programming Interface"</js>),
049 *       <jsm>dt</jsm>(<js>"DOM"</js>),
050 *       <jsm>dd</jsm>(<js>"Document Object Model"</js>)
051 *    )._class(<js>"glossary"</js>);
052 *
053 *    <jc>// Description list with multiple descriptions</jc>
054 *    Dl <jv>multiple</jv> = <jsm>dl</jsm>(
055 *       <jsm>dt</jsm>(<js>"JavaScript"</js>),
056 *       <jsm>dd</jsm>(<js>"A programming language for web development."</js>),
057 *       <jsm>dd</jsm>(<js>"It runs in web browsers and on servers."</js>),
058 *       <jsm>dt</jsm>(<js>"Python"</js>),
059 *       <jsm>dd</jsm>(<js>"A high-level programming language."</js>),
060 *       <jsm>dd</jsm>(<js>"Known for its simplicity and readability."</js>)
061 *    );
062 *
063 *    <jc>// Description list with complex content</jc>
064 *    Dl <jv>complex</jv> = <jsm>dl</jsm>(
065 *       <jsm>dt</jsm>(<js>"Web Standards"</js>),
066 *       <jsm>dd</jsm>(
067 *          <js>"Standards developed by the "</js>,
068 *          <jsm>a</jsm>(<js>"https://w3.org"</js>, <js>"W3C"</js>),
069 *          <js>" to ensure web compatibility."</js>
070 *       ),
071 *       <jsm>dt</jsm>(<js>"Responsive Design"</js>),
072 *       <jsm>dd</jsm>(
073 *          <js>"Design approach that adapts to different "</js>,
074 *          <jsm>strong</jsm>(<js>"screen sizes"</js>),
075 *          <js>" and devices."</js>
076 *       )
077 *    );
078 *
079 *    <jc>// Description list with ID</jc>
080 *    Dl <jv>withId</jv> = <jsm>dl</jsm>(
081 *       <jsm>dt</jsm>(<js>"Framework"</js>),
082 *       <jsm>dd</jsm>(<js>"A collection of pre-written code for common tasks."</js>),
083 *       <jsm>dt</jsm>(<js>"Library"</js>),
084 *       <jsm>dd</jsm>(<js>"A collection of reusable code modules."</js>)
085 *    ).id(<js>"tech-terms"</js>);
086 *
087 *    <jc>// Description list with styling</jc>
088 *    Dl <jv>styled2</jv> = <jsm>dl</jsm>(
089 *       <jsm>dt</jsm>(<js>"Frontend"</js>),
090 *       <jsm>dd</jsm>(<js>"The client-side part of a web application."</js>),
091 *       <jsm>dt</jsm>(<js>"Backend"</js>),
092 *       <jsm>dd</jsm>(<js>"The server-side part of a web application."</js>)
093 *    ).style(<js>"border: 1px solid #ccc; padding: 10px;"</js>);
094 * </p>
095 *
096 * <p>
097 * The following convenience methods are provided for constructing instances of this bean:
098 * <ul class='javatree'>
099 *    <li class='jc'>{@link HtmlBuilder}
100 *    <ul class='javatree'>
101 *       <li class='jm'>{@link HtmlBuilder#dl() dl()}
102 *       <li class='jm'>{@link HtmlBuilder#dl(Object...) dl(Object...)}
103 *    </ul>
104 * </ul>
105 * </p>
106 *
107 * <h5 class='section'>See Also:</h5><ul>
108 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauBeanHtml5">juneau-bean-html5</a>
109 * </ul>
110 */
111@Bean(typeName = "dl")
112public class Dl extends HtmlElementContainer {
113
114   /**
115    * Creates an empty {@link Dl} element.
116    */
117   public Dl() {}
118
119   /**
120    * Creates a {@link Dl} element with the specified child nodes.
121    *
122    * @param children The child nodes.
123    */
124   public Dl(Object...children) {
125      children(children);
126   }
127
128   @Override /* Overridden from HtmlElement */
129   public Dl _class(String value) { // NOSONAR - Intentional naming.
130      super._class(value);
131      return this;
132   }
133
134   @Override /* Overridden from HtmlElement */
135   public Dl accesskey(String value) {
136      super.accesskey(value);
137      return this;
138   }
139
140   @Override /* Overridden from HtmlElement */
141   public Dl attr(String key, Object val) {
142      super.attr(key, val);
143      return this;
144   }
145
146   @Override /* Overridden from HtmlElement */
147   public Dl attrUri(String key, Object val) {
148      super.attrUri(key, val);
149      return this;
150   }
151
152   @Override /* Overridden from HtmlElementContainer */
153   public Dl child(Object value) {
154      super.child(value);
155      return this;
156   }
157
158   @Override /* Overridden from HtmlElementContainer */
159   public Dl children(Object...value) {
160      super.children(value);
161      return this;
162   }
163
164   @Override /* Overridden from HtmlElement */
165   public Dl contenteditable(Object value) {
166      super.contenteditable(value);
167      return this;
168   }
169
170   @Override /* Overridden from HtmlElement */
171   public Dl dir(String value) {
172      super.dir(value);
173      return this;
174   }
175
176   @Override /* Overridden from HtmlElement */
177   public Dl hidden(Object value) {
178      super.hidden(value);
179      return this;
180   }
181
182   @Override /* Overridden from HtmlElement */
183   public Dl id(String value) {
184      super.id(value);
185      return this;
186   }
187
188   @Override /* Overridden from HtmlElement */
189   public Dl lang(String value) {
190      super.lang(value);
191      return this;
192   }
193
194   @Override /* Overridden from HtmlElement */
195   public Dl onabort(String value) {
196      super.onabort(value);
197      return this;
198   }
199
200   @Override /* Overridden from HtmlElement */
201   public Dl onblur(String value) {
202      super.onblur(value);
203      return this;
204   }
205
206   @Override /* Overridden from HtmlElement */
207   public Dl oncancel(String value) {
208      super.oncancel(value);
209      return this;
210   }
211
212   @Override /* Overridden from HtmlElement */
213   public Dl oncanplay(String value) {
214      super.oncanplay(value);
215      return this;
216   }
217
218   @Override /* Overridden from HtmlElement */
219   public Dl oncanplaythrough(String value) {
220      super.oncanplaythrough(value);
221      return this;
222   }
223
224   @Override /* Overridden from HtmlElement */
225   public Dl onchange(String value) {
226      super.onchange(value);
227      return this;
228   }
229
230   @Override /* Overridden from HtmlElement */
231   public Dl onclick(String value) {
232      super.onclick(value);
233      return this;
234   }
235
236   @Override /* Overridden from HtmlElement */
237   public Dl oncuechange(String value) {
238      super.oncuechange(value);
239      return this;
240   }
241
242   @Override /* Overridden from HtmlElement */
243   public Dl ondblclick(String value) {
244      super.ondblclick(value);
245      return this;
246   }
247
248   @Override /* Overridden from HtmlElement */
249   public Dl ondurationchange(String value) {
250      super.ondurationchange(value);
251      return this;
252   }
253
254   @Override /* Overridden from HtmlElement */
255   public Dl onemptied(String value) {
256      super.onemptied(value);
257      return this;
258   }
259
260   @Override /* Overridden from HtmlElement */
261   public Dl onended(String value) {
262      super.onended(value);
263      return this;
264   }
265
266   @Override /* Overridden from HtmlElement */
267   public Dl onerror(String value) {
268      super.onerror(value);
269      return this;
270   }
271
272   @Override /* Overridden from HtmlElement */
273   public Dl onfocus(String value) {
274      super.onfocus(value);
275      return this;
276   }
277
278   @Override /* Overridden from HtmlElement */
279   public Dl oninput(String value) {
280      super.oninput(value);
281      return this;
282   }
283
284   @Override /* Overridden from HtmlElement */
285   public Dl oninvalid(String value) {
286      super.oninvalid(value);
287      return this;
288   }
289
290   @Override /* Overridden from HtmlElement */
291   public Dl onkeydown(String value) {
292      super.onkeydown(value);
293      return this;
294   }
295
296   @Override /* Overridden from HtmlElement */
297   public Dl onkeypress(String value) {
298      super.onkeypress(value);
299      return this;
300   }
301
302   @Override /* Overridden from HtmlElement */
303   public Dl onkeyup(String value) {
304      super.onkeyup(value);
305      return this;
306   }
307
308   @Override /* Overridden from HtmlElement */
309   public Dl onload(String value) {
310      super.onload(value);
311      return this;
312   }
313
314   @Override /* Overridden from HtmlElement */
315   public Dl onloadeddata(String value) {
316      super.onloadeddata(value);
317      return this;
318   }
319
320   @Override /* Overridden from HtmlElement */
321   public Dl onloadedmetadata(String value) {
322      super.onloadedmetadata(value);
323      return this;
324   }
325
326   @Override /* Overridden from HtmlElement */
327   public Dl onloadstart(String value) {
328      super.onloadstart(value);
329      return this;
330   }
331
332   @Override /* Overridden from HtmlElement */
333   public Dl onmousedown(String value) {
334      super.onmousedown(value);
335      return this;
336   }
337
338   @Override /* Overridden from HtmlElement */
339   public Dl onmouseenter(String value) {
340      super.onmouseenter(value);
341      return this;
342   }
343
344   @Override /* Overridden from HtmlElement */
345   public Dl onmouseleave(String value) {
346      super.onmouseleave(value);
347      return this;
348   }
349
350   @Override /* Overridden from HtmlElement */
351   public Dl onmousemove(String value) {
352      super.onmousemove(value);
353      return this;
354   }
355
356   @Override /* Overridden from HtmlElement */
357   public Dl onmouseout(String value) {
358      super.onmouseout(value);
359      return this;
360   }
361
362   @Override /* Overridden from HtmlElement */
363   public Dl onmouseover(String value) {
364      super.onmouseover(value);
365      return this;
366   }
367
368   @Override /* Overridden from HtmlElement */
369   public Dl onmouseup(String value) {
370      super.onmouseup(value);
371      return this;
372   }
373
374   @Override /* Overridden from HtmlElement */
375   public Dl onmousewheel(String value) {
376      super.onmousewheel(value);
377      return this;
378   }
379
380   @Override /* Overridden from HtmlElement */
381   public Dl onpause(String value) {
382      super.onpause(value);
383      return this;
384   }
385
386   @Override /* Overridden from HtmlElement */
387   public Dl onplay(String value) {
388      super.onplay(value);
389      return this;
390   }
391
392   @Override /* Overridden from HtmlElement */
393   public Dl onplaying(String value) {
394      super.onplaying(value);
395      return this;
396   }
397
398   @Override /* Overridden from HtmlElement */
399   public Dl onprogress(String value) {
400      super.onprogress(value);
401      return this;
402   }
403
404   @Override /* Overridden from HtmlElement */
405   public Dl onratechange(String value) {
406      super.onratechange(value);
407      return this;
408   }
409
410   @Override /* Overridden from HtmlElement */
411   public Dl onreset(String value) {
412      super.onreset(value);
413      return this;
414   }
415
416   @Override /* Overridden from HtmlElement */
417   public Dl onresize(String value) {
418      super.onresize(value);
419      return this;
420   }
421
422   @Override /* Overridden from HtmlElement */
423   public Dl onscroll(String value) {
424      super.onscroll(value);
425      return this;
426   }
427
428   @Override /* Overridden from HtmlElement */
429   public Dl onseeked(String value) {
430      super.onseeked(value);
431      return this;
432   }
433
434   @Override /* Overridden from HtmlElement */
435   public Dl onseeking(String value) {
436      super.onseeking(value);
437      return this;
438   }
439
440   @Override /* Overridden from HtmlElement */
441   public Dl onselect(String value) {
442      super.onselect(value);
443      return this;
444   }
445
446   @Override /* Overridden from HtmlElement */
447   public Dl onshow(String value) {
448      super.onshow(value);
449      return this;
450   }
451
452   @Override /* Overridden from HtmlElement */
453   public Dl onstalled(String value) {
454      super.onstalled(value);
455      return this;
456   }
457
458   @Override /* Overridden from HtmlElement */
459   public Dl onsubmit(String value) {
460      super.onsubmit(value);
461      return this;
462   }
463
464   @Override /* Overridden from HtmlElement */
465   public Dl onsuspend(String value) {
466      super.onsuspend(value);
467      return this;
468   }
469
470   @Override /* Overridden from HtmlElement */
471   public Dl ontimeupdate(String value) {
472      super.ontimeupdate(value);
473      return this;
474   }
475
476   @Override /* Overridden from HtmlElement */
477   public Dl ontoggle(String value) {
478      super.ontoggle(value);
479      return this;
480   }
481
482   @Override /* Overridden from HtmlElement */
483   public Dl onvolumechange(String value) {
484      super.onvolumechange(value);
485      return this;
486   }
487
488   @Override /* Overridden from HtmlElement */
489   public Dl onwaiting(String value) {
490      super.onwaiting(value);
491      return this;
492   }
493
494   @Override /* Overridden from HtmlElementContainer */
495   public Dl setChildren(List<Object> children) {
496      super.setChildren(children);
497      return this;
498   }
499
500   @Override /* Overridden from HtmlElement */
501   public Dl spellcheck(Object value) {
502      super.spellcheck(value);
503      return this;
504   }
505
506   @Override /* Overridden from HtmlElement */
507   public Dl style(String value) {
508      super.style(value);
509      return this;
510   }
511
512   @Override /* Overridden from HtmlElement */
513   public Dl tabindex(Object value) {
514      super.tabindex(value);
515      return this;
516   }
517
518   @Override /* Overridden from HtmlElement */
519   public Dl title(String value) {
520      super.title(value);
521      return this;
522   }
523
524   @Override /* Overridden from HtmlElement */
525   public Dl translate(Object value) {
526      super.translate(value);
527      return this;
528   }
529}