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