Package org.apache.juneau.bean.html5

Class Optgroup

java.lang.Object

org.apache.juneau.bean.html5.HtmlElement

org.apache.juneau.bean.html5.HtmlElementContainer

org.apache.juneau.bean.html5.Optgroup

@Bean(typeName="optgroup")
public class Optgroup
extends HtmlElementContainer

DTO for an HTML <optgroup> element.

The optgroup element represents a group of option elements within a select element. It provides a way to organize related options into logical groups, making it easier for users to find and select the desired option. The label attribute provides the group heading.

Examples:

import static org.apache.juneau.bean.html5.HtmlBuilder.*; // Simple option group Optgroup optgroup1 = optgroup("Fruits", option("apple", "Apple"), option("banana", "Banana"), option("orange", "Orange") ); // Disabled option group Optgroup optgroup2 = optgroup("Vegetables", option("carrot", "Carrot"), option("broccoli", "Broccoli") ).disabled(true); // Multiple option groups in a select Select select1 = select("food", optgroup("Fruits", option("apple", "Apple"), option("banana", "Banana") ), optgroup("Vegetables", option("carrot", "Carrot"), option("broccoli", "Broccoli") ) );

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

• HtmlBuilder
  • optgroup()
  • optgroup(Object, Object...)

See Also:

• juneau-bean-html5

Constructor Summary

Constructors

Constructor	Description
Optgroup()	Creates an empty Optgroup element.
Optgroup(Object... children)	Creates an Optgroup element with the specified child nodes.

Method Summary

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

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

getChild, getChild, getChild, getChildren, setChildren

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

Optgroup

public Optgroup()

Creates an empty Optgroup element.

Optgroup

public Optgroup(Object... children)

Creates an Optgroup element with the specified child nodes.

Parameters:

children - The child nodes.

Method Details

disabled

public Optgroup 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 Optgroup label(String value)

label attribute.

Specifies the user-visible label for the option group. This label is displayed in the select element to group related options together.

The label should be descriptive and help users understand the grouping of options.

Parameters:

label - The user-visible label for the option group.

Returns:

This object.

_class

public Optgroup _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 HtmlElementContainer

Returns:

This object.

accesskey

public Optgroup 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 HtmlElementContainer

Returns:

This object.

contenteditable

public Optgroup 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 HtmlElementContainer

Returns:

This object.

dir

public Optgroup 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 HtmlElementContainer

Returns:

This object.

hidden

public Optgroup 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 HtmlElementContainer

Returns:

This object.

id

public Optgroup 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 HtmlElementContainer

Returns:

This object.

lang

public Optgroup 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 HtmlElementContainer

Returns:

This object.

onabort

public Optgroup 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 HtmlElementContainer

Returns:

This object.

onblur

public Optgroup 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 HtmlElementContainer

Returns:

This object.

oncancel

public Optgroup oncancel(String value)

Description copied from class: HtmlElement

oncancel attribute.

Event handler for when a dialog is cancelled.

Overrides:

oncancel in class HtmlElementContainer

Returns:

This object.

oncanplay

public Optgroup 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 HtmlElementContainer

Returns:

This object.

oncanplaythrough

public Optgroup 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 HtmlElementContainer

Returns:

This object.

onchange

public Optgroup 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 HtmlElementContainer

Returns:

This object.

onclick

public Optgroup 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 HtmlElementContainer

Returns:

This object.

oncuechange

public Optgroup oncuechange(String value)

Description copied from class: HtmlElement

oncuechange attribute.

Event handler for when a text track cue changes.

Overrides:

oncuechange in class HtmlElementContainer

Returns:

This object.

ondblclick

public Optgroup ondblclick(String value)

Description copied from class: HtmlElement

ondblclick attribute.

Event handler for when the element is double-clicked.

Overrides:

ondblclick in class HtmlElementContainer

Returns:

This object.

ondurationchange

public Optgroup ondurationchange(String value)

Description copied from class: HtmlElement

ondurationchange attribute.

Event handler for when the duration of the media changes.

Overrides:

ondurationchange in class HtmlElementContainer

Returns:

This object.

onemptied

public Optgroup 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 HtmlElementContainer

Returns:

This object.

onended

public Optgroup onended(String value)

Description copied from class: HtmlElement

onended attribute.

Event handler for when the media playback reaches the end.

Overrides:

onended in class HtmlElementContainer

Returns:

This object.

onerror

public Optgroup 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 HtmlElementContainer

Returns:

This object.

onfocus

public Optgroup 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 HtmlElementContainer

Returns:

This object.

oninput

public Optgroup 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 HtmlElementContainer

Returns:

This object.

oninvalid

public Optgroup oninvalid(String value)

Description copied from class: HtmlElement

oninvalid attribute.

Event handler for when form validation fails.

Overrides:

oninvalid in class HtmlElementContainer

Returns:

This object.

onkeydown

public Optgroup onkeydown(String value)

Description copied from class: HtmlElement

onkeydown attribute.

Event handler for when a key is pressed down.

Overrides:

onkeydown in class HtmlElementContainer

Returns:

This object.

onkeypress

public Optgroup 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 HtmlElementContainer

Returns:

This object.

onkeyup

public Optgroup onkeyup(String value)

Description copied from class: HtmlElement

onkeyup attribute.

Event handler for when a key is released.

Overrides:

onkeyup in class HtmlElementContainer

Returns:

This object.

onload

public Optgroup 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 HtmlElementContainer

Returns:

This object.

onloadeddata

public Optgroup 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 HtmlElementContainer

Returns:

This object.

onloadedmetadata

public Optgroup 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 HtmlElementContainer

Returns:

This object.

onloadstart

public Optgroup onloadstart(String value)

Description copied from class: HtmlElement

onloadstart attribute.

Event handler for when the browser starts loading the media.

Overrides:

onloadstart in class HtmlElementContainer

Returns:

This object.

onmousedown

public Optgroup 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 HtmlElementContainer

Returns:

This object.

onmouseenter

public Optgroup 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 HtmlElementContainer

Returns:

This object.

onmouseleave

public Optgroup 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 HtmlElementContainer

Returns:

This object.

onmousemove

public Optgroup 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 HtmlElementContainer

Returns:

This object.

onmouseout

public Optgroup 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 HtmlElementContainer

Returns:

This object.

onmouseover

public Optgroup 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 HtmlElementContainer

Returns:

This object.

onmouseup

public Optgroup 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 HtmlElementContainer

Returns:

This object.

onmousewheel

public Optgroup 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 HtmlElementContainer

Returns:

This object.

onpause

public Optgroup onpause(String value)

Description copied from class: HtmlElement

onpause attribute.

Event handler for when media playback is paused.

Overrides:

onpause in class HtmlElementContainer

Returns:

This object.

onplay

public Optgroup onplay(String value)

Description copied from class: HtmlElement

onplay attribute.

Event handler for when media playback starts.

Overrides:

onplay in class HtmlElementContainer

Returns:

This object.

onplaying

public Optgroup 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 HtmlElementContainer

Returns:

This object.

onprogress

public Optgroup onprogress(String value)

Description copied from class: HtmlElement

onprogress attribute.

Event handler for when the browser is downloading media data.

Overrides:

onprogress in class HtmlElementContainer

Returns:

This object.

onratechange

public Optgroup onratechange(String value)

Description copied from class: HtmlElement

onratechange attribute.

Event handler for when the playback rate of media changes.

Overrides:

onratechange in class HtmlElementContainer

Returns:

This object.

onreset

public Optgroup onreset(String value)

Description copied from class: HtmlElement

onreset attribute.

Event handler for when a form is reset.

Overrides:

onreset in class HtmlElementContainer

Returns:

This object.

onresize

public Optgroup onresize(String value)

Description copied from class: HtmlElement

onresize attribute.

Event handler for when the element is resized.

Overrides:

onresize in class HtmlElementContainer

Returns:

This object.

onscroll

public Optgroup onscroll(String value)

Description copied from class: HtmlElement

onscroll attribute.

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

Overrides:

onscroll in class HtmlElementContainer

Returns:

This object.

onseeked

public Optgroup onseeked(String value)

Description copied from class: HtmlElement

onseeked attribute.

Event handler for when a seek operation completes.

Overrides:

onseeked in class HtmlElementContainer

Returns:

This object.

onseeking

public Optgroup onseeking(String value)

Description copied from class: HtmlElement

onseeking attribute.

Event handler for when a seek operation begins.

Overrides:

onseeking in class HtmlElementContainer

Returns:

This object.

onselect

public Optgroup onselect(String value)

Description copied from class: HtmlElement

onselect attribute.

Event handler for when text is selected in the element.

Overrides:

onselect in class HtmlElementContainer

Returns:

This object.

onshow

public Optgroup onshow(String value)

Description copied from class: HtmlElement

onshow attribute.

Event handler for when a context menu is shown.

Overrides:

onshow in class HtmlElementContainer

Returns:

This object.

onstalled

public Optgroup onstalled(String value)

Description copied from class: HtmlElement

onstalled attribute.

Event handler for when media loading is stalled.

Overrides:

onstalled in class HtmlElementContainer

Returns:

This object.

onsubmit

public Optgroup 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 HtmlElementContainer

Returns:

This object.

onsuspend

public Optgroup onsuspend(String value)

Description copied from class: HtmlElement

onsuspend attribute.

Event handler for when media loading is suspended.

Overrides:

onsuspend in class HtmlElementContainer

Returns:

This object.

ontimeupdate

public Optgroup ontimeupdate(String value)

Description copied from class: HtmlElement

ontimeupdate attribute.

Event handler for when the current playback position changes.

Overrides:

ontimeupdate in class HtmlElementContainer

Returns:

This object.

ontoggle

public Optgroup 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 HtmlElementContainer

Returns:

This object.

onvolumechange

public Optgroup onvolumechange(String value)

Description copied from class: HtmlElement

onvolumechange attribute.

Event handler for when the volume of media changes.

Overrides:

onvolumechange in class HtmlElementContainer

Returns:

This object.

onwaiting

public Optgroup 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 HtmlElementContainer

Returns:

This object.

spellcheck

public Optgroup 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 HtmlElementContainer

Returns:

This object.

style

public Optgroup 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 HtmlElementContainer

Returns:

This object.

tabindex

public Optgroup 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 HtmlElementContainer

Returns:

This object.

title

public Optgroup 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 HtmlElementContainer

Returns:

This object.

translate

public Optgroup 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 HtmlElementContainer

Returns:

This object.

child

public Optgroup child(Object value)

Description copied from class: HtmlElementContainer

Adds a child element to this element.

Overrides:

child in class HtmlElementContainer

Returns:

This object.

children

public Optgroup children(Object... value)

Description copied from class: HtmlElementContainer

Adds one or more child elements to this element.

Overrides:

children in class HtmlElementContainer

Returns:

This object.