Package org.apache.juneau.bean.html5

Class Option

java.lang.Object

org.apache.juneau.bean.html5.HtmlElement

org.apache.juneau.bean.html5.HtmlElementText

org.apache.juneau.bean.html5.Option

@Bean(typeName="option")
public class Option
extends HtmlElementText

DTO for an HTML <option> element.

The option element represents an option in a select element or a suggestion in a datalist element. It defines a choice that users can select from a dropdown menu or autocomplete list. The value attribute specifies the value to be submitted, while the text content provides the display text.

Examples:

import static org.apache.juneau.bean.html5.HtmlBuilder.*; // Simple option Option option1 = option("red", "Red"); // Selected option Option option2 = option("blue", "Blue") .selected(true); // Disabled option Option option3 = option("gray", "Gray") .disabled(true); // Option with label Option option4 = option("green", "Green") .label("Green Color"); // Options in a select Select select1 = select("color", option("red", "Red"), option("green", "Green"), option("blue", "Blue") );

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

• HtmlBuilder
  • option()
  • option(Object, Object...)

See Also:

• juneau-bean-html5

Constructor Summary

Constructors

Constructor	Description
Option()	Creates an empty Option element.
Option(Object text)	Creates an Option element with the specified text(Object) attribute.
Option(Object value, Object text)	Creates an Option element with the specified value(Object) attribute and text(Object) node.

Method Summary

Modifier and Type	Method	Description
Option	_class(String value)	class attribute.
Option	accesskey(String value)	accesskey attribute.
Option	contenteditable(Object value)	contenteditable attribute.
Option	dir(String value)	dir attribute.
Option	disabled(Object value)	disabled attribute.
Option	hidden(Object value)	hidden attribute.
Option	id(String value)	id attribute.
Option	label(String value)	label attribute.
Option	lang(String value)	lang attribute.
Option	onabort(String value)	onabort attribute.
Option	onblur(String value)	onblur attribute.
Option	oncancel(String value)	oncancel attribute.
Option	oncanplay(String value)	oncanplay attribute.
Option	oncanplaythrough(String value)	oncanplaythrough attribute.
Option	onchange(String value)	onchange attribute.
Option	onclick(String value)	onclick attribute.
Option	oncuechange(String value)	oncuechange attribute.
Option	ondblclick(String value)	ondblclick attribute.
Option	ondurationchange(String value)	ondurationchange attribute.
Option	onemptied(String value)	onemptied attribute.
Option	onended(String value)	onended attribute.
Option	onerror(String value)	onerror attribute.
Option	onfocus(String value)	onfocus attribute.
Option	oninput(String value)	oninput attribute.
Option	oninvalid(String value)	oninvalid attribute.
Option	onkeydown(String value)	onkeydown attribute.
Option	onkeypress(String value)	onkeypress attribute.
Option	onkeyup(String value)	onkeyup attribute.
Option	onload(String value)	onload attribute.
Option	onloadeddata(String value)	onloadeddata attribute.
Option	onloadedmetadata(String value)	onloadedmetadata attribute.
Option	onloadstart(String value)	onloadstart attribute.
Option	onmousedown(String value)	onmousedown attribute.
Option	onmouseenter(String value)	onmouseenter attribute.
Option	onmouseleave(String value)	onmouseleave attribute.
Option	onmousemove(String value)	onmousemove attribute.
Option	onmouseout(String value)	onmouseout attribute.
Option	onmouseover(String value)	onmouseover attribute.
Option	onmouseup(String value)	onmouseup attribute.
Option	onmousewheel(String value)	onmousewheel attribute.
Option	onpause(String value)	onpause attribute.
Option	onplay(String value)	onplay attribute.
Option	onplaying(String value)	onplaying attribute.
Option	onprogress(String value)	onprogress attribute.
Option	onratechange(String value)	onratechange attribute.
Option	onreset(String value)	onreset attribute.
Option	onresize(String value)	onresize attribute.
Option	onscroll(String value)	onscroll attribute.
Option	onseeked(String value)	onseeked attribute.
Option	onseeking(String value)	onseeking attribute.
Option	onselect(String value)	onselect attribute.
Option	onshow(String value)	onshow attribute.
Option	onstalled(String value)	onstalled attribute.
Option	onsubmit(String value)	onsubmit attribute.
Option	onsuspend(String value)	onsuspend attribute.
Option	ontimeupdate(String value)	ontimeupdate attribute.
Option	ontoggle(String value)	ontoggle attribute.
Option	onvolumechange(String value)	onvolumechange attribute.
Option	onwaiting(String value)	onwaiting attribute.
Option	selected(Object value)	selected attribute.
Option	spellcheck(Object value)	spellcheck attribute.
Option	style(String value)	style attribute.
Option	tabindex(Object value)	tabindex attribute.
Option	text(Object value)	Sets the text node on this element.
Option	title(String value)	title attribute.
Option	translate(Object value)	translate attribute.
Option	value(Object value)	value attribute.

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

getText, setText

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

attr, attrUri, deminimize, getAttr, getAttr, getAttrs, setAttrs, toString

Methods inherited from class java.lang.Object

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

Constructor Details

Option

public Option()

Creates an empty Option element.

Option

public Option(Object text)

Creates an Option element with the specified text(Object) attribute.

Parameters:

text - The text(Object) attribute.

Option

public Option(Object value,
 Object text)

Creates an Option element with the specified value(Object) attribute and text(Object) node.

Parameters:

value - The value(Object) attribute.

text - The text(Object) node.

Method Details

disabled

public Option disabled(Object value)

disabled attribute.

Whether the form control is disabled.

This attribute uses deminimized values:

• false - Attribute is not added
• true - Attribute is added as "disabled"
• Other values - Passed through as-is

Parameters:

disabled - The new value for this attribute. Typically a Boolean or String.

Returns:

This object.

label

public Option label(String value)

label attribute.

Specifies the user-visible label for the option. This label is displayed in the select element and can be different from the option's value.

The label should be user-friendly and descriptive of what the option represents.

Parameters:

label - The user-visible label for the option.

Returns:

This object.

selected

public Option selected(Object value)

selected attribute.

Whether the option is selected by default.

This attribute uses deminimized values:

• false - Attribute is not added
• true - Attribute is added as "selected"
• Other values - Passed through as-is

Parameters:

selected - The new value for this attribute. Typically a Boolean or String.

Returns:

This object.

value

public Option value(Object value)

value attribute.

Value to be used for form submission.

Parameters:

value - The new value for this attribute. Typically a Number or String.

Returns:

This object.

_class

public Option _class(String value)

Description copied from class: HtmlElement

class 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:

_class in class HtmlElementText

Returns:

This object.

accesskey

public Option accesskey(String value)

Description copied from class: HtmlElement

accesskey 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:

accesskey in class HtmlElementText

Returns:

This object.

contenteditable

public Option contenteditable(Object value)

Description copied from class: HtmlElement

contenteditable 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:

contenteditable in class HtmlElementText

Returns:

This object.

dir

public Option dir(String value)

Description copied from class: HtmlElement

dir 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:

dir in class HtmlElementText

Returns:

This object.

hidden

public Option hidden(Object value)

Description copied from class: HtmlElement

hidden attribute.

This attribute uses deminimized values:

• false - Attribute is not added
• true - Attribute is added as "hidden"
• Other values - Passed through as-is

Overrides:

hidden in class HtmlElementText

Returns:

This object.

id

public Option id(String value)

Description copied from class: HtmlElement

id 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:

id in class HtmlElementText

Returns:

This object.

lang

public Option lang(String value)

Description copied from class: HtmlElement

lang 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:

lang in class HtmlElementText

Returns:

This object.

onabort

public Option onabort(String value)

Description copied from class: HtmlElement

onabort attribute.

Event handler for when an operation is aborted (e.g., image loading is cancelled).

Overrides:

onabort in class HtmlElementText

Returns:

This object.

onblur

public Option onblur(String value)

Description copied from class: HtmlElement

onblur 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:

onblur in class HtmlElementText

Returns:

This object.

oncancel

public Option oncancel(String value)

Description copied from class: HtmlElement

oncancel attribute.

Event handler for when a dialog is cancelled.

Overrides:

oncancel in class HtmlElementText

Returns:

This object.

oncanplay

public Option oncanplay(String value)

Description copied from class: HtmlElement

oncanplay attribute.

Event handler for when the media can start playing (enough data has been buffered).

Overrides:

oncanplay in class HtmlElementText

Returns:

This object.

oncanplaythrough

public Option oncanplaythrough(String value)

Description copied from class: HtmlElement

oncanplaythrough attribute.

Event handler for when the media can play through to the end without buffering.

Overrides:

oncanplaythrough in class HtmlElementText

Returns:

This object.

onchange

public Option onchange(String value)

Description copied from class: HtmlElement

onchange 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:

onchange in class HtmlElementText

Returns:

This object.

onclick

public Option onclick(String value)

Description copied from class: HtmlElement

onclick 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:

onclick in class HtmlElementText

Returns:

This object.

oncuechange

public Option oncuechange(String value)

Description copied from class: HtmlElement

oncuechange attribute.

Event handler for when a text track cue changes.

Overrides:

oncuechange in class HtmlElementText

Returns:

This object.

ondblclick

public Option ondblclick(String value)

Description copied from class: HtmlElement

ondblclick attribute.

Event handler for when the element is double-clicked.

Overrides:

ondblclick in class HtmlElementText

Returns:

This object.

ondurationchange

public Option ondurationchange(String value)

Description copied from class: HtmlElement

ondurationchange attribute.

Event handler for when the duration of the media changes.

Overrides:

ondurationchange in class HtmlElementText

Returns:

This object.

onemptied

public Option onemptied(String value)

Description copied from class: HtmlElement

onemptied attribute.

Event handler for when the media element becomes empty (e.g., network error).

Overrides:

onemptied in class HtmlElementText

Returns:

This object.

onended

public Option onended(String value)

Description copied from class: HtmlElement

onended attribute.

Event handler for when the media playback reaches the end.

Overrides:

onended in class HtmlElementText

Returns:

This object.

onerror

public Option onerror(String value)

Description copied from class: HtmlElement

onerror attribute.

Event handler for when an error occurs (e.g., failed resource loading).

Overrides:

onerror in class HtmlElementText

Returns:

This object.

onfocus

public Option onfocus(String value)

Description copied from class: HtmlElement

onfocus 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:

onfocus in class HtmlElementText

Returns:

This object.

oninput

public Option oninput(String value)

Description copied from class: HtmlElement

oninput attribute.

Event handler for when the value of an input element changes (fires on every keystroke).

Overrides:

oninput in class HtmlElementText

Returns:

This object.

oninvalid

public Option oninvalid(String value)

Description copied from class: HtmlElement

oninvalid attribute.

Event handler for when form validation fails.

Overrides:

oninvalid in class HtmlElementText

Returns:

This object.

onkeydown

public Option onkeydown(String value)

Description copied from class: HtmlElement

onkeydown attribute.

Event handler for when a key is pressed down.

Overrides:

onkeydown in class HtmlElementText

Returns:

This object.

onkeypress

public Option onkeypress(String value)

Description copied from class: HtmlElement

onkeypress attribute.

Event handler for when a key is pressed (deprecated, use onkeydown instead).

Overrides:

onkeypress in class HtmlElementText

Returns:

This object.

onkeyup

public Option onkeyup(String value)

Description copied from class: HtmlElement

onkeyup attribute.

Event handler for when a key is released.

Overrides:

onkeyup in class HtmlElementText

Returns:

This object.

onload

public Option onload(String value)

Description copied from class: HtmlElement

onload 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:

onload in class HtmlElementText

Returns:

This object.

onloadeddata

public Option onloadeddata(String value)

Description copied from class: HtmlElement

onloadeddata attribute.

Event handler for when the first frame of media has finished loading.

Overrides:

onloadeddata in class HtmlElementText

Returns:

This object.

onloadedmetadata

public Option onloadedmetadata(String value)

Description copied from class: HtmlElement

onloadedmetadata attribute.

Event handler for when metadata (duration, dimensions, etc.) has been loaded.

Overrides:

onloadedmetadata in class HtmlElementText

Returns:

This object.

onloadstart

public Option onloadstart(String value)

Description copied from class: HtmlElement

onloadstart attribute.

Event handler for when the browser starts loading the media.

Overrides:

onloadstart in class HtmlElementText

Returns:

This object.

onmousedown

public Option onmousedown(String value)

Description copied from class: HtmlElement

onmousedown attribute.

Event handler for when a mouse button is pressed down on the element.

Overrides:

onmousedown in class HtmlElementText

Returns:

This object.

onmouseenter

public Option onmouseenter(String value)

Description copied from class: HtmlElement

onmouseenter attribute.

Event handler for when the mouse pointer enters the element (does not bubble).

Overrides:

onmouseenter in class HtmlElementText

Returns:

This object.

onmouseleave

public Option onmouseleave(String value)

Description copied from class: HtmlElement

onmouseleave attribute.

Event handler for when the mouse pointer leaves the element (does not bubble).

Overrides:

onmouseleave in class HtmlElementText

Returns:

This object.

onmousemove

public Option onmousemove(String value)

Description copied from class: HtmlElement

onmousemove attribute.

Event handler for when the mouse pointer moves over the element.

Overrides:

onmousemove in class HtmlElementText

Returns:

This object.

onmouseout

public Option onmouseout(String value)

Description copied from class: HtmlElement

onmouseout attribute.

Event handler for when the mouse pointer moves out of the element (bubbles).

Overrides:

onmouseout in class HtmlElementText

Returns:

This object.

onmouseover

public Option onmouseover(String value)

Description copied from class: HtmlElement

onmouseover 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:

onmouseover in class HtmlElementText

Returns:

This object.

onmouseup

public Option onmouseup(String value)

Description copied from class: HtmlElement

onmouseup attribute.

Event handler for when a mouse button is released over the element.

Overrides:

onmouseup in class HtmlElementText

Returns:

This object.

onmousewheel

public Option onmousewheel(String value)

Description copied from class: HtmlElement

onmousewheel attribute.

Event handler for when the mouse wheel is rotated over the element (deprecated, use onwheel).

Overrides:

onmousewheel in class HtmlElementText

Returns:

This object.

onpause

public Option onpause(String value)

Description copied from class: HtmlElement

onpause attribute.

Event handler for when media playback is paused.

Overrides:

onpause in class HtmlElementText

Returns:

This object.

onplay

public Option onplay(String value)

Description copied from class: HtmlElement

onplay attribute.

Event handler for when media playback starts.

Overrides:

onplay in class HtmlElementText

Returns:

This object.

onplaying

public Option onplaying(String value)

Description copied from class: HtmlElement

onplaying attribute.

Event handler for when media playback starts after being paused or delayed.

Overrides:

onplaying in class HtmlElementText

Returns:

This object.

onprogress

public Option onprogress(String value)

Description copied from class: HtmlElement

onprogress attribute.

Event handler for when the browser is downloading media data.

Overrides:

onprogress in class HtmlElementText

Returns:

This object.

onratechange

public Option onratechange(String value)

Description copied from class: HtmlElement

onratechange attribute.

Event handler for when the playback rate of media changes.

Overrides:

onratechange in class HtmlElementText

Returns:

This object.

onreset

public Option onreset(String value)

Description copied from class: HtmlElement

onreset attribute.

Event handler for when a form is reset.

Overrides:

onreset in class HtmlElementText

Returns:

This object.

onresize

public Option onresize(String value)

Description copied from class: HtmlElement

onresize attribute.

Event handler for when the element is resized.

Overrides:

onresize in class HtmlElementText

Returns:

This object.

onscroll

public Option onscroll(String value)

Description copied from class: HtmlElement

onscroll attribute.

Event handler for when the element's scrollbar is scrolled.

Overrides:

onscroll in class HtmlElementText

Returns:

This object.

onseeked

public Option onseeked(String value)

Description copied from class: HtmlElement

onseeked attribute.

Event handler for when a seek operation completes.

Overrides:

onseeked in class HtmlElementText

Returns:

This object.

onseeking

public Option onseeking(String value)

Description copied from class: HtmlElement

onseeking attribute.

Event handler for when a seek operation begins.

Overrides:

onseeking in class HtmlElementText

Returns:

This object.

onselect

public Option onselect(String value)

Description copied from class: HtmlElement

onselect attribute.

Event handler for when text is selected in the element.

Overrides:

onselect in class HtmlElementText

Returns:

This object.

onshow

public Option onshow(String value)

Description copied from class: HtmlElement

onshow attribute.

Event handler for when a context menu is shown.

Overrides:

onshow in class HtmlElementText

Returns:

This object.

onstalled

public Option onstalled(String value)

Description copied from class: HtmlElement

onstalled attribute.

Event handler for when media loading is stalled.

Overrides:

onstalled in class HtmlElementText

Returns:

This object.

onsubmit

public Option onsubmit(String value)

Description copied from class: HtmlElement

onsubmit 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:

onsubmit in class HtmlElementText

Returns:

This object.

onsuspend

public Option onsuspend(String value)

Description copied from class: HtmlElement

onsuspend attribute.

Event handler for when media loading is suspended.

Overrides:

onsuspend in class HtmlElementText

Returns:

This object.

ontimeupdate

public Option ontimeupdate(String value)

Description copied from class: HtmlElement

ontimeupdate attribute.

Event handler for when the current playback position changes.

Overrides:

ontimeupdate in class HtmlElementText

Returns:

This object.

ontoggle

public Option ontoggle(String value)

Description copied from class: HtmlElement

ontoggle attribute.

Event handler for when a details element is opened or closed.

Overrides:

ontoggle in class HtmlElementText

Returns:

This object.

onvolumechange

public Option onvolumechange(String value)

Description copied from class: HtmlElement

onvolumechange attribute.

Event handler for when the volume of media changes.

Overrides:

onvolumechange in class HtmlElementText

Returns:

This object.

onwaiting

public Option onwaiting(String value)

Description copied from class: HtmlElement

onwaiting attribute.

Event handler for when media playback stops to buffer more data.

Overrides:

onwaiting in class HtmlElementText

Returns:

This object.

spellcheck

public Option spellcheck(Object value)

Description copied from class: HtmlElement

spellcheck 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:

spellcheck in class HtmlElementText

Returns:

This object.

style

public Option style(String value)

Description copied from class: HtmlElement

style attribute.

Specifies inline CSS styles for the element. The value should be valid CSS property-value pairs separated by semicolons.

Overrides:

style in class HtmlElementText

Returns:

This object.

tabindex

public Option tabindex(Object value)

Description copied from class: HtmlElement

tabindex 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:

tabindex in class HtmlElementText

Returns:

This object.

title

public Option title(String value)

Description copied from class: HtmlElement

title attribute.

Specifies additional information about the element, typically displayed as a tooltip when the user hovers over the element.

Overrides:

title in class HtmlElementText

Returns:

This object.

translate

public Option translate(Object value)

Description copied from class: HtmlElement

translate 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:

translate in class HtmlElementText

Returns:

This object.

text

public Option text(Object value)

Description copied from class: HtmlElementText

Sets the text node on this element.

Overrides:

text in class HtmlElementText

Returns:

This object.