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-time-element">&lt;time&gt;</a>
023 * element.
024 *
025 * <p>
026 * The time element represents a specific point in time or a duration. It provides a machine-readable
027 * way to mark up dates and times in HTML, making it easier for search engines, screen readers, and
028 * other tools to understand and process temporal information. The element can contain human-readable
029 * text while providing a machine-readable datetime attribute.
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>// Simple date</jc>
036 *    Time <jv>date</jv> = <jsm>time</jsm>(<js>"January 15, 2024"</js>)
037 *       .datetime(<js>"2024-01-15"</js>);
038 *
039 *    <jc>// Date and time</jc>
040 *    Time <jv>datetime</jv> = <jsm>time</jsm>(<js>"2:30 PM on January 15, 2024"</js>)
041 *       .datetime(<js>"2024-01-15T14:30:00Z"</js>);
042 *
043 *    <jc>// Relative time</jc>
044 *    Time <jv>relative</jv> = <jsm>time</jsm>(<js>"yesterday"</js>)
045 *       .datetime(<js>"2024-01-15"</js>);
046 *
047 *    <jc>// Duration</jc>
048 *    Time <jv>duration</jv> = <jsm>time</jsm>(<js>"2 hours and 30 minutes"</js>)
049 *       .datetime(<js>"PT2H30M"</js>);
050 *
051 *    <jc>// Time with styling</jc>
052 *    Time <jv>styled</jv> = <jsm>time</jsm>(<js>"Event Date: January 15, 2024"</js>)
053 *       .datetime(<js>"2024-01-15"</js>)
054 *       ._class(<js>"event-date"</js>);
055 *
056 *    <jc>// Time with timezone</jc>
057 *    Time <jv>timezone</jv> = <jsm>time</jsm>(<js>"2:30 PM EST on January 15, 2024"</js>)
058 *       .datetime(<js>"2024-01-15T14:30:00-05:00"</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#time() time()}
067 *       <li class='jm'>{@link HtmlBuilder#time(Object...) time(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 = "time")
077public class Time extends HtmlElementMixed {
078
079   /**
080    * Creates an empty {@link Time} element.
081    */
082   public Time() {}
083
084   /**
085    * Creates a {@link Time} element with the specified {@link Time#children(Object[])} nodes.
086    *
087    * @param children The {@link Time#children(Object[])} nodes.
088    */
089   public Time(Object...children) {
090      children(children);
091   }
092
093   @Override /* Overridden from HtmlElement */
094   public Time _class(String value) { // NOSONAR - Intentional naming.
095      super._class(value);
096      return this;
097   }
098
099   @Override /* Overridden from HtmlElement */
100   public Time accesskey(String value) {
101      super.accesskey(value);
102      return this;
103   }
104
105   @Override /* Overridden from HtmlElement */
106   public Time attr(String key, Object val) {
107      super.attr(key, val);
108      return this;
109   }
110
111   @Override /* Overridden from HtmlElement */
112   public Time attrUri(String key, Object val) {
113      super.attrUri(key, val);
114      return this;
115   }
116
117   @Override /* Overridden from HtmlElementMixed */
118   public Time child(Object value) {
119      super.child(value);
120      return this;
121   }
122
123   @Override /* Overridden from HtmlElementMixed */
124   public Time children(Object...value) {
125      super.children(value);
126      return this;
127   }
128
129   @Override /* Overridden from HtmlElement */
130   public Time contenteditable(Object value) {
131      super.contenteditable(value);
132      return this;
133   }
134
135   /**
136    * <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#attr-time-datetime">datetime</a>
137    * attribute.
138    *
139    * <p>
140    * Specifies the machine-readable value of the time element. This provides a standardized
141    * format for the date and time that can be processed by computers.
142    *
143    * <p>
144    * The value should be a valid date-time string in ISO 8601 format.
145    *
146    * @param value The machine-readable date and time value.
147    * @return This object.
148    */
149   public Time datetime(String value) {
150      attr("datetime", value);
151      return this;
152   }
153
154   @Override /* Overridden from HtmlElement */
155   public Time dir(String value) {
156      super.dir(value);
157      return this;
158   }
159
160   @Override /* Overridden from HtmlElement */
161   public Time hidden(Object value) {
162      super.hidden(value);
163      return this;
164   }
165
166   @Override /* Overridden from HtmlElement */
167   public Time id(String value) {
168      super.id(value);
169      return this;
170   }
171
172   @Override /* Overridden from HtmlElement */
173   public Time lang(String value) {
174      super.lang(value);
175      return this;
176   }
177
178   @Override /* Overridden from HtmlElement */
179   public Time onabort(String value) {
180      super.onabort(value);
181      return this;
182   }
183
184   @Override /* Overridden from HtmlElement */
185   public Time onblur(String value) {
186      super.onblur(value);
187      return this;
188   }
189
190   @Override /* Overridden from HtmlElement */
191   public Time oncancel(String value) {
192      super.oncancel(value);
193      return this;
194   }
195
196   @Override /* Overridden from HtmlElement */
197   public Time oncanplay(String value) {
198      super.oncanplay(value);
199      return this;
200   }
201
202   @Override /* Overridden from HtmlElement */
203   public Time oncanplaythrough(String value) {
204      super.oncanplaythrough(value);
205      return this;
206   }
207
208   @Override /* Overridden from HtmlElement */
209   public Time onchange(String value) {
210      super.onchange(value);
211      return this;
212   }
213
214   @Override /* Overridden from HtmlElement */
215   public Time onclick(String value) {
216      super.onclick(value);
217      return this;
218   }
219
220   @Override /* Overridden from HtmlElement */
221   public Time oncuechange(String value) {
222      super.oncuechange(value);
223      return this;
224   }
225
226   @Override /* Overridden from HtmlElement */
227   public Time ondblclick(String value) {
228      super.ondblclick(value);
229      return this;
230   }
231
232   @Override /* Overridden from HtmlElement */
233   public Time ondurationchange(String value) {
234      super.ondurationchange(value);
235      return this;
236   }
237
238   @Override /* Overridden from HtmlElement */
239   public Time onemptied(String value) {
240      super.onemptied(value);
241      return this;
242   }
243
244   @Override /* Overridden from HtmlElement */
245   public Time onended(String value) {
246      super.onended(value);
247      return this;
248   }
249
250   @Override /* Overridden from HtmlElement */
251   public Time onerror(String value) {
252      super.onerror(value);
253      return this;
254   }
255
256   @Override /* Overridden from HtmlElement */
257   public Time onfocus(String value) {
258      super.onfocus(value);
259      return this;
260   }
261
262   @Override /* Overridden from HtmlElement */
263   public Time oninput(String value) {
264      super.oninput(value);
265      return this;
266   }
267
268   @Override /* Overridden from HtmlElement */
269   public Time oninvalid(String value) {
270      super.oninvalid(value);
271      return this;
272   }
273
274   @Override /* Overridden from HtmlElement */
275   public Time onkeydown(String value) {
276      super.onkeydown(value);
277      return this;
278   }
279
280   @Override /* Overridden from HtmlElement */
281   public Time onkeypress(String value) {
282      super.onkeypress(value);
283      return this;
284   }
285
286   @Override /* Overridden from HtmlElement */
287   public Time onkeyup(String value) {
288      super.onkeyup(value);
289      return this;
290   }
291
292   @Override /* Overridden from HtmlElement */
293   public Time onload(String value) {
294      super.onload(value);
295      return this;
296   }
297
298   @Override /* Overridden from HtmlElement */
299   public Time onloadeddata(String value) {
300      super.onloadeddata(value);
301      return this;
302   }
303
304   @Override /* Overridden from HtmlElement */
305   public Time onloadedmetadata(String value) {
306      super.onloadedmetadata(value);
307      return this;
308   }
309
310   @Override /* Overridden from HtmlElement */
311   public Time onloadstart(String value) {
312      super.onloadstart(value);
313      return this;
314   }
315
316   @Override /* Overridden from HtmlElement */
317   public Time onmousedown(String value) {
318      super.onmousedown(value);
319      return this;
320   }
321
322   @Override /* Overridden from HtmlElement */
323   public Time onmouseenter(String value) {
324      super.onmouseenter(value);
325      return this;
326   }
327
328   @Override /* Overridden from HtmlElement */
329   public Time onmouseleave(String value) {
330      super.onmouseleave(value);
331      return this;
332   }
333
334   @Override /* Overridden from HtmlElement */
335   public Time onmousemove(String value) {
336      super.onmousemove(value);
337      return this;
338   }
339
340   @Override /* Overridden from HtmlElement */
341   public Time onmouseout(String value) {
342      super.onmouseout(value);
343      return this;
344   }
345
346   @Override /* Overridden from HtmlElement */
347   public Time onmouseover(String value) {
348      super.onmouseover(value);
349      return this;
350   }
351
352   @Override /* Overridden from HtmlElement */
353   public Time onmouseup(String value) {
354      super.onmouseup(value);
355      return this;
356   }
357
358   @Override /* Overridden from HtmlElement */
359   public Time onmousewheel(String value) {
360      super.onmousewheel(value);
361      return this;
362   }
363
364   @Override /* Overridden from HtmlElement */
365   public Time onpause(String value) {
366      super.onpause(value);
367      return this;
368   }
369
370   @Override /* Overridden from HtmlElement */
371   public Time onplay(String value) {
372      super.onplay(value);
373      return this;
374   }
375
376   @Override /* Overridden from HtmlElement */
377   public Time onplaying(String value) {
378      super.onplaying(value);
379      return this;
380   }
381
382   @Override /* Overridden from HtmlElement */
383   public Time onprogress(String value) {
384      super.onprogress(value);
385      return this;
386   }
387
388   @Override /* Overridden from HtmlElement */
389   public Time onratechange(String value) {
390      super.onratechange(value);
391      return this;
392   }
393
394   @Override /* Overridden from HtmlElement */
395   public Time onreset(String value) {
396      super.onreset(value);
397      return this;
398   }
399
400   @Override /* Overridden from HtmlElement */
401   public Time onresize(String value) {
402      super.onresize(value);
403      return this;
404   }
405
406   @Override /* Overridden from HtmlElement */
407   public Time onscroll(String value) {
408      super.onscroll(value);
409      return this;
410   }
411
412   @Override /* Overridden from HtmlElement */
413   public Time onseeked(String value) {
414      super.onseeked(value);
415      return this;
416   }
417
418   @Override /* Overridden from HtmlElement */
419   public Time onseeking(String value) {
420      super.onseeking(value);
421      return this;
422   }
423
424   @Override /* Overridden from HtmlElement */
425   public Time onselect(String value) {
426      super.onselect(value);
427      return this;
428   }
429
430   @Override /* Overridden from HtmlElement */
431   public Time onshow(String value) {
432      super.onshow(value);
433      return this;
434   }
435
436   @Override /* Overridden from HtmlElement */
437   public Time onstalled(String value) {
438      super.onstalled(value);
439      return this;
440   }
441
442   @Override /* Overridden from HtmlElement */
443   public Time onsubmit(String value) {
444      super.onsubmit(value);
445      return this;
446   }
447
448   @Override /* Overridden from HtmlElement */
449   public Time onsuspend(String value) {
450      super.onsuspend(value);
451      return this;
452   }
453
454   @Override /* Overridden from HtmlElement */
455   public Time ontimeupdate(String value) {
456      super.ontimeupdate(value);
457      return this;
458   }
459
460   @Override /* Overridden from HtmlElement */
461   public Time ontoggle(String value) {
462      super.ontoggle(value);
463      return this;
464   }
465
466   @Override /* Overridden from HtmlElement */
467   public Time onvolumechange(String value) {
468      super.onvolumechange(value);
469      return this;
470   }
471
472   @Override /* Overridden from HtmlElement */
473   public Time onwaiting(String value) {
474      super.onwaiting(value);
475      return this;
476   }
477
478   @Override /* Overridden from HtmlElement */
479   public Time spellcheck(Object value) {
480      super.spellcheck(value);
481      return this;
482   }
483
484   @Override /* Overridden from HtmlElement */
485   public Time style(String value) {
486      super.style(value);
487      return this;
488   }
489
490   @Override /* Overridden from HtmlElement */
491   public Time tabindex(Object value) {
492      super.tabindex(value);
493      return this;
494   }
495
496   @Override /* Overridden from HtmlElement */
497   public Time title(String value) {
498      super.title(value);
499      return this;
500   }
501
502   @Override /* Overridden from HtmlElement */
503   public Time translate(Object value) {
504      super.translate(value);
505      return this;
506   }
507}