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