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