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