com.gargoylesoftware.htmlunit.javascript.host.event.EventTarget 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.event;
import static com.gargoylesoftware.htmlunit.BrowserVersionFeatures.JS_CALL_RESULT_IS_LAST_RETURN_VALUE;
import static com.gargoylesoftware.htmlunit.BrowserVersionFeatures.JS_EVENT_WINDOW_EXECUTE_IF_DITACHED;
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 static com.gargoylesoftware.htmlunit.javascript.configuration.SupportedBrowser.IE;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import org.apache.commons.lang3.StringUtils;
import org.w3c.dom.Document;
import com.gargoylesoftware.htmlunit.ScriptResult;
import com.gargoylesoftware.htmlunit.html.DomDocumentFragment;
import com.gargoylesoftware.htmlunit.html.DomElement;
import com.gargoylesoftware.htmlunit.html.DomNode;
import com.gargoylesoftware.htmlunit.html.HtmlElement;
import com.gargoylesoftware.htmlunit.html.HtmlLabel;
import com.gargoylesoftware.htmlunit.javascript.SimpleScriptable;
import com.gargoylesoftware.htmlunit.javascript.configuration.JsxClass;
import com.gargoylesoftware.htmlunit.javascript.configuration.JsxConstructor;
import com.gargoylesoftware.htmlunit.javascript.configuration.JsxFunction;
import com.gargoylesoftware.htmlunit.javascript.host.Window;
import com.gargoylesoftware.htmlunit.javascript.host.html.HTMLElement;
import com.gargoylesoftware.htmlunit.javascript.host.html.HTMLLabelElement;
import net.sourceforge.htmlunit.corejs.javascript.Context;
import net.sourceforge.htmlunit.corejs.javascript.Function;
import net.sourceforge.htmlunit.corejs.javascript.Scriptable;
/**
* A JavaScript object for {@code EventTarget}.
*
* @author Ahmed Ashour
*/
@JsxClass({CHROME, FF, EDGE})
@JsxClass(isJSObject = false, value = IE)
public class EventTarget extends SimpleScriptable {
private EventListenersContainer eventListenersContainer_;
/**
* Default constructor.
*/
@JsxConstructor
public EventTarget() {
}
/**
* Allows the registration of event listeners on the event target.
* @param type the event type to listen for (like "click")
* @param listener the event listener
* @param useCapture If {@code true}, indicates that the user wishes to initiate capture
* @see Mozilla documentation
*/
@JsxFunction
public void addEventListener(final String type, final Scriptable listener, final boolean useCapture) {
getEventListenersContainer().addEventListener(type, listener, useCapture);
}
/**
* Gets the container for event listeners.
* @return the container (newly created if needed)
*/
public final EventListenersContainer getEventListenersContainer() {
if (eventListenersContainer_ == null) {
eventListenersContainer_ = new EventListenersContainer(this);
}
return eventListenersContainer_;
}
/**
* Executes the event on this object only (needed for instance for onload on (i)frame tags).
* @param event the event
* @return the result
* @see #fireEvent(Event)
*/
public ScriptResult executeEventLocally(final Event event) {
final EventListenersContainer eventListenersContainer = getEventListenersContainer();
if (eventListenersContainer != null) {
final Window window = getWindow();
final Object[] args = new Object[] {event};
// handlers declared as property on a node don't receive the event as argument for IE
final Object[] propHandlerArgs = args;
final Event previousEvent = window.getCurrentEvent();
window.setCurrentEvent(event);
try {
return eventListenersContainer.executeListeners(event, args, propHandlerArgs);
}
finally {
window.setCurrentEvent(previousEvent); // reset event
}
}
return null;
}
/**
* Fires the event on the node with capturing and bubbling phase.
* @param event the event
* @return the result
*/
public ScriptResult fireEvent(final Event event) {
final Window window = getWindow();
final Object[] args = new Object[] {event};
event.startFire();
ScriptResult result = null;
final Event previousEvent = window.getCurrentEvent();
window.setCurrentEvent(event);
try {
// window's listeners
final EventListenersContainer windowsListeners = window.getEventListenersContainer();
// capturing phase
event.setEventPhase(Event.CAPTURING_PHASE);
final boolean windowEventIfDetached = getBrowserVersion().hasFeature(JS_EVENT_WINDOW_EXECUTE_IF_DITACHED);
boolean isAttached = false;
for (DomNode node = getDomNodeOrNull(); node != null; node = node.getParentNode()) {
if (node instanceof Document || node instanceof DomDocumentFragment) {
isAttached = true;
break;
}
}
if (isAttached || windowEventIfDetached) {
result = windowsListeners.executeCapturingListeners(event, args);
if (event.isPropagationStopped()) {
return result;
}
}
final List eventTargetList = new ArrayList<>();
EventTarget eventTarget = this;
while (eventTarget != null) {
if (isAttached) {
eventTargetList.add(eventTarget);
}
final DomNode domNode = eventTarget.getDomNodeOrNull();
eventTarget = null;
if (domNode != null && domNode.getParentNode() != null) {
eventTarget = (EventTarget) domNode.getParentNode().getScriptableObject();
}
}
final boolean ie = getBrowserVersion().hasFeature(JS_CALL_RESULT_IS_LAST_RETURN_VALUE);
for (int i = eventTargetList.size() - 1; i >= 0; i--) {
final EventTarget jsNode = eventTargetList.get(i);
final EventListenersContainer elc = jsNode.eventListenersContainer_;
if (elc != null && isAttached) {
final ScriptResult r = elc.executeCapturingListeners(event, args);
result = ScriptResult.combine(r, result, ie);
if (event.isPropagationStopped()) {
return result;
}
}
}
// handlers declared as property on a node don't receive the event as argument for IE
final Object[] propHandlerArgs = args;
// bubbling phase
event.setEventPhase(Event.AT_TARGET);
eventTarget = this;
HtmlLabel label = null;
final boolean processLabelAfterBubbling = event.processLabelAfterBubbling();
while (eventTarget != null) {
final EventTarget jsNode = eventTarget;
final EventListenersContainer elc = jsNode.eventListenersContainer_;
if (elc != null && !(jsNode instanceof Window) && (isAttached || !(jsNode instanceof HTMLElement))) {
final ScriptResult r = elc.executeBubblingListeners(event, args, propHandlerArgs);
result = ScriptResult.combine(r, result, ie);
if (event.isPropagationStopped()) {
return result;
}
}
final DomNode domNode = eventTarget.getDomNodeOrNull();
eventTarget = null;
if (domNode != null && domNode.getParentNode() != null) {
eventTarget = (EventTarget) domNode.getParentNode().getScriptableObject();
}
event.setEventPhase(Event.BUBBLING_PHASE);
if (eventTarget != null
&& label == null
&& processLabelAfterBubbling && eventTarget instanceof HTMLLabelElement) {
label = (HtmlLabel) eventTarget.getDomNodeOrNull();
}
}
if (label != null) {
final HtmlElement element = label.getReferencedElement();
if (element != null && element != getDomNodeOrNull()) {
try {
element.click(event.isShiftKey(), event.isCtrlKey(), event.isAltKey(), false, true, true);
}
catch (final IOException e) {
// ignore for now
}
}
}
if (isAttached || windowEventIfDetached) {
final ScriptResult r = windowsListeners.executeBubblingListeners(event, args, propHandlerArgs);
result = ScriptResult.combine(r, result, ie);
}
}
finally {
event.endFire();
window.setCurrentEvent(previousEvent); // reset event
}
return result;
}
/**
* Returns {@code true} if there are any event handlers for the specified event.
* @param eventName the event name (e.g. "onclick")
* @return {@code true} if there are any event handlers for the specified event, {@code false} otherwise
*/
public boolean hasEventHandlers(final String eventName) {
if (eventListenersContainer_ == null) {
return false;
}
return eventListenersContainer_.hasEventListeners(StringUtils.substring(eventName, 2));
}
/**
* Returns the specified event handler.
* @param eventType the event type (e.g. "click")
* @return the handler function, or {@code null} if the property is null or not a function
*/
public Function getEventHandler(final String eventType) {
return getEventListenersContainer().getEventHandler(eventType);
}
/**
* Dispatches an event into the event system (standards-conformant browsers only). See
* the Gecko
* DOM reference for more information.
*
* @param event the event to be dispatched
* @return {@code false} if at least one of the event handlers which handled the event
* called preventDefault; {@code true} otherwise
*/
@JsxFunction
public boolean dispatchEvent(final Event event) {
event.setTarget(this);
final DomElement element = (DomElement) getDomNodeOrNull();
ScriptResult result = null;
if (event.getType().equals(MouseEvent.TYPE_CLICK)) {
try {
element.click(event, true);
}
catch (final IOException e) {
throw Context.reportRuntimeError("Error calling click(): " + e.getMessage());
}
}
else {
result = fireEvent(event);
}
return !event.isAborted(result);
}
/**
* Allows the removal of event listeners on the event target.
* @param type the event type to listen for (like "click")
* @param listener the event listener
* @param useCapture If {@code true}, indicates that the user wishes to initiate capture (not yet implemented)
* @see Mozilla
* documentation
*/
@JsxFunction
public void removeEventListener(final String type, final Scriptable listener, final boolean useCapture) {
getEventListenersContainer().removeEventListener(type, listener, useCapture);
}
/**
* Defines an event handler (or maybe any other object).
* @param eventName the event name (e.g. "click")
* @param value the property ({@code null} to reset it)
*/
public void setEventHandler(final String eventName, final Object value) {
final EventListenersContainer container;
if (isEventHandlerOnWindow()) {
container = getWindow().getEventListenersContainer();
}
else {
container = getEventListenersContainer();
}
container.setEventHandler(eventName, value);
}
/**
* Is setting event handler property, at window-level.
* @return whether the event handler to be set at window-level
*/
protected boolean isEventHandlerOnWindow() {
return false;
}
/**
* Clears the event listener container.
*/
protected void clearEventListenersContainer() {
eventListenersContainer_ = null;
}
}