com.gargoylesoftware.htmlunit.javascript.host.html.HTMLLabelElement Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of htmlunit Show documentation
Show all versions of htmlunit Show documentation
A headless browser intended for use in testing web-based applications.
/*
* Copyright (c) 2002-2018 Gargoyle Software Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.gargoylesoftware.htmlunit.javascript.host.html;
import static com.gargoylesoftware.htmlunit.BrowserVersionFeatures.JS_LABEL_FORM_NULL;
import static com.gargoylesoftware.htmlunit.javascript.configuration.SupportedBrowser.CHROME;
import static com.gargoylesoftware.htmlunit.javascript.configuration.SupportedBrowser.EDGE;
import static com.gargoylesoftware.htmlunit.javascript.configuration.SupportedBrowser.FF;
import org.apache.commons.lang3.StringUtils;
import org.w3c.dom.Element;
import com.gargoylesoftware.htmlunit.html.HtmlElement;
import com.gargoylesoftware.htmlunit.html.HtmlForm;
import com.gargoylesoftware.htmlunit.html.HtmlLabel;
import com.gargoylesoftware.htmlunit.javascript.configuration.JsxClass;
import com.gargoylesoftware.htmlunit.javascript.configuration.JsxConstructor;
import com.gargoylesoftware.htmlunit.javascript.configuration.JsxGetter;
import com.gargoylesoftware.htmlunit.javascript.configuration.JsxSetter;
/**
* A JavaScript object for {@code HTMLLabelElement}.
*
* @author Ahmed Ashour
* @author Ronald Brill
*/
@JsxClass(domClass = HtmlLabel.class)
public class HTMLLabelElement extends HTMLElement {
/**
* Creates an instance.
*/
@JsxConstructor({CHROME, FF, EDGE})
public HTMLLabelElement() {
}
/**
* Retrieves the object to which the given label object is assigned.
* @return the identifier of the element to which the label element is assigned
*/
@JsxGetter
public String getHtmlFor() {
return ((HtmlLabel) getDomNodeOrDie()).getForAttribute();
}
/**
* Sets or retrieves the object to which the given label object is assigned.
* @param id Specifies the identifier of the element to which the label element is assigned
* @see MSDN Documentation
*/
@JsxSetter
public void setHtmlFor(final String id) {
((HtmlLabel) getDomNodeOrDie()).setAttribute("for", id);
}
/**
* @return the HTMLElement to which the given label object is assigned
*/
@JsxGetter({CHROME, FF})
public HTMLElement getControl() {
final String id = getHtmlFor();
if (StringUtils.isBlank(id)) {
return null;
}
final HtmlElement htmlElem = getDomNodeOrDie();
final Element elem = htmlElem.getPage().getElementById(id);
if (null == elem || !(elem instanceof HtmlElement)) {
return null;
}
return (HTMLElement) ((HtmlElement) elem).getScriptableObject();
}
/**
* Returns the value of the JavaScript {@code form} attribute.
*
* @return the value of the JavaScript {@code form} attribute
*/
@JsxGetter
public HTMLFormElement getForm() {
if (getBrowserVersion().hasFeature(JS_LABEL_FORM_NULL)) {
return null;
}
final HtmlForm form = getDomNodeOrDie().getEnclosingForm();
if (form == null) {
return null;
}
return (HTMLFormElement) getScriptableFor(form);
}
}