Source code

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