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