Package org.apache.juneau.bean.html5

Class Param

java.lang.Object

org.apache.juneau.bean.html5.HtmlElement<SELF>

org.apache.juneau.bean.html5.HtmlElementVoid<Param>

org.apache.juneau.bean.html5.Param

@Marshalled(typeName="param")
public class Param
extends HtmlElementVoid<Param>

DTO for an HTML <param> element.

The param element defines parameters for an object element. It provides configuration data to the embedded content, such as Flash applications or other plugins. The name attribute specifies the parameter name, and the value attribute provides the parameter value.

Examples:

import static org.apache.juneau.bean.html5.HtmlBuilder.*; // Simple parameter Param param1 = param() .name("autoplay") .value("true"); // Parameter with constructor Param param2 = new Param("quality", "high"); // Parameters in an object Object_ object1 = object_() .data("video.swf") .type("application/x-shockwave-flash") .children( new Param("autoplay", "false"), new Param("loop", "true"), new Param("quality", "high") ); // Parameter with special characters Param param3 = param() .name("config") .value("width=800&height=600&theme=dark");

The following convenience methods are provided for constructing instances of this bean:

• HtmlBuilder
  • param()

See Also:

• juneau-bean-html5

Constructor Summary

Constructors

Constructor	Description
Param()	Creates an empty Param element.
Param(String name, Object value)	Creates a Param element with the specified name(String) and value(Object) attributes.

Method Summary

Modifier and Type	Method	Description
Param	name(String value)	name attribute.
Param	value(Object value)	value attribute.

Methods inherited from class org.apache.juneau.bean.html5.HtmlElement

accesskey, attr, attrUri, class_, contenteditable, deminimize, dir, getAttr, getAttr, getAttrs, hidden, id, lang, onabort, onblur, oncancel, oncanplay, oncanplaythrough, onchange, onclick, oncuechange, ondblclick, ondurationchange, onemptied, onended, onerror, onfocus, oninput, oninvalid, onkeydown, onkeypress, onkeyup, onload, onloadeddata, onloadedmetadata, onloadstart, onmousedown, onmouseenter, onmouseleave, onmousemove, onmouseout, onmouseover, onmouseup, onmousewheel, onpause, onplay, onplaying, onprogress, onratechange, onreset, onresize, onscroll, onseeked, onseeking, onselect, onshow, onstalled, onsubmit, onsuspend, ontimeupdate, ontoggle, onvolumechange, onwaiting, self, setAttrs, spellcheck, style, tabindex, title, toString, translate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Param

public Param()

Creates an empty Param element.

Param

public Param(String name,
 Object value)

Creates a Param element with the specified name(String) and value(Object) attributes.

Parameters:

name - The name(String) attribute. Can be null to unset the attribute.

value - The value(Object) attribute. Can be null to unset the attribute.

Method Details

name

public Param name(String value)

name attribute.

Specifies the name of the parameter. This name is used by the parent object element to identify the parameter and its associated value.

The name should be meaningful and correspond to the expected parameter name for the embedded content.

Parameters:

value - The name of the parameter. Can be null to unset the attribute.

Returns:

This object.

value

public Param value(Object value)

value attribute.

Value of parameter.

Parameters:

value - The new value for this attribute. Typically a Number or String. Can be null to unset the attribute.

Returns:

This object.