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