Source code

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