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