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