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