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