Package org.apache.juneau.bean.html5

Class H1

java.lang.Object

org.apache.juneau.bean.html5.HtmlElement

org.apache.juneau.bean.html5.HtmlElementMixed

org.apache.juneau.bean.html5.H1

@Bean(typeName="h1")
public class H1
extends HtmlElementMixed

DTO for an HTML <h1> element.

The h1 element represents the highest level heading in a document or section. It is used to mark up the main title or most important heading on a page. The h1 element should be used only once per page and should describe the main topic or purpose of the page. It is typically rendered in the largest font size among all heading elements and is important for both accessibility and SEO.

Examples:

import static org.apache.juneau.bean.html5.HtmlBuilder.*; // Simple page title H1 simple = h1("Welcome to Our Website"); // H1 with styling H1 styled = h1("About Our Company") ._class("page-title"); // H1 with complex content H1 complex = h1( "Welcome to ", strong("Our Company"), " - ", em("Innovation at its finest") ); // H1 with ID H1 withId = h1("Product Documentation") .id("main-title"); // H1 with styling H1 styled2 = h1("User Guide") .style("color: #333; text-align: center; margin-bottom: 30px;"); // H1 with multiple elements H1 multiple = h1( "Chapter 1: ", span()._class("chapter-title").children("Getting Started"), " ", small("(Beginner Level)") ); // H1 with links H1 withLinks = h1( "Product: ", a("/products/widget", "Amazing Widget"), " v2.0" );

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

• HtmlBuilder
  • h1()
  • h1(Object, Object...)

See Also:

• juneau-bean-html5

Constructor Summary

Constructors

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

Method Summary

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

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

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

H1

public H1()

Creates an empty H1 element.

H1

public H1(Object... children)

Creates an H1 element with the specified child nodes.

Parameters:

children - The child nodes.

Method Details

_class

public H1 _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 HtmlElementMixed

Returns:

This object.

accesskey

public H1 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 HtmlElementMixed

Returns:

This object.

contenteditable

public H1 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 HtmlElementMixed

Returns:

This object.

dir

public H1 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 HtmlElementMixed

Returns:

This object.

hidden

public H1 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 HtmlElementMixed

Returns:

This object.

id

public H1 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 HtmlElementMixed

Returns:

This object.

lang

public H1 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 HtmlElementMixed

Returns:

This object.

onabort

public H1 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 HtmlElementMixed

Returns:

This object.

onblur

public H1 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 HtmlElementMixed

Returns:

This object.

oncancel

public H1 oncancel(String value)

Description copied from class: HtmlElement

oncancel attribute.

Event handler for when a dialog is cancelled.

Overrides:

oncancel in class HtmlElementMixed

Returns:

This object.

oncanplay

public H1 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 HtmlElementMixed

Returns:

This object.

oncanplaythrough

public H1 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 HtmlElementMixed

Returns:

This object.

onchange

public H1 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 HtmlElementMixed

Returns:

This object.

onclick

public H1 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 HtmlElementMixed

Returns:

This object.

oncuechange

public H1 oncuechange(String value)

Description copied from class: HtmlElement

oncuechange attribute.

Event handler for when a text track cue changes.

Overrides:

oncuechange in class HtmlElementMixed

Returns:

This object.

ondblclick

public H1 ondblclick(String value)

Description copied from class: HtmlElement

ondblclick attribute.

Event handler for when the element is double-clicked.

Overrides:

ondblclick in class HtmlElementMixed

Returns:

This object.

ondurationchange

public H1 ondurationchange(String value)

Description copied from class: HtmlElement

ondurationchange attribute.

Event handler for when the duration of the media changes.

Overrides:

ondurationchange in class HtmlElementMixed

Returns:

This object.

onemptied

public H1 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 HtmlElementMixed

Returns:

This object.

onended

public H1 onended(String value)

Description copied from class: HtmlElement

onended attribute.

Event handler for when the media playback reaches the end.

Overrides:

onended in class HtmlElementMixed

Returns:

This object.

onerror

public H1 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 HtmlElementMixed

Returns:

This object.

onfocus

public H1 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 HtmlElementMixed

Returns:

This object.

oninput

public H1 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 HtmlElementMixed

Returns:

This object.

oninvalid

public H1 oninvalid(String value)

Description copied from class: HtmlElement

oninvalid attribute.

Event handler for when form validation fails.

Overrides:

oninvalid in class HtmlElementMixed

Returns:

This object.

onkeydown

public H1 onkeydown(String value)

Description copied from class: HtmlElement

onkeydown attribute.

Event handler for when a key is pressed down.

Overrides:

onkeydown in class HtmlElementMixed

Returns:

This object.

onkeypress

public H1 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 HtmlElementMixed

Returns:

This object.

onkeyup

public H1 onkeyup(String value)

Description copied from class: HtmlElement

onkeyup attribute.

Event handler for when a key is released.

Overrides:

onkeyup in class HtmlElementMixed

Returns:

This object.

onload

public H1 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 HtmlElementMixed

Returns:

This object.

onloadeddata

public H1 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 HtmlElementMixed

Returns:

This object.

onloadedmetadata

public H1 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 HtmlElementMixed

Returns:

This object.

onloadstart

public H1 onloadstart(String value)

Description copied from class: HtmlElement

onloadstart attribute.

Event handler for when the browser starts loading the media.

Overrides:

onloadstart in class HtmlElementMixed

Returns:

This object.

onmousedown

public H1 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 HtmlElementMixed

Returns:

This object.

onmouseenter

public H1 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 HtmlElementMixed

Returns:

This object.

onmouseleave

public H1 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 HtmlElementMixed

Returns:

This object.

onmousemove

public H1 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 HtmlElementMixed

Returns:

This object.

onmouseout

public H1 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 HtmlElementMixed

Returns:

This object.

onmouseover

public H1 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 HtmlElementMixed

Returns:

This object.

onmouseup

public H1 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 HtmlElementMixed

Returns:

This object.

onmousewheel

public H1 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 HtmlElementMixed

Returns:

This object.

onpause

public H1 onpause(String value)

Description copied from class: HtmlElement

onpause attribute.

Event handler for when media playback is paused.

Overrides:

onpause in class HtmlElementMixed

Returns:

This object.

onplay

public H1 onplay(String value)

Description copied from class: HtmlElement

onplay attribute.

Event handler for when media playback starts.

Overrides:

onplay in class HtmlElementMixed

Returns:

This object.

onplaying

public H1 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 HtmlElementMixed

Returns:

This object.

onprogress

public H1 onprogress(String value)

Description copied from class: HtmlElement

onprogress attribute.

Event handler for when the browser is downloading media data.

Overrides:

onprogress in class HtmlElementMixed

Returns:

This object.

onratechange

public H1 onratechange(String value)

Description copied from class: HtmlElement

onratechange attribute.

Event handler for when the playback rate of media changes.

Overrides:

onratechange in class HtmlElementMixed

Returns:

This object.

onreset

public H1 onreset(String value)

Description copied from class: HtmlElement

onreset attribute.

Event handler for when a form is reset.

Overrides:

onreset in class HtmlElementMixed

Returns:

This object.

onresize

public H1 onresize(String value)

Description copied from class: HtmlElement

onresize attribute.

Event handler for when the element is resized.

Overrides:

onresize in class HtmlElementMixed

Returns:

This object.

onscroll

public H1 onscroll(String value)

Description copied from class: HtmlElement

onscroll attribute.

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

Overrides:

onscroll in class HtmlElementMixed

Returns:

This object.

onseeked

public H1 onseeked(String value)

Description copied from class: HtmlElement

onseeked attribute.

Event handler for when a seek operation completes.

Overrides:

onseeked in class HtmlElementMixed

Returns:

This object.

onseeking

public H1 onseeking(String value)

Description copied from class: HtmlElement

onseeking attribute.

Event handler for when a seek operation begins.

Overrides:

onseeking in class HtmlElementMixed

Returns:

This object.

onselect

public H1 onselect(String value)

Description copied from class: HtmlElement

onselect attribute.

Event handler for when text is selected in the element.

Overrides:

onselect in class HtmlElementMixed

Returns:

This object.

onshow

public H1 onshow(String value)

Description copied from class: HtmlElement

onshow attribute.

Event handler for when a context menu is shown.

Overrides:

onshow in class HtmlElementMixed

Returns:

This object.

onstalled

public H1 onstalled(String value)

Description copied from class: HtmlElement

onstalled attribute.

Event handler for when media loading is stalled.

Overrides:

onstalled in class HtmlElementMixed

Returns:

This object.

onsubmit

public H1 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 HtmlElementMixed

Returns:

This object.

onsuspend

public H1 onsuspend(String value)

Description copied from class: HtmlElement

onsuspend attribute.

Event handler for when media loading is suspended.

Overrides:

onsuspend in class HtmlElementMixed

Returns:

This object.

ontimeupdate

public H1 ontimeupdate(String value)

Description copied from class: HtmlElement

ontimeupdate attribute.

Event handler for when the current playback position changes.

Overrides:

ontimeupdate in class HtmlElementMixed

Returns:

This object.

ontoggle

public H1 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 HtmlElementMixed

Returns:

This object.

onvolumechange

public H1 onvolumechange(String value)

Description copied from class: HtmlElement

onvolumechange attribute.

Event handler for when the volume of media changes.

Overrides:

onvolumechange in class HtmlElementMixed

Returns:

This object.

onwaiting

public H1 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 HtmlElementMixed

Returns:

This object.

spellcheck

public H1 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 HtmlElementMixed

Returns:

This object.

style

public H1 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 HtmlElementMixed

Returns:

This object.

tabindex

public H1 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 HtmlElementMixed

Returns:

This object.

title

public H1 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 HtmlElementMixed

Returns:

This object.

translate

public H1 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 HtmlElementMixed

Returns:

This object.

child

public H1 child(Object value)

Description copied from class: HtmlElementMixed

Adds a child element to this element.

Overrides:

child in class HtmlElementMixed

Returns:

This object.

children

public H1 children(Object... value)

Description copied from class: HtmlElementMixed

Adds one or more child elements to this element.

Overrides:

children in class HtmlElementMixed

Returns:

This object.