com.gargoylesoftware.htmlunit.html.HtmlLabel Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of vaadin-client-compiler-deps Show documentation
Show all versions of vaadin-client-compiler-deps Show documentation
Vaadin is a web application framework for Rich Internet Applications (RIA).
Vaadin enables easy development and maintenance of fast and
secure rich web
applications with a stunning look and feel and a wide browser support.
It features a server-side architecture with the majority of the logic
running
on the server. Ajax technology is used at the browser-side to ensure a
rich
and interactive user experience.
/*
* Copyright (c) 2002-2011 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.html;
import java.io.IOException;
import java.util.Map;
import com.gargoylesoftware.htmlunit.ElementNotFoundException;
import com.gargoylesoftware.htmlunit.Page;
import com.gargoylesoftware.htmlunit.SgmlPage;
/**
* Wrapper for the HTML element "label".
*
* @version $Revision: 6204 $
* @author Mike Bowler
* @author David K. Taylor
* @author Christian Sell
* @author Marc Guillemot
* @author Ahmed Ashour
*/
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 namespaceURI the URI that identifies an XML namespace
* @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 namespaceURI, final String qualifiedName, final SgmlPage page,
final Map attributes) {
super(namespaceURI, qualifiedName, page, attributes);
}
/**
* Returns the value of the attribute "for". Refer to the
* HTML 4.01
* documentation for details on the use of this attribute.
*
* @return the value of the attribute "for"
* or an empty string if that attribute isn't defined.
*/
public final String getForAttribute() {
return getAttribute("for");
}
/**
* Returns the value of the attribute "accesskey". Refer to the
* HTML 4.01
* documentation for details on the use of this attribute.
*
* @return the value of the attribute "accesskey"
* or an empty string if that attribute isn't defined.
*/
public final String getAccessKeyAttribute() {
return getAttribute("accesskey");
}
/**
* Returns the value of the attribute "onfocus". Refer to the
* HTML 4.01
* documentation for details on the use of this attribute.
*
* @return the value of the attribute "onfocus"
* or an empty string if that attribute isn't defined.
*/
public final String getOnFocusAttribute() {
return getAttribute("onfocus");
}
/**
* Returns the value of the attribute "onblur". Refer to the
* HTML 4.01
* documentation for details on the use of this attribute.
*
* @return the value of the attribute "onblur"
* or an empty string if that attribute isn't defined.
*/
public final String getOnBlurAttribute() {
return getAttribute("onblur");
}
/**
* Remove focus from this element.
*/
@Override
public void blur() {
final HtmlElement element = getReferencedElement();
if (element != null) {
element.blur();
}
}
/**
* Sets the focus to this element.
*/
@Override
public void focus() {
final HtmlElement element = getReferencedElement();
if (element != null) {
element.focus();
}
}
/**
* Gets the element referenced by this label. That is the element in the page which id is
* equal to the value of the for attribute of this label.
* @return the element, null
if not found
*/
public HtmlElement getReferencedElement() {
final String elementId = getForAttribute();
if (!ATTRIBUTE_NOT_DEFINED.equals(elementId)) {
try {
return getElementById(elementId);
}
catch (final ElementNotFoundException e) {
return null;
}
}
for (final DomNode element : getChildren()) {
if (element instanceof HtmlInput) {
return (HtmlInput) element;
}
}
return null;
}
/**
* Clicks the label and propagates to the referenced element.
* {@inheritDoc}
*/
@Override
@SuppressWarnings("unchecked")
public Page click() throws IOException {
// first the click on the label
final Page page = super.click();
// not sure which page we should return
final Page response;
// then the click on the referenced element
final HtmlElement element = getReferencedElement();
if (element != null) {
response = element.click();
}
else {
response = page;
}
return response;
}
}