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