Package org.apache.juneau.bean.html5

Class Area

java.lang.Object
org.apache.juneau.bean.html5.HtmlElement
org.apache.juneau.bean.html5.HtmlElementVoid
org.apache.juneau.bean.html5.Area
@Bean(typeName="area") public class Area extends HtmlElementVoid
DTO for an HTML <area> element.

The area element defines a clickable region within an image map. It is used in conjunction with the map element to create interactive images with multiple clickable areas, each linking to different destinations.

Examples:

// Rectangular clickable area Area area1 = area().shape("rect").coords("0,0,100,50").href("https://example.com/page1"); // Circular clickable area Area area2 = area().shape("circle").coords("150,75,50").href("https://example.com/page2"); // Area with alternative text and target Area area3 = area().shape("rect").coords("200,0,300,100").href("https://example.com/page3") .alt("Click here for more info") .target("_blank");

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

See Also:

  • Constructor Details

  • Method Details

    • alt

      public Area alt(String value)
      alt attribute.

      Specifies alternative text for the area. This text is displayed when the image map cannot be loaded and is used by screen readers for accessibility.

      The alt text should be descriptive and convey the same information as the clickable area.

      Parameters:
      alt - Alternative text for the area.
      Returns:
      This object.

    • coords

      public Area coords(String value)
      coords attribute.

      Specifies the coordinates of the clickable area within the image map. The format depends on the shape:

      Coordinate formats:

      • "rect" - x1,y1,x2,y2 (top-left and bottom-right corners)
      • "circle" - x,y,radius (center point and radius)
      • "poly" - x1,y1,x2,y2,x3,y3,... (polygon vertices)
      • "default" - No coordinates needed
      Parameters:
      coords - The coordinates defining the clickable area.
      Returns:
      This object.

    • download

      public Area download(Object value)
      download attribute.

      Whether to download the resource instead of navigating to it, and its file name if so.

      Parameters:
      download - The new value for this attribute. Typically a Boolean or String.
      Returns:
      This object.

    • href

      public Area href(Object value)
      href 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 UriResolver can be used for values.

      Parameters:
      href - The new value for this attribute. Typically a URL or String.
      Returns:
      This object.

    • hreflang

      public Area hreflang(String value)
      hreflang 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
      Parameters:
      hreflang - The language code of the linked resource.
      Returns:
      This object.

    • rel

      public Area rel(String value)
      rel 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
      Parameters:
      rel - The relationship between the document and linked resource.
      Returns:
      This object.

    • shape

      public Area shape(String value)
      shape attribute.

      Specifies the shape of the clickable area in an image map.

      Possible values:

      • "rect" - Rectangular area (default)
      • "circle" - Circular area
      • "poly" - Polygonal area
      • "default" - Entire image area
      Parameters:
      shape - The shape of the clickable area.
      Returns:
      This object.

    • target

      public Area target(String value)
      target attribute.

      Specifies where to open the linked resource when the area 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
      Parameters:
      target - Where to open the linked resource.
      Returns:
      This object.

    • type

      public Area type(String value)
      type 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
      Parameters:
      type - The MIME type of the linked resource.
      Returns:
      This object.

    • _class

      public Area _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 HtmlElementVoid
      Returns:
      This object.

    • accesskey

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • contenteditable

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • dir

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • hidden

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • id

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • lang

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • onabort

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • onblur

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • oncancel

      public Area oncancel(String value)
      Description copied from class: HtmlElement
      oncancel attribute.

      Event handler for when a dialog is cancelled.

      Overrides:
      oncancel in class HtmlElementVoid
      Returns:
      This object.

    • oncanplay

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • oncanplaythrough

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • onchange

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • onclick

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • oncuechange

      public Area oncuechange(String value)
      Description copied from class: HtmlElement
      oncuechange attribute.

      Event handler for when a text track cue changes.

      Overrides:
      oncuechange in class HtmlElementVoid
      Returns:
      This object.

    • ondblclick

      public Area ondblclick(String value)
      Description copied from class: HtmlElement
      ondblclick attribute.

      Event handler for when the element is double-clicked.

      Overrides:
      ondblclick in class HtmlElementVoid
      Returns:
      This object.

    • ondurationchange

      public Area ondurationchange(String value)
      Description copied from class: HtmlElement
      ondurationchange attribute.

      Event handler for when the duration of the media changes.

      Overrides:
      ondurationchange in class HtmlElementVoid
      Returns:
      This object.

    • onemptied

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • onended

      public Area onended(String value)
      Description copied from class: HtmlElement
      onended attribute.

      Event handler for when the media playback reaches the end.

      Overrides:
      onended in class HtmlElementVoid
      Returns:
      This object.

    • onerror

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • onfocus

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • oninput

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • oninvalid

      public Area oninvalid(String value)
      Description copied from class: HtmlElement
      oninvalid attribute.

      Event handler for when form validation fails.

      Overrides:
      oninvalid in class HtmlElementVoid
      Returns:
      This object.

    • onkeydown

      public Area onkeydown(String value)
      Description copied from class: HtmlElement
      onkeydown attribute.

      Event handler for when a key is pressed down.

      Overrides:
      onkeydown in class HtmlElementVoid
      Returns:
      This object.

    • onkeypress

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • onkeyup

      public Area onkeyup(String value)
      Description copied from class: HtmlElement
      onkeyup attribute.

      Event handler for when a key is released.

      Overrides:
      onkeyup in class HtmlElementVoid
      Returns:
      This object.

    • onload

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • onloadeddata

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • onloadedmetadata

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • onloadstart

      public Area onloadstart(String value)
      Description copied from class: HtmlElement
      onloadstart attribute.

      Event handler for when the browser starts loading the media.

      Overrides:
      onloadstart in class HtmlElementVoid
      Returns:
      This object.

    • onmousedown

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • onmouseenter

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • onmouseleave

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • onmousemove

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • onmouseout

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • onmouseover

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • onmouseup

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • onmousewheel

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • onpause

      public Area onpause(String value)
      Description copied from class: HtmlElement
      onpause attribute.

      Event handler for when media playback is paused.

      Overrides:
      onpause in class HtmlElementVoid
      Returns:
      This object.

    • onplay

      public Area onplay(String value)
      Description copied from class: HtmlElement
      onplay attribute.

      Event handler for when media playback starts.

      Overrides:
      onplay in class HtmlElementVoid
      Returns:
      This object.

    • onplaying

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • onprogress

      public Area onprogress(String value)
      Description copied from class: HtmlElement
      onprogress attribute.

      Event handler for when the browser is downloading media data.

      Overrides:
      onprogress in class HtmlElementVoid
      Returns:
      This object.

    • onratechange

      public Area onratechange(String value)
      Description copied from class: HtmlElement
      onratechange attribute.

      Event handler for when the playback rate of media changes.

      Overrides:
      onratechange in class HtmlElementVoid
      Returns:
      This object.

    • onreset

      public Area onreset(String value)
      Description copied from class: HtmlElement
      onreset attribute.

      Event handler for when a form is reset.

      Overrides:
      onreset in class HtmlElementVoid
      Returns:
      This object.

    • onresize

      public Area onresize(String value)
      Description copied from class: HtmlElement
      onresize attribute.

      Event handler for when the element is resized.

      Overrides:
      onresize in class HtmlElementVoid
      Returns:
      This object.

    • onscroll

      public Area onscroll(String value)
      Description copied from class: HtmlElement
      onscroll attribute.

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

      Overrides:
      onscroll in class HtmlElementVoid
      Returns:
      This object.

    • onseeked

      public Area onseeked(String value)
      Description copied from class: HtmlElement
      onseeked attribute.

      Event handler for when a seek operation completes.

      Overrides:
      onseeked in class HtmlElementVoid
      Returns:
      This object.

    • onseeking

      public Area onseeking(String value)
      Description copied from class: HtmlElement
      onseeking attribute.

      Event handler for when a seek operation begins.

      Overrides:
      onseeking in class HtmlElementVoid
      Returns:
      This object.

    • onselect

      public Area onselect(String value)
      Description copied from class: HtmlElement
      onselect attribute.

      Event handler for when text is selected in the element.

      Overrides:
      onselect in class HtmlElementVoid
      Returns:
      This object.

    • onshow

      public Area onshow(String value)
      Description copied from class: HtmlElement
      onshow attribute.

      Event handler for when a context menu is shown.

      Overrides:
      onshow in class HtmlElementVoid
      Returns:
      This object.

    • onstalled

      public Area onstalled(String value)
      Description copied from class: HtmlElement
      onstalled attribute.

      Event handler for when media loading is stalled.

      Overrides:
      onstalled in class HtmlElementVoid
      Returns:
      This object.

    • onsubmit

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • onsuspend

      public Area onsuspend(String value)
      Description copied from class: HtmlElement
      onsuspend attribute.

      Event handler for when media loading is suspended.

      Overrides:
      onsuspend in class HtmlElementVoid
      Returns:
      This object.

    • ontimeupdate

      public Area ontimeupdate(String value)
      Description copied from class: HtmlElement
      ontimeupdate attribute.

      Event handler for when the current playback position changes.

      Overrides:
      ontimeupdate in class HtmlElementVoid
      Returns:
      This object.

    • ontoggle

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • onvolumechange

      public Area onvolumechange(String value)
      Description copied from class: HtmlElement
      onvolumechange attribute.

      Event handler for when the volume of media changes.

      Overrides:
      onvolumechange in class HtmlElementVoid
      Returns:
      This object.

    • onwaiting

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • spellcheck

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • style

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • tabindex

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • title

      public Area 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 HtmlElementVoid
      Returns:
      This object.

    • translate

      public Area 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 HtmlElementVoid
      Returns:
      This object.