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