Class Hyperlink
Examples:
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.Adds a child element to this element.Adds one or more child elements to this element.contenteditable(Object value) contenteditable attribute.static HyperlinkStatic creator.dir attribute.download attribute.hidden attribute.href attribute.hreflang attribute.id attribute.lang 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.rel attribute.spellcheck(Object value) spellcheck attribute.style attribute.tabindex attribute.target attribute.title attribute.translate attribute.type attribute.Methods inherited from class org.apache.juneau.bean.html5.HtmlElementMixed
getChild, getChild, getChild, getChildren, setChildrenMethods inherited from class org.apache.juneau.bean.html5.HtmlElement
deminimize, getAttr, getAttr, getAttrs, setAttrs, toString
-
Constructor Details
-
Hyperlink
public Hyperlink()Creates an emptyAelement. -
Hyperlink
- Parameters:
href- TheA.href(Object)attribute.children- TheA.children(Object[])nodes.
-
-
Method Details
-
create
Static creator.- Parameters:
href- TheA.href(Object)attribute.children- TheA.children(Object[])nodes.- Returns:
- A new
Hyperlinkobject.
-
_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.
-
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.
-
attr
Description copied from class:HtmlElementAdds an arbitrary attribute to this element. -
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. -
child
Description copied from class:HtmlElementMixedAdds a child element to this element.- Overrides:
childin classA- Parameters:
value- The child to add as a child element. Can be a string orHtmlElement. Can also be a container of strings and elements.- Returns:
- This object.
-
children
Description copied from class:HtmlElementMixedAdds one or more child elements to this element.- Overrides:
childrenin classA- Parameters:
value- The children to add as child elements. Can be a mixture of strings andHtmlElementobjects. Can also be containers of strings and elements.- 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 classA- 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
-
download
Description copied from class:Adownload attribute.Whether to download the resource instead of navigating to it, and its file name if so.
-
href
Description copied from class:Ahref attribute.Address of the hyperlink.
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. -
hreflang
Description copied from class:Ahreflang attribute.Specifies the language of the linked resource. Used for SEO and accessibility purposes.
Examples:
"en" - English"es" - Spanish"fr" - French"de" - German"zh" - Chinese"ja" - Japanese
-
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.
-
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.
-
onabort
Description copied from class:HtmlElementonabort attribute.Event handler for when an operation is aborted (e.g., image loading is cancelled).
-
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')" )
- If using single quotes for attributes:
-
oncancel
Description copied from class:HtmlElementoncancel attribute.Event handler for when a dialog is cancelled.
-
oncanplay
Description copied from class:HtmlElementoncanplay attribute.Event handler for when the media can start playing (enough data has been buffered).
-
oncanplaythrough
Description copied from class:HtmlElementoncanplaythrough attribute.Event handler for when the media can play through to the end without buffering.
- Overrides:
oncanplaythroughin classA- 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')" )
- 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')" )
- If using single quotes for attributes:
-
oncuechange
Description copied from class:HtmlElementoncuechange attribute.Event handler for when a text track cue changes.
- Overrides:
oncuechangein classA- 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 classA- 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 classA- 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).
-
onended
Description copied from class:HtmlElementonended attribute.Event handler for when the media playback reaches the end.
-
onerror
Description copied from class:HtmlElementonerror attribute.Event handler for when an error occurs (e.g., failed resource loading).
-
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')" )
- 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).
-
oninvalid
Description copied from class:HtmlElementoninvalid attribute.Event handler for when form validation fails.
-
onkeydown
Description copied from class:HtmlElementonkeydown attribute.Event handler for when a key is pressed down.
-
onkeypress
Description copied from class:HtmlElementonkeypress attribute.Event handler for when a key is pressed (deprecated, use onkeydown instead).
- Overrides:
onkeypressin classA- 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.
-
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')" )
- 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 classA- 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 classA- 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 classA- 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 classA- 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 classA- 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 classA- 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 classA- 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 classA- 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 classA- 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.
-
onmousewheel
Description copied from class:HtmlElementonmousewheel attribute.Event handler for when the mouse wheel is rotated over the element (deprecated, use onwheel).
- Overrides:
onmousewheelin classA- 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.
-
onplay
Description copied from class:HtmlElementonplay attribute.Event handler for when media playback starts.
-
onplaying
Description copied from class:HtmlElementonplaying attribute.Event handler for when media playback starts after being paused or delayed.
-
onprogress
Description copied from class:HtmlElementonprogress attribute.Event handler for when the browser is downloading media data.
- Overrides:
onprogressin classA- 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 classA- 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.
-
onresize
Description copied from class:HtmlElementonresize attribute.Event handler for when the element is resized.
-
onscroll
Description copied from class:HtmlElementonscroll attribute.Event handler for when the element's scrollbar is scrolled.
-
onseeked
Description copied from class:HtmlElementonseeked attribute.Event handler for when a seek operation completes.
-
onseeking
Description copied from class:HtmlElementonseeking attribute.Event handler for when a seek operation begins.
-
onselect
Description copied from class:HtmlElementonselect attribute.Event handler for when text is selected in the element.
-
onshow
Description copied from class:HtmlElementonshow attribute.Event handler for when a context menu is shown.
-
onstalled
Description copied from class:HtmlElementonstalled attribute.Event handler for when media loading is stalled.
-
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')" )
- If using single quotes for attributes:
-
onsuspend
Description copied from class:HtmlElementonsuspend attribute.Event handler for when media loading is suspended.
-
ontimeupdate
Description copied from class:HtmlElementontimeupdate attribute.Event handler for when the current playback position changes.
- Overrides:
ontimeupdatein classA- 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.
-
onvolumechange
Description copied from class:HtmlElementonvolumechange attribute.Event handler for when the volume of media changes.
- Overrides:
onvolumechangein classA- 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.
-
rel
Description copied from class:Arel attribute.Specifies the relationship between the current document and the linked resource.
Common values:
"alternate" - Alternative version of the page"author" - Link to the author of the page"bookmark" - Permalink for bookmarking"external" - External link"help" - Link to help documentation"license" - Link to license information"next" - Next page in a sequence"nofollow" - Don't follow this link for SEO"noreferrer" - Don't send referrer information"prev" - Previous page in a sequence"search" - Link to search functionality"tag" - Tag for the current page
-
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 classA- 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.
-
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
-
target
Description copied from class:Atarget attribute.Specifies where to open the linked resource when the link is clicked.
Common values:
"_blank" - Open in a new window/tab"_self" - Open in the same frame (default)"_parent" - Open in the parent frame"_top" - Open in the full body of the window"framename" - Open in a named frame
-
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.
-
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
-
type
Description copied from class:Atype attribute.Specifies the MIME type of the linked resource. Helps browsers determine how to handle the resource.
Common values:
"text/html" - HTML document"text/css" - CSS stylesheet"application/pdf" - PDF document"image/png" - PNG image"application/zip" - ZIP archive
-