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