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 java.net.*;
020
021import org.apache.juneau.*;
022import org.apache.juneau.annotation.*;
023import org.apache.juneau.common.utils.*;
024import org.apache.juneau.internal.*;
025
026/**
027 * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#the-script-element">&lt;script&gt;</a>
028 * element.
029 *
030 * <p>
031 * The script element is used to embed or reference executable code, typically JavaScript. It can
032 * contain inline script code or reference external script files. The script element is commonly
033 * used to add interactivity and dynamic behavior to web pages.
034 *
035 * <h5 class='section'>Examples:</h5>
036 * <p class='bcode w800'>
037 *    <jk>import static</jk> org.apache.juneau.bean.html5.HtmlBuilder.*;
038 * 
039 *    <jc>// Inline JavaScript</jc>
040 *    Script <jv>script1</jv> = <jsm>script</jsm>()
041 *       .text(<js>"console.log('Hello, World!');"</js>);
042 * 
043 *    <jc>// External JavaScript file</jc>
044 *    Script <jv>script2</jv> = <jsm>script</jsm>()
045 *       .src(<js>"https://example.com/script.js"</js>)
046 *       .type(<js>"text/javascript"</js>);
047 * 
048 *    <jc>// Async script loading</jc>
049 *    Script <jv>script3</jv> = <jsm>script</jsm>()
050 *       .src(<js>"https://example.com/analytics.js"</js>)
051 *       .async(<jk>true</jk>)
052 *       .defer(<jk>true</jk>);
053 * 
054 *    <jc>// Script with integrity check</jc>
055 *    Script <jv>script4</jv> = <jsm>script</jsm>()
056 *       .src(<js>"https://example.com/library.js"</js>)
057 *       .integrity(<js>"sha384-..."</js>)
058 *       .crossorigin(<js>"anonymous"</js>);
059 * 
060 *    <jc>// Module script</jc>
061 *    Script <jv>script5</jv> = <jsm>script</jsm>()
062 *       .src(<js>"https://example.com/module.js"</js>)
063 *       .type(<js>"module"</js>);
064 * </p>
065 *
066 * <p>
067 * The following convenience methods are provided for constructing instances of this bean:
068 * <ul class='javatree'>
069 *    <li class='jc'>{@link HtmlBuilder}
070 *    <ul class='javatree'>
071 *       <li class='jm'>{@link HtmlBuilder#script() script()}
072 *       <li class='jm'>{@link HtmlBuilder#script(Object, Object...) script(Object, Object...)}
073 *    </ul>
074 * </ul>
075 * </p>
076 *
077 * <h5 class='section'>See Also:</h5><ul>
078 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauBeanHtml5">juneau-bean-html5</a>
079 * </ul>
080 */
081@Bean(typeName="script")
082public class Script extends HtmlElementRawText {
083
084   /**
085    * Creates an empty {@link Script} element.
086    */
087   public Script() {}
088
089   /**
090    * Creates a {@link Script} element with the specified {@link Script#type(String)} attribute and
091    * {@link Script#text(Object)} node.
092    *
093    * @param type The {@link Script#type(String)} attribute.
094    * @param text The child text node.
095    */
096   public Script(String type, String...text) {
097      type(type).text(Utils.joinnl(text));
098   }
099
100   /**
101    * <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#attr-script-async">async</a> attribute.
102    *
103    * <p>
104    * Execute script asynchronously.
105    *
106    * <p>
107    * This attribute uses deminimized values:
108    * <ul>
109    *    <li><jk>false</jk> - Attribute is not added</li>
110    *    <li><jk>true</jk> - Attribute is added as <js>"async"</js></li>
111    *    <li>Other values - Passed through as-is</li>
112    * </ul>
113    *
114    * @param async
115    *    The new value for this attribute.
116    *    Typically a {@link Boolean} or {@link String}.
117    * @return This object.
118    */
119   public Script async(Object value) {
120      attr("async", deminimize(value, "async"));
121      return this;
122   }
123
124   /**
125    * <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#attr-script-charset">charset</a> attribute.
126    *
127    * <p>
128    * Specifies the character encoding of the external script resource. This is used when
129    * the script is loaded from an external source.
130    *
131    * <p>
132    * Common values:
133    * <ul>
134    *    <li><js>"utf-8"</js> - UTF-8 encoding (default)</li>
135    *    <li><js>"iso-8859-1"</js> - Latin-1 encoding</li>
136    *    <li><js>"windows-1252"</js> - Windows-1252 encoding</li>
137    * </ul>
138    *
139    * @param charset The character encoding of the external script resource.
140    * @return This object.
141    */
142   public Script charset(String value) {
143      attr("charset", value);
144      return this;
145   }
146
147   /**
148    * <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#attr-script-crossorigin">crossorigin</a>
149    * attribute.
150    *
151    * <p>
152    * How the element handles cross-origin requests.
153    *
154    * @param crossorigin The new value for this attribute.
155    * @return This object.
156    */
157   public Script crossorigin(String value) {
158      attr("crossorigin", value);
159      return this;
160   }
161
162   /**
163    * <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#attr-script-defer">defer</a> attribute.
164    *
165    * <p>
166    * Defer script execution.
167    *
168    * <p>
169    * This attribute uses deminimized values:
170    * <ul>
171    *    <li><jk>false</jk> - Attribute is not added</li>
172    *    <li><jk>true</jk> - Attribute is added as <js>"defer"</js></li>
173    *    <li>Other values - Passed through as-is</li>
174    * </ul>
175    *
176    * @param defer
177    *    The new value for this attribute.
178    *    Typically a {@link Boolean} or {@link String}.
179    * @return This object.
180    */
181   public Script defer(Object value) {
182      attr("defer", deminimize(value, "defer"));
183      return this;
184   }
185
186   /**
187    * <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#attr-script-src">src</a> attribute.
188    *
189    * <p>
190    * Address of the resource.
191    *
192    * <p>
193    * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
194    * Strings must be valid URIs.
195    *
196    * <p>
197    * URIs defined by {@link UriResolver} can be used for values.
198    *
199    * @param src
200    *    The new value for this attribute.
201    *    Typically a {@link URL} or {@link String}.
202    * @return This object.
203    */
204   public Script src(Object value) {
205      attrUri("src", value);
206      return this;
207   }
208
209   /**
210    * <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#attr-script-type">type</a> attribute.
211    *
212    * <p>
213    * Type of embedded resource.
214    *
215    * @param type The new value for this attribute.
216    * @return This object.
217    */
218   public Script type(String value) {
219      attr("type", value);
220      return this;
221   }
222
223   //-----------------------------------------------------------------------------------------------------------------
224   // Overridden methods
225   //-----------------------------------------------------------------------------------------------------------------
226   @Override /* Overridden from HtmlElement */
227   public Script _class(String value) {  // NOSONAR - Intentional naming.
228      super._class(value);
229      return this;
230   }
231
232   @Override /* Overridden from HtmlElement */
233   public Script accesskey(String value) {
234      super.accesskey(value);
235      return this;
236   }
237
238   @Override /* Overridden from HtmlElement */
239   public Script contenteditable(Object value) {
240      super.contenteditable(value);
241      return this;
242   }
243
244   @Override /* Overridden from HtmlElement */
245   public Script dir(String value) {
246      super.dir(value);
247      return this;
248   }
249
250   @Override /* Overridden from HtmlElement */
251   public Script hidden(Object value) {
252      super.hidden(value);
253      return this;
254   }
255
256   @Override /* Overridden from HtmlElement */
257   public Script id(String value) {
258      super.id(value);
259      return this;
260   }
261
262   @Override /* Overridden from HtmlElement */
263   public Script lang(String value) {
264      super.lang(value);
265      return this;
266   }
267
268   @Override /* Overridden from HtmlElement */
269   public Script onabort(String value) {
270      super.onabort(value);
271      return this;
272   }
273
274   @Override /* Overridden from HtmlElement */
275   public Script onblur(String value) {
276      super.onblur(value);
277      return this;
278   }
279
280   @Override /* Overridden from HtmlElement */
281   public Script oncancel(String value) {
282      super.oncancel(value);
283      return this;
284   }
285
286   @Override /* Overridden from HtmlElement */
287   public Script oncanplay(String value) {
288      super.oncanplay(value);
289      return this;
290   }
291
292   @Override /* Overridden from HtmlElement */
293   public Script oncanplaythrough(String value) {
294      super.oncanplaythrough(value);
295      return this;
296   }
297
298   @Override /* Overridden from HtmlElement */
299   public Script onchange(String value) {
300      super.onchange(value);
301      return this;
302   }
303
304   @Override /* Overridden from HtmlElement */
305   public Script onclick(String value) {
306      super.onclick(value);
307      return this;
308   }
309
310   @Override /* Overridden from HtmlElement */
311   public Script oncuechange(String value) {
312      super.oncuechange(value);
313      return this;
314   }
315
316   @Override /* Overridden from HtmlElement */
317   public Script ondblclick(String value) {
318      super.ondblclick(value);
319      return this;
320   }
321
322   @Override /* Overridden from HtmlElement */
323   public Script ondurationchange(String value) {
324      super.ondurationchange(value);
325      return this;
326   }
327
328   @Override /* Overridden from HtmlElement */
329   public Script onemptied(String value) {
330      super.onemptied(value);
331      return this;
332   }
333
334   @Override /* Overridden from HtmlElement */
335   public Script onended(String value) {
336      super.onended(value);
337      return this;
338   }
339
340   @Override /* Overridden from HtmlElement */
341   public Script onerror(String value) {
342      super.onerror(value);
343      return this;
344   }
345
346   @Override /* Overridden from HtmlElement */
347   public Script onfocus(String value) {
348      super.onfocus(value);
349      return this;
350   }
351
352   @Override /* Overridden from HtmlElement */
353   public Script oninput(String value) {
354      super.oninput(value);
355      return this;
356   }
357
358   @Override /* Overridden from HtmlElement */
359   public Script oninvalid(String value) {
360      super.oninvalid(value);
361      return this;
362   }
363
364   @Override /* Overridden from HtmlElement */
365   public Script onkeydown(String value) {
366      super.onkeydown(value);
367      return this;
368   }
369
370   @Override /* Overridden from HtmlElement */
371   public Script onkeypress(String value) {
372      super.onkeypress(value);
373      return this;
374   }
375
376   @Override /* Overridden from HtmlElement */
377   public Script onkeyup(String value) {
378      super.onkeyup(value);
379      return this;
380   }
381
382   @Override /* Overridden from HtmlElement */
383   public Script onload(String value) {
384      super.onload(value);
385      return this;
386   }
387
388   @Override /* Overridden from HtmlElement */
389   public Script onloadeddata(String value) {
390      super.onloadeddata(value);
391      return this;
392   }
393
394   @Override /* Overridden from HtmlElement */
395   public Script onloadedmetadata(String value) {
396      super.onloadedmetadata(value);
397      return this;
398   }
399
400   @Override /* Overridden from HtmlElement */
401   public Script onloadstart(String value) {
402      super.onloadstart(value);
403      return this;
404   }
405
406   @Override /* Overridden from HtmlElement */
407   public Script onmousedown(String value) {
408      super.onmousedown(value);
409      return this;
410   }
411
412   @Override /* Overridden from HtmlElement */
413   public Script onmouseenter(String value) {
414      super.onmouseenter(value);
415      return this;
416   }
417
418   @Override /* Overridden from HtmlElement */
419   public Script onmouseleave(String value) {
420      super.onmouseleave(value);
421      return this;
422   }
423
424   @Override /* Overridden from HtmlElement */
425   public Script onmousemove(String value) {
426      super.onmousemove(value);
427      return this;
428   }
429
430   @Override /* Overridden from HtmlElement */
431   public Script onmouseout(String value) {
432      super.onmouseout(value);
433      return this;
434   }
435
436   @Override /* Overridden from HtmlElement */
437   public Script onmouseover(String value) {
438      super.onmouseover(value);
439      return this;
440   }
441
442   @Override /* Overridden from HtmlElement */
443   public Script onmouseup(String value) {
444      super.onmouseup(value);
445      return this;
446   }
447
448   @Override /* Overridden from HtmlElement */
449   public Script onmousewheel(String value) {
450      super.onmousewheel(value);
451      return this;
452   }
453
454   @Override /* Overridden from HtmlElement */
455   public Script onpause(String value) {
456      super.onpause(value);
457      return this;
458   }
459
460   @Override /* Overridden from HtmlElement */
461   public Script onplay(String value) {
462      super.onplay(value);
463      return this;
464   }
465
466   @Override /* Overridden from HtmlElement */
467   public Script onplaying(String value) {
468      super.onplaying(value);
469      return this;
470   }
471
472   @Override /* Overridden from HtmlElement */
473   public Script onprogress(String value) {
474      super.onprogress(value);
475      return this;
476   }
477
478   @Override /* Overridden from HtmlElement */
479   public Script onratechange(String value) {
480      super.onratechange(value);
481      return this;
482   }
483
484   @Override /* Overridden from HtmlElement */
485   public Script onreset(String value) {
486      super.onreset(value);
487      return this;
488   }
489
490   @Override /* Overridden from HtmlElement */
491   public Script onresize(String value) {
492      super.onresize(value);
493      return this;
494   }
495
496   @Override /* Overridden from HtmlElement */
497   public Script onscroll(String value) {
498      super.onscroll(value);
499      return this;
500   }
501
502   @Override /* Overridden from HtmlElement */
503   public Script onseeked(String value) {
504      super.onseeked(value);
505      return this;
506   }
507
508   @Override /* Overridden from HtmlElement */
509   public Script onseeking(String value) {
510      super.onseeking(value);
511      return this;
512   }
513
514   @Override /* Overridden from HtmlElement */
515   public Script onselect(String value) {
516      super.onselect(value);
517      return this;
518   }
519
520   @Override /* Overridden from HtmlElement */
521   public Script onshow(String value) {
522      super.onshow(value);
523      return this;
524   }
525
526   @Override /* Overridden from HtmlElement */
527   public Script onstalled(String value) {
528      super.onstalled(value);
529      return this;
530   }
531
532   @Override /* Overridden from HtmlElement */
533   public Script onsubmit(String value) {
534      super.onsubmit(value);
535      return this;
536   }
537
538   @Override /* Overridden from HtmlElement */
539   public Script onsuspend(String value) {
540      super.onsuspend(value);
541      return this;
542   }
543
544   @Override /* Overridden from HtmlElement */
545   public Script ontimeupdate(String value) {
546      super.ontimeupdate(value);
547      return this;
548   }
549
550   @Override /* Overridden from HtmlElement */
551   public Script ontoggle(String value) {
552      super.ontoggle(value);
553      return this;
554   }
555
556   @Override /* Overridden from HtmlElement */
557   public Script onvolumechange(String value) {
558      super.onvolumechange(value);
559      return this;
560   }
561
562   @Override /* Overridden from HtmlElement */
563   public Script onwaiting(String value) {
564      super.onwaiting(value);
565      return this;
566   }
567
568   @Override /* Overridden from HtmlElement */
569   public Script spellcheck(Object value) {
570      super.spellcheck(value);
571      return this;
572   }
573
574   @Override /* Overridden from HtmlElement */
575   public Script style(String value) {
576      super.style(value);
577      return this;
578   }
579
580   @Override /* Overridden from HtmlElement */
581   public Script tabindex(Object value) {
582      super.tabindex(value);
583      return this;
584   }
585
586   @Override /* Overridden from HtmlElement */
587   public Script title(String value) {
588      super.title(value);
589      return this;
590   }
591
592   @Override /* Overridden from HtmlElement */
593   public Script translate(Object value) {
594      super.translate(value);
595      return this;
596   }
597
598   @Override /* Overridden from HtmlElementRawText */
599   public Script text(Object value) {
600      super.text(value);
601      return this;
602   }
603}