All Implemented Interfaces:

Serializable, Cloneable, Element, Node

public class HtmlLabel
extends HtmlElement 

Author:

Mike Bowler, David K. Taylor, Christian Sell, Marc Guillemot, Ahmed Ashour, Ronald Brill, Frank Danek

See Also:

Serialized Form

• Nested Class Summary

  • Nested classes/interfaces inherited from class org.htmlunit.html.HtmlElement

    HtmlElement.DisplayStyle

  • Nested classes/interfaces inherited from class org.htmlunit.html.DomElement

    DomElement.ChildElementsIterator

  • Nested classes/interfaces inherited from class org.htmlunit.html.DomNode

    DomNode.ChildIterator, DomNode.DescendantDomElementsIterator, DomNode.DescendantDomNodesIterator, DomNode.DescendantElementsIterator<T extends DomNode>, DomNode.DescendantHtmlElementsIterator

• Field Summary

  Fields

  Modifier and Type	Field and Description
  static String	TAG_NAME The HTML tag represented by this element.

  • Fields inherited from class org.htmlunit.html.HtmlElement

    ATTRIBUTE_CHECKED, ATTRIBUTE_HIDDEN, ATTRIBUTE_REQUIRED, TAB_INDEX_OUT_OF_BOUNDS

  • Fields inherited from class org.htmlunit.html.DomElement

    ATTRIBUTE_NOT_DEFINED, ATTRIBUTE_VALUE_EMPTY, ID_ATTRIBUTE, NAME_ATTRIBUTE, SRC_ATTRIBUTE, TYPE_ATTRIBUTE, VALUE_ATTRIBUTE

  • Fields inherited from class org.htmlunit.html.DomNode

    PROPERTY_ELEMENT, READY_STATE_COMPLETE, READY_STATE_INTERACTIVE, READY_STATE_LOADED, READY_STATE_LOADING, READY_STATE_UNINITIALIZED

  • Fields inherited from interface org.w3c.dom.Node

    ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  <P extends Page> P	click (Event event, boolean shiftKey, boolean ctrlKey, boolean altKey, boolean ignoreVisibility) Clicks the label and propagates to the referenced element.
  void	focus () Sets the focus to this element.
  String	getAccessKeyAttribute () Returns the value of the attribute accesskey.
  HtmlElement.DisplayStyle	getDefaultStyleDisplay () INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
  String	getForAttribute () Returns the value of the attribute for.
  HtmlElement	getLabeledElement () Gets the element labeled by this label.
  String	getOnBlurAttribute () Returns the value of the attribute onblur.
  String	getOnFocusAttribute () Returns the value of the attribute onfocus.

  • Methods inherited from class org.htmlunit.html.HtmlElement

    acceptChar, addHtmlAttributeChangeListener, appendChildIfNoneExists, checkChildHierarchy, cloneNode, detach, doType, doType, fireHtmlAttributeAdded, fireHtmlAttributeRemoved, fireHtmlAttributeReplaced, getCanonicalXPath, getElementsByAttribute, getEnclosingElement, getEnclosingForm, getEnclosingFormOrDie, getHidden, getLangAttribute, getNodeName, getOffsetLeft, getOffsetParentInternal, getOffsetTop, getOnClickAttribute, getOnDblClickAttribute, getOneHtmlElementByAttribute, getOnKeyDownAttribute, getOnKeyPressAttribute, getOnKeyUpAttribute, getOnMouseDownAttribute, getOnMouseMoveAttribute, getOnMouseOutAttribute, getOnMouseOverAttribute, getOnMouseUpAttribute, getPosX, getPosY, getSrcAttributeNormalized, getTabIndex, getTextDirectionAttribute, getXmlLangAttribute, handles, hasEventHandlers, isAltPressed, isAttributeCaseSensitive, isCtrlPressed, isDisplayed, isHidden, isOptional, isRequired, isRequiredSupported, isShiftPressed, isSubmittableByEnter, isValid, notifyAttributeChangeListeners, removeAttribute, removeChild, removeHtmlAttributeChangeListener, setAttributeNode, setAttributeNS, setHidden, setHidden, setOwningForm, setRequired, type, type, type, type, typeDone

  • Methods inherited from class org.htmlunit.html.DomElement

    blur, click, click, click, click, dblClick, dblClick, doClickFireChangeEvent, doClickFireClickEvent, doClickStateUpdate, fireEvent, fireEvent, getAttribute, getAttributeDirect, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributesMap, getChildElementCount, getChildElements, getElementsByTagName, getElementsByTagNameNS, getEventTargetElement, getFirstElementChild, getId, getLastElementChild, getNodeType, getSchemaTypeInfo, getStaticElementsByTagName, getStyleElement, getStyleElementCaseInSensitive, getStyleMap, getTagName, hasAttribute, hasAttributeNS, hasAttributes, isDisabledElementAndDisabled, isEmptyXmlTagExpanded, isMouseOver, isStateUpdateFirst, matches, mouseDown, mouseDown, mouseMove, mouseMove, mouseOut, mouseOut, mouseOver, mouseOver, mouseUp, mouseUp, preventDefault, printOpeningTagContentAsXml, printXml, propagateClickStateUpdateToParent, removeAttributeNode, removeAttributeNS, removeFocus, removeStyleAttribute, replaceStyleAttribute, rightClick, rightClick, setAttribute, setAttributeNodeNS, setAttributeNS, setDefaults, setId, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setInnerHtml, setNodeValue, toString, writeStyleToElement

  • Methods inherited from class org.htmlunit.html.DomNamespaceNode

    getLocalName, getLowercaseName, getNamespaceURI, getPrefix, getQualifiedName, processImportNode, setPrefix

  • Methods inherited from class org.htmlunit.html.DomNode

    addCharacterDataChangeListener, addDomChangeListener, appendChild, asNormalizedText, asXml, basicRemove, closest, compareDocumentPosition, fireCharacterDataChanged, fireNodeAdded, fireNodeDeleted, getAncestors, getBaseURI, getByXPath, getByXPath, getChildNodes, getChildren, getDescendants, getDomElementDescendants, getEndColumnNumber, getEndLineNumber, getFeature, getFirstByXPath, getFirstByXPath, getFirstChild, getHtmlElementDescendants, getHtmlPageOrNull, getIndex, getLastChild, getNextElementSibling, getNextSibling, getNodeValue, getOwnerDocument, getPage, getParentNode, getPreviousElementSibling, getPreviousSibling, getReadyState, getScriptableObject, getSelectorList, getStartColumnNumber, getStartLineNumber, getTextContent, getUserData, getVisibleText, hasChildNodes, hasFeature, insertBefore, insertBefore, isAncestorOf, isAncestorOfAny, isAttachedToPage, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, mayBeDisplayed, normalize, notifyIncorrectness, onAddedToDocumentFragment, onAddedToPage, onAllChildrenAddedToPage, parseHtmlSnippet, printChildrenAsXml, querySelector, querySelectorAll, quietlyRemoveAndMoveChildrenTo, remove, removeAllChildren, removeCharacterDataChangeListener, removeChild, removeDomChangeListener, replace, replaceChild, setEndLocation, setParentNode, setReadyState, setScriptableObject, setStartLocation, setTextContent, setUserData

  • Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Methods inherited from interface org.w3c.dom.Node

    appendChild, compareDocumentPosition, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setPrefix, setTextContent, setUserData

• Field Detail

  • TAG_NAME

    public static final String TAG_NAME

    The HTML tag represented by this element.

    See Also:

    Constant Field Values

• Method Detail

  • getForAttribute

    public final String getForAttribute()

    Returns the value of the attribute for. Refer to the HTML 4.01 documentation for details on the use of this attribute.

    Returns:

    the value of the attribute for or an empty string if that attribute isn't defined.

  • getAccessKeyAttribute

    public final String getAccessKeyAttribute()

    Returns the value of the attribute accesskey. Refer to the HTML 4.01 documentation for details on the use of this attribute.

    Returns:

    the value of the attribute accesskey or an empty string if that attribute isn't defined.

  • getOnFocusAttribute

    public final String getOnFocusAttribute()

    Returns the value of the attribute onfocus. Refer to the HTML 4.01 documentation for details on the use of this attribute.

    Returns:

    the value of the attribute onfocus or an empty string if that attribute isn't defined.

  • getOnBlurAttribute

    public final String getOnBlurAttribute()

    Returns the value of the attribute onblur. Refer to the HTML 4.01 documentation for details on the use of this attribute.

    Returns:

    the value of the attribute onblur or an empty string if that attribute isn't defined.

  • focus

    public void focus()

    Sets the focus to this element.

    Overrides:

    focus in class DomElement

  • getLabeledElement

    public HtmlElement getLabeledElement()

    Gets the element labeled by this label. That is the labelable element in the page which id is equal to the value of the for attribute of this label or, if no for attribute is defined, the first nested labelable element.

    Returns:

    the element, null if not found

  • click

    public <P extends Page> P click(Event event,
     boolean shiftKey,
     boolean ctrlKey,
     boolean altKey,
     boolean ignoreVisibility)
     throws IOException 

    Clicks the label and propagates to the referenced element. INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
    Simulates clicking on this element, returning the page in the window that has the focus after the element has been clicked. Note that the returned page may or may not be the same as the original page, depending on the type of element being clicked, the presence of JavaScript action listeners, etc.

    Overrides:

    click in class DomElement

    Type Parameters:

    P - the page type

    Parameters:

    event - the click event used

    shiftKey - true if SHIFT is pressed during the click

    ctrlKey - true if CTRL is pressed during the click

    altKey - true if ALT is pressed during the click

    ignoreVisibility - whether to ignore visibility or not

    Returns:

    the page contained in the current window as returned by WebClient.getCurrentWindow()

    Throws:

    IOException - if an IO error occurs

  • getDefaultStyleDisplay

    public HtmlElement.DisplayStyle getDefaultStyleDisplay()

    INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
    Returns the default display style.

    Overrides:

    getDefaultStyleDisplay in class HtmlElement

    Returns:

    the default display style