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