org.htmlunit.html.HtmlLabel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xlt Show documentation
XLT (Xceptance LoadTest) is an extensive load and performance test tool developed and maintained by Xceptance.
The newest version!
/*
 * Copyright (c) 2002-2024 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
 * https://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 org.htmlunit.html;

import java.io.IOException;
import java.util.Map;

import org.htmlunit.ElementNotFoundException;
import org.htmlunit.Page;
import org.htmlunit.SgmlPage;
import org.htmlunit.javascript.host.event.Event;

/**
 * Wrapper for the HTML element "label".
 *
 * @author Mike Bowler
 * @author David K. Taylor
 * @author Christian Sell
 * @author Marc Guillemot
 * @author Ahmed Ashour
 * @author Ronald Brill
 * @author Frank Danek
 */
public class HtmlLabel extends HtmlElement {

    /** The HTML tag represented by this element. */
    public static final String TAG_NAME = "label";

    /**
     * Creates an instance of HtmlLabel
     *
     * @param qualifiedName the qualified name of the element type to instantiate
     * @param page the HtmlPage that contains this element
     * @param attributes the initial attributes
     */
    HtmlLabel(final String qualifiedName, final SgmlPage page,
            final Map attributes) {
        super(qualifiedName, page, attributes);
    }

    /**
     * Returns the value of the attribute {@code for}. Refer to the
     * HTML 4.01
     * documentation for details on the use of this attribute.
     *
     * @return the value of the attribute {@code for}
     * or an empty string if that attribute isn't defined.
     */
    public final String getForAttribute() {
        return getAttributeDirect("for");
    }

    /**
     * Returns the value of the attribute {@code accesskey}. Refer to the
     * HTML 4.01
     * documentation for details on the use of this attribute.
     *
     * @return the value of the attribute {@code accesskey}
     * or an empty string if that attribute isn't defined.
     */
    public final String getAccessKeyAttribute() {
        return getAttributeDirect("accesskey");
    }

    /**
     * Returns the value of the attribute {@code onfocus}. Refer to the
     * HTML 4.01
     * documentation for details on the use of this attribute.
     *
     * @return the value of the attribute {@code onfocus}
     * or an empty string if that attribute isn't defined.
     */
    public final String getOnFocusAttribute() {
        return getAttributeDirect("onfocus");
    }

    /**
     * Returns the value of the attribute {@code onblur}. Refer to the
     * HTML 4.01
     * documentation for details on the use of this attribute.
     *
     * @return the value of the attribute {@code onblur}
     * or an empty string if that attribute isn't defined.
     */
    public final String getOnBlurAttribute() {
        return getAttributeDirect("onblur");
    }

    /**
     * Sets the focus to this element.
     */
    @Override
    public void focus() {
        final HtmlElement element = getLabeledElement();
        if (element != null) {
            element.focus();
        }
    }

    /**
     * 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.
     * @return the element, {@code null} if not found
     */
    public HtmlElement getLabeledElement() {
        final String elementId = getForAttribute();
        if (ATTRIBUTE_NOT_DEFINED == elementId) {
            for (final DomNode element : getChildren()) {
                if (element instanceof LabelableElement) {
                    return (HtmlElement) element;
                }
            }
        }
        else {
            try {
                final HtmlElement element = ((HtmlPage) getPage()).getHtmlElementById(elementId);
                if (element instanceof LabelableElement) {
                    return element;
                }
            }
            catch (final ElementNotFoundException e) {
                return null;
            }
        }
        return null;
    }

    /**
     * Clicks the label and propagates to the referenced element.
     * {@inheritDoc}
     */
    @Override
    public  P click(final Event event,
            final boolean shiftKey, final boolean ctrlKey, final boolean altKey,
            final boolean ignoreVisibility) throws IOException {
        // first the click on the label
        final P page = super.click(event, shiftKey, ctrlKey, altKey, ignoreVisibility);

        // then the click on the referenced element
        final HtmlElement element = getLabeledElement();
        if (element == null || element.isDisabledElementAndDisabled()) {
            return page;
        }

        // not sure which page we should return
        return element.click(false, false, false, false, true, true, true);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public DisplayStyle getDefaultStyleDisplay() {
        return DisplayStyle.INLINE;
    }
}