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.internal.*;
024
025/**
026 * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#the-source-element">&lt;source&gt;</a>
027 * element.
028 *
029 * <p>
030 * The source element specifies multiple media resources for media elements like audio and video.
031 * It allows browsers to choose the most appropriate source based on format support, bandwidth,
032 * and other factors. The source element is used inside audio and video elements to provide
033 * fallback options for different media formats.
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>// Video with multiple sources</jc>
040 *    Video <jv>video</jv> = <jsm>video</jsm>()
041 *       .controls(<jk>true</jk>)
042 *       .children(
043 *          <jsm>source</jsm>().src(<js>"movie.mp4"</js>).type(<js>"video/mp4"</js>),
044 *          <jsm>source</jsm>().src(<js>"movie.webm"</js>).type(<js>"video/webm"</js>),
045 *          <jsm>source</jsm>().src(<js>"movie.ogg"</js>).type(<js>"video/ogg"</js>)
046 *       );
047 * 
048 *    <jc>// Audio with multiple sources</jc>
049 *    Audio <jv>audio</jv> = <jsm>audio</jsm>()
050 *       .controls(<jk>true</jk>)
051 *       .children(
052 *          <jsm>source</jsm>().src(<js>"sound.mp3"</js>).type(<js>"audio/mpeg"</js>),
053 *          <jsm>source</jsm>().src(<js>"sound.ogg"</js>).type(<js>"audio/ogg"</js>),
054 *          <jsm>source</jsm>().src(<js>"sound.wav"</js>).type(<js>"audio/wav"</js>)
055 *       );
056 * 
057 *    <jc>// Picture with multiple sources</jc>
058 *    Picture <jv>picture</jv> = <jsm>picture</jsm>(
059 *       <jsm>source</jsm>().src(<js>"image.webp"</js>).type(<js>"image/webp"</js>),
060 *       <jsm>source</jsm>().src(<js>"image.jpg"</js>).type(<js>"image/jpeg"</js>)
061 *    );
062 * 
063 *    <jc>// Source with media query</jc>
064 *    Source <jv>responsive</jv> = <jsm>source</jsm>()
065 *       .src(<js>"large-image.jpg"</js>)
066 *       .media(<js>"(min-width: 800px)"</js>)
067 *       .type(<js>"image/jpeg"</js>);
068 * </p>
069 *
070 * <p>
071 * The following convenience methods are provided for constructing instances of this bean:
072 * <ul class='javatree'>
073 *    <li class='jc'>{@link HtmlBuilder}
074 *    <ul class='javatree'>
075 *       <li class='jm'>{@link HtmlBuilder#source() source()}
076 *    </ul>
077 * </ul>
078 * </p>
079 *
080 * <h5 class='section'>See Also:</h5><ul>
081 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauBeanHtml5">juneau-bean-html5</a>
082 * </ul>
083 */
084@Bean(typeName="source")
085public class Source extends HtmlElementVoid {
086
087   /**
088    * Creates an empty {@link Source} element.
089    */
090   public Source() {}
091
092   /**
093    * Creates a {@link Source} element with the specified {@link Source#src(Object)} and {@link Source#type(String)}
094    * attributes.
095    *
096    * @param src The {@link Source#src(Object)} attribute.
097    * @param type The {@link Source#type(String)} attribute.
098    */
099   public Source(Object src, String type) {
100      src(src).type(type);
101   }
102
103   /**
104    * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-source-src">src</a> attribute.
105    *
106    * <p>
107    * Address of the resource.
108    *
109    * <p>
110    * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
111    * Strings must be valid URIs.
112    *
113    * <p>
114    * URIs defined by {@link UriResolver} can be used for values.
115    *
116    * @param src
117    *    The new value for this attribute.
118    *    Typically a {@link URL} or {@link String}.
119    * @return This object.
120    */
121   public Source src(Object value) {
122      attrUri("src", value);
123      return this;
124   }
125
126   /**
127    * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-source-type">type</a> attribute.
128    *
129    * <p>
130    * Specifies the MIME type of the media resource. Helps browsers determine if they can play the media
131    * and which source to use when multiple sources are provided.
132    *
133    * <p>
134    * Common values:
135    * <ul>
136    *    <li><js>"video/mp4"</js> - MP4 video</li>
137    *    <li><js>"video/webm"</js> - WebM video</li>
138    *    <li><js>"audio/mp3"</js> - MP3 audio</li>
139    *    <li><js>"audio/ogg"</js> - OGG audio</li>
140    *    <li><js>"audio/wav"</js> - WAV audio</li>
141    * </ul>
142    *
143    * @param type The MIME type of the media resource.
144    * @return This object.
145    */
146   public Source type(String value) {
147      attr("type", value);
148      return this;
149   }
150
151   //-----------------------------------------------------------------------------------------------------------------
152   // Overridden methods
153   //-----------------------------------------------------------------------------------------------------------------
154   @Override /* Overridden from HtmlElement */
155   public Source _class(String value) {  // NOSONAR - Intentional naming.
156      super._class(value);
157      return this;
158   }
159
160   @Override /* Overridden from HtmlElement */
161   public Source accesskey(String value) {
162      super.accesskey(value);
163      return this;
164   }
165
166   @Override /* Overridden from HtmlElement */
167   public Source contenteditable(Object value) {
168      super.contenteditable(value);
169      return this;
170   }
171
172   @Override /* Overridden from HtmlElement */
173   public Source dir(String value) {
174      super.dir(value);
175      return this;
176   }
177
178   @Override /* Overridden from HtmlElement */
179   public Source hidden(Object value) {
180      super.hidden(value);
181      return this;
182   }
183
184   @Override /* Overridden from HtmlElement */
185   public Source id(String value) {
186      super.id(value);
187      return this;
188   }
189
190   @Override /* Overridden from HtmlElement */
191   public Source lang(String value) {
192      super.lang(value);
193      return this;
194   }
195
196   @Override /* Overridden from HtmlElement */
197   public Source onabort(String value) {
198      super.onabort(value);
199      return this;
200   }
201
202   @Override /* Overridden from HtmlElement */
203   public Source onblur(String value) {
204      super.onblur(value);
205      return this;
206   }
207
208   @Override /* Overridden from HtmlElement */
209   public Source oncancel(String value) {
210      super.oncancel(value);
211      return this;
212   }
213
214   @Override /* Overridden from HtmlElement */
215   public Source oncanplay(String value) {
216      super.oncanplay(value);
217      return this;
218   }
219
220   @Override /* Overridden from HtmlElement */
221   public Source oncanplaythrough(String value) {
222      super.oncanplaythrough(value);
223      return this;
224   }
225
226   @Override /* Overridden from HtmlElement */
227   public Source onchange(String value) {
228      super.onchange(value);
229      return this;
230   }
231
232   @Override /* Overridden from HtmlElement */
233   public Source onclick(String value) {
234      super.onclick(value);
235      return this;
236   }
237
238   @Override /* Overridden from HtmlElement */
239   public Source oncuechange(String value) {
240      super.oncuechange(value);
241      return this;
242   }
243
244   @Override /* Overridden from HtmlElement */
245   public Source ondblclick(String value) {
246      super.ondblclick(value);
247      return this;
248   }
249
250   @Override /* Overridden from HtmlElement */
251   public Source ondurationchange(String value) {
252      super.ondurationchange(value);
253      return this;
254   }
255
256   @Override /* Overridden from HtmlElement */
257   public Source onemptied(String value) {
258      super.onemptied(value);
259      return this;
260   }
261
262   @Override /* Overridden from HtmlElement */
263   public Source onended(String value) {
264      super.onended(value);
265      return this;
266   }
267
268   @Override /* Overridden from HtmlElement */
269   public Source onerror(String value) {
270      super.onerror(value);
271      return this;
272   }
273
274   @Override /* Overridden from HtmlElement */
275   public Source onfocus(String value) {
276      super.onfocus(value);
277      return this;
278   }
279
280   @Override /* Overridden from HtmlElement */
281   public Source oninput(String value) {
282      super.oninput(value);
283      return this;
284   }
285
286   @Override /* Overridden from HtmlElement */
287   public Source oninvalid(String value) {
288      super.oninvalid(value);
289      return this;
290   }
291
292   @Override /* Overridden from HtmlElement */
293   public Source onkeydown(String value) {
294      super.onkeydown(value);
295      return this;
296   }
297
298   @Override /* Overridden from HtmlElement */
299   public Source onkeypress(String value) {
300      super.onkeypress(value);
301      return this;
302   }
303
304   @Override /* Overridden from HtmlElement */
305   public Source onkeyup(String value) {
306      super.onkeyup(value);
307      return this;
308   }
309
310   @Override /* Overridden from HtmlElement */
311   public Source onload(String value) {
312      super.onload(value);
313      return this;
314   }
315
316   @Override /* Overridden from HtmlElement */
317   public Source onloadeddata(String value) {
318      super.onloadeddata(value);
319      return this;
320   }
321
322   @Override /* Overridden from HtmlElement */
323   public Source onloadedmetadata(String value) {
324      super.onloadedmetadata(value);
325      return this;
326   }
327
328   @Override /* Overridden from HtmlElement */
329   public Source onloadstart(String value) {
330      super.onloadstart(value);
331      return this;
332   }
333
334   @Override /* Overridden from HtmlElement */
335   public Source onmousedown(String value) {
336      super.onmousedown(value);
337      return this;
338   }
339
340   @Override /* Overridden from HtmlElement */
341   public Source onmouseenter(String value) {
342      super.onmouseenter(value);
343      return this;
344   }
345
346   @Override /* Overridden from HtmlElement */
347   public Source onmouseleave(String value) {
348      super.onmouseleave(value);
349      return this;
350   }
351
352   @Override /* Overridden from HtmlElement */
353   public Source onmousemove(String value) {
354      super.onmousemove(value);
355      return this;
356   }
357
358   @Override /* Overridden from HtmlElement */
359   public Source onmouseout(String value) {
360      super.onmouseout(value);
361      return this;
362   }
363
364   @Override /* Overridden from HtmlElement */
365   public Source onmouseover(String value) {
366      super.onmouseover(value);
367      return this;
368   }
369
370   @Override /* Overridden from HtmlElement */
371   public Source onmouseup(String value) {
372      super.onmouseup(value);
373      return this;
374   }
375
376   @Override /* Overridden from HtmlElement */
377   public Source onmousewheel(String value) {
378      super.onmousewheel(value);
379      return this;
380   }
381
382   @Override /* Overridden from HtmlElement */
383   public Source onpause(String value) {
384      super.onpause(value);
385      return this;
386   }
387
388   @Override /* Overridden from HtmlElement */
389   public Source onplay(String value) {
390      super.onplay(value);
391      return this;
392   }
393
394   @Override /* Overridden from HtmlElement */
395   public Source onplaying(String value) {
396      super.onplaying(value);
397      return this;
398   }
399
400   @Override /* Overridden from HtmlElement */
401   public Source onprogress(String value) {
402      super.onprogress(value);
403      return this;
404   }
405
406   @Override /* Overridden from HtmlElement */
407   public Source onratechange(String value) {
408      super.onratechange(value);
409      return this;
410   }
411
412   @Override /* Overridden from HtmlElement */
413   public Source onreset(String value) {
414      super.onreset(value);
415      return this;
416   }
417
418   @Override /* Overridden from HtmlElement */
419   public Source onresize(String value) {
420      super.onresize(value);
421      return this;
422   }
423
424   @Override /* Overridden from HtmlElement */
425   public Source onscroll(String value) {
426      super.onscroll(value);
427      return this;
428   }
429
430   @Override /* Overridden from HtmlElement */
431   public Source onseeked(String value) {
432      super.onseeked(value);
433      return this;
434   }
435
436   @Override /* Overridden from HtmlElement */
437   public Source onseeking(String value) {
438      super.onseeking(value);
439      return this;
440   }
441
442   @Override /* Overridden from HtmlElement */
443   public Source onselect(String value) {
444      super.onselect(value);
445      return this;
446   }
447
448   @Override /* Overridden from HtmlElement */
449   public Source onshow(String value) {
450      super.onshow(value);
451      return this;
452   }
453
454   @Override /* Overridden from HtmlElement */
455   public Source onstalled(String value) {
456      super.onstalled(value);
457      return this;
458   }
459
460   @Override /* Overridden from HtmlElement */
461   public Source onsubmit(String value) {
462      super.onsubmit(value);
463      return this;
464   }
465
466   @Override /* Overridden from HtmlElement */
467   public Source onsuspend(String value) {
468      super.onsuspend(value);
469      return this;
470   }
471
472   @Override /* Overridden from HtmlElement */
473   public Source ontimeupdate(String value) {
474      super.ontimeupdate(value);
475      return this;
476   }
477
478   @Override /* Overridden from HtmlElement */
479   public Source ontoggle(String value) {
480      super.ontoggle(value);
481      return this;
482   }
483
484   @Override /* Overridden from HtmlElement */
485   public Source onvolumechange(String value) {
486      super.onvolumechange(value);
487      return this;
488   }
489
490   @Override /* Overridden from HtmlElement */
491   public Source onwaiting(String value) {
492      super.onwaiting(value);
493      return this;
494   }
495
496   @Override /* Overridden from HtmlElement */
497   public Source spellcheck(Object value) {
498      super.spellcheck(value);
499      return this;
500   }
501
502   @Override /* Overridden from HtmlElement */
503   public Source style(String value) {
504      super.style(value);
505      return this;
506   }
507
508   @Override /* Overridden from HtmlElement */
509   public Source tabindex(Object value) {
510      super.tabindex(value);
511      return this;
512   }
513
514   @Override /* Overridden from HtmlElement */
515   public Source title(String value) {
516      super.title(value);
517      return this;
518   }
519
520   @Override /* Overridden from HtmlElement */
521   public Source translate(Object value) {
522      super.translate(value);
523      return this;
524   }
525}