Class Param
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:
The following convenience methods are provided for constructing instances of this bean:
See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclass attribute.accesskey attribute.Adds an arbitrary attribute to this element.Adds an arbitrary URI attribute to this element.contenteditable(Object value) contenteditable attribute.dir attribute.hidden attribute.id attribute.lang attribute.name attribute.onabort attribute.onblur attribute.oncancel attribute.oncanplay attribute.oncanplaythrough(String value) oncanplaythrough attribute.onchange attribute.onclick attribute.oncuechange(String value) oncuechange attribute.ondblclick(String value) ondblclick attribute.ondurationchange(String value) ondurationchange attribute.onemptied attribute.onended attribute.onerror attribute.onfocus attribute.oninput attribute.oninvalid attribute.onkeydown attribute.onkeypress(String value) onkeypress attribute.onkeyup attribute.onload attribute.onloadeddata(String value) onloadeddata attribute.onloadedmetadata(String value) onloadedmetadata attribute.onloadstart(String value) onloadstart attribute.onmousedown(String value) onmousedown attribute.onmouseenter(String value) onmouseenter attribute.onmouseleave(String value) onmouseleave attribute.onmousemove(String value) onmousemove attribute.onmouseout(String value) onmouseout attribute.onmouseover(String value) onmouseover attribute.onmouseup attribute.onmousewheel(String value) onmousewheel attribute.onpause attribute.onplay attribute.onplaying attribute.onprogress(String value) onprogress attribute.onratechange(String value) onratechange attribute.onreset attribute.onresize attribute.onscroll attribute.onseeked attribute.onseeking attribute.onselect attribute.onshow attribute.onstalled attribute.onsubmit attribute.onsuspend attribute.ontimeupdate(String value) ontimeupdate attribute.ontoggle attribute.onvolumechange(String value) onvolumechange attribute.onwaiting attribute.spellcheck(Object value) spellcheck attribute.style attribute.tabindex attribute.title attribute.translate attribute.value attribute.Methods inherited from class org.apache.juneau.bean.html5.HtmlElement
deminimize, getAttr, getAttr, getAttrs, setAttrs, toString
-
Constructor Details
-
Param
public Param()Creates an emptyParamelement. -
Param
- Parameters:
name- Thename(String)attribute.value- Thevalue(Object)attribute.
-
-
Method Details
-
_class
Description copied from class:HtmlElementclass attribute.Specifies one or more CSS class names for the element, separated by spaces. These classes can be used for styling and JavaScript selection.
- Overrides:
_classin classHtmlElementVoid- Parameters:
value- Space-separated CSS class names (e.g.,"btn btn-primary" ).- Returns:
- This object.
-
accesskey
Description copied from class:HtmlElementaccesskey attribute.Defines a keyboard shortcut to activate or focus an element. The value should be a single character that, when pressed with a modifier key (usually Alt), activates the element.
- Overrides:
accesskeyin classHtmlElementVoid- Parameters:
value- The keyboard shortcut character (e.g.,"a" ,"1" ).- Returns:
- This object.
-
attr
Description copied from class:HtmlElementAdds an arbitrary attribute to this element.- Overrides:
attrin classHtmlElementVoid- Parameters:
key- The attribute name.val- The attribute value.- Returns:
- This object.
-
attrUri
Description copied from class:HtmlElementAdds an arbitrary URI attribute to this element.Same as
HtmlElement.attr(String, Object), except if the value is a string that appears to be a URI (e.g."servlet:/xxx" ).The value can be of any of the following types:
URI,URL,String. Strings must be valid URIs.URIs defined by
UriResolvercan be used for values.- Overrides:
attrUriin classHtmlElementVoid- Parameters:
key- The attribute name.val- The attribute value.- Returns:
- This object.
-
contenteditable
Description copied from class:HtmlElementcontenteditable attribute.Indicates whether the element's content is editable by the user.
Possible values:
"true" or empty string - Element content is editable"false" - Element content is not editable"plaintext-only" - Element content is editable, but rich text formatting is disabled
- Overrides:
contenteditablein classHtmlElementVoid- Parameters:
value- The editability state of the element.- Returns:
- This object.
-
dir
Description copied from class:HtmlElementdir attribute.Specifies the text direction of the element's content.
Possible values:
"ltr" - Left-to-right text direction"rtl" - Right-to-left text direction"auto" - Browser determines direction based on content
- Overrides:
dirin classHtmlElementVoid- Parameters:
value- The text direction for the element.- Returns:
- This object.
-
id
Description copied from class:HtmlElementid attribute.Specifies a unique identifier for the element. The ID must be unique within the document and can be used for CSS styling, JavaScript selection, and anchor links.
- Overrides:
idin classHtmlElementVoid- Parameters:
value- A unique identifier for the element (e.g.,"header" ,"main-content" ).- Returns:
- This object.
-
lang
Description copied from class:HtmlElementlang attribute.Specifies the primary language of the element's content using a language tag. This helps with accessibility, search engines, and browser features like spell checking.
- Overrides:
langin classHtmlElementVoid- Parameters:
value- A language tag (e.g.,"en" ,"en-US" ,"es" ,"fr-CA" ).- Returns:
- This object.
-
name
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.- Returns:
- This object.
-
onabort
Description copied from class:HtmlElementonabort attribute.Event handler for when an operation is aborted (e.g., image loading is cancelled).
- Overrides:
onabortin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the abort event occurs.- Returns:
- This object.
-
onblur
Description copied from class:HtmlElementonblur attribute.Event handler for when the element loses focus.
Note:
If your HTML serializer is configured to use single quotes for attribute values, you should use double quotes in your JavaScript code, and vice versa. Otherwise, the quotes will be converted to HTML entities. For example:
- If using single quotes for attributes:
onblur( "validate(\"email\")" ) - If using double quotes for attributes:
onblur( "validate('email')" )
- Overrides:
onblurin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the element loses focus.- Returns:
- This object.
- If using single quotes for attributes:
-
oncancel
Description copied from class:HtmlElementoncancel attribute.Event handler for when a dialog is cancelled.
- Overrides:
oncancelin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the cancel event occurs.- Returns:
- This object.
-
oncanplay
Description copied from class:HtmlElementoncanplay attribute.Event handler for when the media can start playing (enough data has been buffered).
- Overrides:
oncanplayin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the canplay event occurs.- Returns:
- This object.
-
oncanplaythrough
Description copied from class:HtmlElementoncanplaythrough attribute.Event handler for when the media can play through to the end without buffering.
- Overrides:
oncanplaythroughin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the canplaythrough event occurs.- Returns:
- This object.
-
onchange
Description copied from class:HtmlElementonchange attribute.Event handler for when the value of a form element changes and loses focus.
Note:
If your HTML serializer is configured to use single quotes for attribute values, you should use double quotes in your JavaScript code, and vice versa. Otherwise, the quotes will be converted to HTML entities. For example:
- If using single quotes for attributes:
onchange( "validate(\"field\")" ) - If using double quotes for attributes:
onchange( "validate('field')" )
- Overrides:
onchangein classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the change event occurs.- Returns:
- This object.
- If using single quotes for attributes:
-
onclick
Description copied from class:HtmlElementonclick attribute.Event handler for when the element is clicked.
Note:
If your HTML serializer is configured to use single quotes for attribute values, you should use double quotes in your JavaScript code, and vice versa. Otherwise, the quotes will be converted to HTML entities. For example:
- If using single quotes for attributes:
onclick( "alert(\"Hello\")" ) - If using double quotes for attributes:
onclick( "alert('Hello')" )
- Overrides:
onclickin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the click event occurs.- Returns:
- This object.
- If using single quotes for attributes:
-
oncuechange
Description copied from class:HtmlElementoncuechange attribute.Event handler for when a text track cue changes.
- Overrides:
oncuechangein classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the cuechange event occurs.- Returns:
- This object.
-
ondblclick
Description copied from class:HtmlElementondblclick attribute.Event handler for when the element is double-clicked.
- Overrides:
ondblclickin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the dblclick event occurs.- Returns:
- This object.
-
ondurationchange
Description copied from class:HtmlElementondurationchange attribute.Event handler for when the duration of the media changes.
- Overrides:
ondurationchangein classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the durationchange event occurs.- Returns:
- This object.
-
onemptied
Description copied from class:HtmlElementonemptied attribute.Event handler for when the media element becomes empty (e.g., network error).
- Overrides:
onemptiedin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the emptied event occurs.- Returns:
- This object.
-
onended
Description copied from class:HtmlElementonended attribute.Event handler for when the media playback reaches the end.
- Overrides:
onendedin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the ended event occurs.- Returns:
- This object.
-
onerror
Description copied from class:HtmlElementonerror attribute.Event handler for when an error occurs (e.g., failed resource loading).
- Overrides:
onerrorin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the error event occurs.- Returns:
- This object.
-
onfocus
Description copied from class:HtmlElementonfocus attribute.Event handler for when the element receives focus.
Note:
If your HTML serializer is configured to use single quotes for attribute values, you should use double quotes in your JavaScript code, and vice versa. Otherwise, the quotes will be converted to HTML entities. For example:
- If using single quotes for attributes:
onfocus( "highlight(\"field\")" ) - If using double quotes for attributes:
onfocus( "highlight('field')" )
- Overrides:
onfocusin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the focus event occurs.- Returns:
- This object.
- If using single quotes for attributes:
-
oninput
Description copied from class:HtmlElementoninput attribute.Event handler for when the value of an input element changes (fires on every keystroke).
- Overrides:
oninputin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the input event occurs.- Returns:
- This object.
-
oninvalid
Description copied from class:HtmlElementoninvalid attribute.Event handler for when form validation fails.
- Overrides:
oninvalidin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the invalid event occurs.- Returns:
- This object.
-
onkeydown
Description copied from class:HtmlElementonkeydown attribute.Event handler for when a key is pressed down.
- Overrides:
onkeydownin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the keydown event occurs.- Returns:
- This object.
-
onkeypress
Description copied from class:HtmlElementonkeypress attribute.Event handler for when a key is pressed (deprecated, use onkeydown instead).
- Overrides:
onkeypressin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the keypress event occurs.- Returns:
- This object.
-
onkeyup
Description copied from class:HtmlElementonkeyup attribute.Event handler for when a key is released.
- Overrides:
onkeyupin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the keyup event occurs.- Returns:
- This object.
-
onload
Description copied from class:HtmlElementonload attribute.Event handler for when the element and its resources have finished loading.
Note:
If your HTML serializer is configured to use single quotes for attribute values, you should use double quotes in your JavaScript code, and vice versa. Otherwise, the quotes will be converted to HTML entities. For example:
- If using single quotes for attributes:
onload( "init(\"config\")" ) - If using double quotes for attributes:
onload( "init('config')" )
- Overrides:
onloadin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the load event occurs.- Returns:
- This object.
- If using single quotes for attributes:
-
onloadeddata
Description copied from class:HtmlElementonloadeddata attribute.Event handler for when the first frame of media has finished loading.
- Overrides:
onloadeddatain classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the loadeddata event occurs.- Returns:
- This object.
-
onloadedmetadata
Description copied from class:HtmlElementonloadedmetadata attribute.Event handler for when metadata (duration, dimensions, etc.) has been loaded.
- Overrides:
onloadedmetadatain classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the loadedmetadata event occurs.- Returns:
- This object.
-
onloadstart
Description copied from class:HtmlElementonloadstart attribute.Event handler for when the browser starts loading the media.
- Overrides:
onloadstartin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the loadstart event occurs.- Returns:
- This object.
-
onmousedown
Description copied from class:HtmlElementonmousedown attribute.Event handler for when a mouse button is pressed down on the element.
- Overrides:
onmousedownin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the mousedown event occurs.- Returns:
- This object.
-
onmouseenter
Description copied from class:HtmlElementonmouseenter attribute.Event handler for when the mouse pointer enters the element (does not bubble).
- Overrides:
onmouseenterin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the mouseenter event occurs.- Returns:
- This object.
-
onmouseleave
Description copied from class:HtmlElementonmouseleave attribute.Event handler for when the mouse pointer leaves the element (does not bubble).
- Overrides:
onmouseleavein classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the mouseleave event occurs.- Returns:
- This object.
-
onmousemove
Description copied from class:HtmlElementonmousemove attribute.Event handler for when the mouse pointer moves over the element.
- Overrides:
onmousemovein classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the mousemove event occurs.- Returns:
- This object.
-
onmouseout
Description copied from class:HtmlElementonmouseout attribute.Event handler for when the mouse pointer moves out of the element (bubbles).
- Overrides:
onmouseoutin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the mouseout event occurs.- Returns:
- This object.
-
onmouseover
Description copied from class:HtmlElementonmouseover attribute.Event handler for when the mouse pointer moves over the element (bubbles).
Note:
If your HTML serializer is configured to use single quotes for attribute values, you should use double quotes in your JavaScript code, and vice versa. Otherwise, the quotes will be converted to HTML entities. For example:
- If using single quotes for attributes:
onmouseover( "showTooltip(\"info\")" ) - If using double quotes for attributes:
onmouseover( "showTooltip('info')" )
- Overrides:
onmouseoverin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the mouseover event occurs.- Returns:
- This object.
- If using single quotes for attributes:
-
onmouseup
Description copied from class:HtmlElementonmouseup attribute.Event handler for when a mouse button is released over the element.
- Overrides:
onmouseupin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the mouseup event occurs.- Returns:
- This object.
-
onmousewheel
Description copied from class:HtmlElementonmousewheel attribute.Event handler for when the mouse wheel is rotated over the element (deprecated, use onwheel).
- Overrides:
onmousewheelin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the mousewheel event occurs.- Returns:
- This object.
-
onpause
Description copied from class:HtmlElementonpause attribute.Event handler for when media playback is paused.
- Overrides:
onpausein classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the pause event occurs.- Returns:
- This object.
-
onplay
Description copied from class:HtmlElementonplay attribute.Event handler for when media playback starts.
- Overrides:
onplayin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the play event occurs.- Returns:
- This object.
-
onplaying
Description copied from class:HtmlElementonplaying attribute.Event handler for when media playback starts after being paused or delayed.
- Overrides:
onplayingin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the playing event occurs.- Returns:
- This object.
-
onprogress
Description copied from class:HtmlElementonprogress attribute.Event handler for when the browser is downloading media data.
- Overrides:
onprogressin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the progress event occurs.- Returns:
- This object.
-
onratechange
Description copied from class:HtmlElementonratechange attribute.Event handler for when the playback rate of media changes.
- Overrides:
onratechangein classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the ratechange event occurs.- Returns:
- This object.
-
onreset
Description copied from class:HtmlElementonreset attribute.Event handler for when a form is reset.
- Overrides:
onresetin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the reset event occurs.- Returns:
- This object.
-
onresize
Description copied from class:HtmlElementonresize attribute.Event handler for when the element is resized.
- Overrides:
onresizein classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the resize event occurs.- Returns:
- This object.
-
onscroll
Description copied from class:HtmlElementonscroll attribute.Event handler for when the element's scrollbar is scrolled.
- Overrides:
onscrollin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the scroll event occurs.- Returns:
- This object.
-
onseeked
Description copied from class:HtmlElementonseeked attribute.Event handler for when a seek operation completes.
- Overrides:
onseekedin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the seeked event occurs.- Returns:
- This object.
-
onseeking
Description copied from class:HtmlElementonseeking attribute.Event handler for when a seek operation begins.
- Overrides:
onseekingin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the seeking event occurs.- Returns:
- This object.
-
onselect
Description copied from class:HtmlElementonselect attribute.Event handler for when text is selected in the element.
- Overrides:
onselectin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the select event occurs.- Returns:
- This object.
-
onshow
Description copied from class:HtmlElementonshow attribute.Event handler for when a context menu is shown.
- Overrides:
onshowin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the show event occurs.- Returns:
- This object.
-
onstalled
Description copied from class:HtmlElementonstalled attribute.Event handler for when media loading is stalled.
- Overrides:
onstalledin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the stalled event occurs.- Returns:
- This object.
-
onsubmit
Description copied from class:HtmlElementonsubmit attribute.Event handler for when a form is submitted.
Note:
If your HTML serializer is configured to use single quotes for attribute values, you should use double quotes in your JavaScript code, and vice versa. Otherwise, the quotes will be converted to HTML entities. For example:
- If using single quotes for attributes:
onsubmit( "return validate(\"form\")" ) - If using double quotes for attributes:
onsubmit( "return validate('form')" )
- Overrides:
onsubmitin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the submit event occurs.- Returns:
- This object.
- If using single quotes for attributes:
-
onsuspend
Description copied from class:HtmlElementonsuspend attribute.Event handler for when media loading is suspended.
- Overrides:
onsuspendin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the suspend event occurs.- Returns:
- This object.
-
ontimeupdate
Description copied from class:HtmlElementontimeupdate attribute.Event handler for when the current playback position changes.
- Overrides:
ontimeupdatein classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the timeupdate event occurs.- Returns:
- This object.
-
ontoggle
Description copied from class:HtmlElementontoggle attribute.Event handler for when a details element is opened or closed.
- Overrides:
ontogglein classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the toggle event occurs.- Returns:
- This object.
-
onvolumechange
Description copied from class:HtmlElementonvolumechange attribute.Event handler for when the volume of media changes.
- Overrides:
onvolumechangein classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the volumechange event occurs.- Returns:
- This object.
-
onwaiting
Description copied from class:HtmlElementonwaiting attribute.Event handler for when media playback stops to buffer more data.
- Overrides:
onwaitingin classHtmlElementVoid- Parameters:
value- JavaScript code to execute when the waiting event occurs.- Returns:
- This object.
-
spellcheck
Description copied from class:HtmlElementspellcheck attribute.Indicates whether the element should have its spelling and grammar checked.
Possible values:
"true" - Enable spell checking for this element"false" - Disable spell checking for this element
- Overrides:
spellcheckin classHtmlElementVoid- Parameters:
value- Whether spell checking should be enabled.- Returns:
- This object.
-
style
Description copied from class:HtmlElementstyle attribute.Specifies inline CSS styles for the element. The value should be valid CSS property-value pairs separated by semicolons.
- Overrides:
stylein classHtmlElementVoid- Parameters:
value- Inline CSS styles (e.g.,"color: red; font-size: 14px;" ).- Returns:
- This object.
-
tabindex
Description copied from class:HtmlElementtabindex attribute.Specifies the tab order of the element when navigating with the keyboard.
Possible values:
- Positive integer - Element is focusable and participates in tab order
"0" - Element is focusable but not in tab order- Negative integer - Element is not focusable
- Overrides:
tabindexin classHtmlElementVoid- Parameters:
value- The tab order value for keyboard navigation.- Returns:
- This object.
-
title
Description copied from class:HtmlElementtitle attribute.Specifies additional information about the element, typically displayed as a tooltip when the user hovers over the element.
- Overrides:
titlein classHtmlElementVoid- Parameters:
value- Tooltip text to display on hover (e.g.,"Click to submit form" ).- Returns:
- This object.
-
translate
Description copied from class:HtmlElementtranslate attribute.Specifies whether the element's content should be translated when the page is localized.
Possible values:
"yes" - Content should be translated (default)"no" - Content should not be translated
- Overrides:
translatein classHtmlElementVoid- Parameters:
value- Whether the element content should be translated.- Returns:
- This object.
-
value
value attribute.Value of parameter.
-