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