Package org.apache.juneau.bean.html5

Class Option

java.lang.Object

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

org.apache.juneau.bean.html5.HtmlElementText<Option>

org.apache.juneau.bean.html5.Option

@Marshalled(typeName="option")
public class Option
extends HtmlElementText<Option>

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)

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 HtmlElementText.text(Object) attribute.
Option(Object value, Object text)	Creates an Option element with the specified value(Object) attribute and HtmlElementText.text(Object) node.

Method Summary

Modifier and Type	Method	Description
Option	disabled(Object value)	disabled attribute.
Option	label(String value)	label attribute.
Option	selected(Object value)	selected attribute.
Option	value(Object value)	value attribute.

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

getText, setText, text

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

Option

public Option()

Creates an empty Option element.

Option

public Option(Object text)

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

Parameters:

text - The HtmlElementText.text(Object) attribute. Can be null to leave the text unset.

Option

public Option(Object value,
 Object text)

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

Parameters:

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

text - The HtmlElementText.text(Object) node. Can be null to leave the text unset.

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:

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

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:

value - The user-visible label for the option. Can be null to unset the attribute.

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:

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

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. Can be null to unset the attribute.

Returns:

This object.