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