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