com.google.gwt.query.client.plugins.Events Maven / Gradle / Ivy
The newest version!
/*
* Copyright 2011, The gwtquery team.
*
* 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.google.gwt.query.client.plugins;
import com.google.gwt.dom.client.Element;
import com.google.gwt.dom.client.FormElement;
import com.google.gwt.dom.client.NativeEvent;
import com.google.gwt.dom.client.Node;
import com.google.gwt.query.client.Function;
import com.google.gwt.query.client.GQuery;
import com.google.gwt.query.client.js.JsUtils;
import com.google.gwt.query.client.plugins.events.EventsListener;
import com.google.gwt.query.client.plugins.events.EventsListener.EventName;
import com.google.gwt.user.client.Event;
/**
* GQuery Plugin for handling and queuing browser events.
*/
public class Events extends GQuery {
public static final Class Events = registerPlugin(Events.class, new Plugin() {
public Events init(GQuery gq) {
return new Events(gq);
}
});
/**
* Don't apply events on text and comment nodes !!
*/
private static boolean isEventCapable(Node n) {
return JsUtils.isWindow(n) || JsUtils.isElement(n) && n.getNodeType() != 3
&& n.getNodeType() != 8;
}
public Events(GQuery gq) {
super(gq);
}
/**
* Binds a set of handlers to a particular Event for each matched element.
*
* The event handlers are passed as Functions that you can use to prevent default behavior. To
* stop both default action and event bubbling, the function event handler has to return false.
*
* You can pass an additional Object data to your Function as the second parameter
*
*/
public Events bind(int eventbits, Object data, Function... funcs) {
for (Element e : elements()) {
if (isEventCapable(e)) {
EventsListener.getInstance(e).bind(eventbits, data, funcs);
}
}
return this;
}
/**
* Binds a set of handlers to a particular Event for each matched element.
*
* The namespace is a way to group events of the same type, making easier unbind specific
* handlers.
*
* The event handlers are passed as Functions that you can use to prevent default behavior. To
* stop both default action and event bubbling, the function event handler has to return false.
*
* You can pass an additional Object data to your Function
*
*/
public Events bind(int eventbits, String namespace, Object data, Function... funcs) {
for (Element e : elements()) {
if (isEventCapable(e)) {
EventsListener.getInstance(e).bind(eventbits, namespace, data, funcs);
}
}
return this;
}
/**
* Binds a set of handlers to a particular Event for each matched element.
*
* The name could contain a namespace which is a way to group events of the same type, making
* easier unbind specific handlers.
*
* The event handlers are passed as Functions that you can use to prevent default behavior. To
* stop both default action and event bubbling, the function event handler has to return false.
*
* You can pass an additional Object data to your Function
*
*/
public Events bind(String event, Object data, Function... funcs) {
for (Element e : elements()) {
if (isEventCapable(e)) {
EventsListener.getInstance(e).bind(event, data, funcs);
}
}
return this;
}
public GQuery die(int eventbits, String nameSpace) {
EventsListener.getInstance(Element.is(currentContext) ? (Element) currentContext : body).die(
eventbits, nameSpace, null, currentSelector);
return this;
}
public GQuery die(int eventbits) {
return die(eventbits, null);
}
/**
* Remove an event handlers previously attached using live() The selector used with it must match
* exactly the selector initially used with live(). if eventName is null, all event
* handlers corresponding of the GQuery selector will be removed
*/
public GQuery die(String eventName) {
EventsListener.getInstance(Element.is(currentContext) ? (Element) currentContext : body).die(
eventName, currentSelector);
return this;
}
public GQuery live(int eventbits, final Object data, Function... funcs) {
return live(eventbits, null, data, funcs);
}
public GQuery live(int eventbits, String nameSpace, final Object data, Function... funcs) {
EventsListener.getInstance(Element.is(currentContext) ? (Element) currentContext : body).live(
eventbits, nameSpace, null, currentSelector, data, funcs);
return this;
}
public GQuery live(String eventName, final Object data, Function... funcs) {
EventsListener.getInstance(Element.is(currentContext) ? (Element) currentContext : body).live(
eventName, currentSelector, data, funcs);
return this;
}
/**
* Bind an event handler to be fired when the mouse enter an element, or trigger that handler on
* an element if no functions are provided.
*
* The mouseenter event differs from mouseover in the way it handles event bubbling. When
* mouseover is used on an element having inner element(s), then when the mouse pointer moves
* hover of the Inner element, the handler would be triggered. This is usually undesirable
* behavior. The mouseenter event, on the other hand, only triggers its handler when the mouse
* enters the element it is bound to, not a descendant.
*/
public GQuery mouseenter(Function... f) {
if (f == null || f.length == 0) {
// handle trigger of mouseleave
return triggerHtmlEvent("mouseenter");
}
return bind("mouseenter", null, f);
}
/**
* Bind an event handler to be fired when the mouse leaves an element, or trigger that handler on
* an element if no functions are provided.
*
* The mouseleave event differs from mouseout in the way it handles event bubbling. When mouseout
* is used on an element having inner element(s), then when the mouse pointer moves out of the
* Inner element, the handler would be triggered. This is usually undesirable behavior. The
* mouseleave event, on the other hand, only triggers its handler when the mouse leaves the
* element it is bound to, not a descendant.
*/
public GQuery mouseleave(Function... fs) {
if (fs == null || fs.length == 0) {
// handle trigger of mouseleave
return triggerHtmlEvent("mouseleave");
}
return bind("mouseleave", null, fs);
}
/**
* Binds a handler to a particular Event (like Event.ONCLICK) for each matched element. The
* handler is executed only once for each element.
*
* The event handler is passed as a Function that you can use to prevent default behavior. To stop
* both default action and event bubbling, the function event handler has to return false.
*
* You can pass an additional Object data to your Function as the second parameter
*/
public Events one(int eventbits, final Object data, final Function f) {
for (Element e : elements()) {
if (isEventCapable(e)) {
EventsListener.getInstance(e).bind(eventbits, data, f, 1);
}
}
return this;
}
/**
* Execute all handlers and behaviors attached to the matched elements for the given event types.
*
* Different event types can be passed joining these using the or bit wise operator.
*
* For keyboard events you can pass a second parameter which represents the key-code of the pushed
* key.
*
* Example: fire(Event.ONCLICK | Event.ONFOCUS) Example: fire(Event.ONKEYDOWN. 'a');
*/
public Events trigger(int eventbits, int... keys) {
if ((eventbits | Event.ONBLUR) == Event.ONBLUR)
dispatchEvent(document.createBlurEvent());
if ((eventbits | Event.ONCHANGE) == Event.ONCHANGE)
dispatchEvent(document.createChangeEvent());
if ((eventbits | Event.ONCLICK) == Event.ONCLICK)
dispatchEvent(document.createClickEvent(0, 0, 0, 0, 0, false, false, false, false));
if ((eventbits | Event.ONDBLCLICK) == Event.ONDBLCLICK)
dispatchEvent(document.createDblClickEvent(0, 0, 0, 0, 0, false, false, false, false));
if ((eventbits | Event.ONFOCUS) == Event.ONFOCUS)
dispatchEvent(document.createFocusEvent());
if ((eventbits | Event.ONKEYDOWN) == Event.ONKEYDOWN)
dispatchEvent(document.createKeyDownEvent(false, false, false, false, keys[0]));
if ((eventbits | Event.ONKEYPRESS) == Event.ONKEYPRESS)
dispatchEvent(document.createKeyPressEvent(false, false, false, false, keys[0], 0));
if ((eventbits | Event.ONKEYUP) == Event.ONKEYUP)
dispatchEvent(document.createKeyUpEvent(false, false, false, false, keys[0]));
if ((eventbits | Event.ONLOSECAPTURE) == Event.ONLOSECAPTURE)
triggerHtmlEvent("losecapture");
if ((eventbits | Event.ONMOUSEDOWN) == Event.ONMOUSEDOWN)
dispatchEvent(document.createMouseDownEvent(0, 0, 0, 0, 0, false, false, false, false,
NativeEvent.BUTTON_LEFT));
if ((eventbits | Event.ONMOUSEMOVE) == Event.ONMOUSEMOVE)
dispatchEvent(document.createMouseMoveEvent(0, 0, 0, 0, 0, false, false, false, false,
NativeEvent.BUTTON_LEFT));
if ((eventbits | Event.ONMOUSEOUT) == Event.ONMOUSEOUT)
dispatchEvent(document.createMouseOutEvent(0, 0, 0, 0, 0, false, false, false, false,
NativeEvent.BUTTON_LEFT, null));
if ((eventbits | Event.ONMOUSEOVER) == Event.ONMOUSEOVER)
dispatchEvent(document.createMouseOverEvent(0, 0, 0, 0, 0, false, false, false, false,
NativeEvent.BUTTON_LEFT, null));
if ((eventbits | Event.ONMOUSEUP) == Event.ONMOUSEUP)
dispatchEvent(document.createMouseUpEvent(0, 0, 0, 0, 0, false, false, false, false,
NativeEvent.BUTTON_LEFT));
if ((eventbits | Event.ONSCROLL) == Event.ONSCROLL)
dispatchEvent(document.createScrollEvent());
if ((eventbits | Event.ONERROR) == Event.ONERROR)
dispatchEvent(document.createErrorEvent());
if ((eventbits | Event.ONMOUSEWHEEL) == Event.ONMOUSEWHEEL)
dispatchEvent(document.createMouseEvent("mousewheel", true, true, 0, 0, 0, 0, 0, false,
false, false, false, NativeEvent.BUTTON_LEFT, null));
return this;
}
/**
* Trigger a native event in all matched elements.
*
* @param nativeEvent the browser native event.
* @functions a set of function to run if the event is not canceled.
*/
public Events trigger(NativeEvent nativeEvent, Function... fcns) {
dispatchEvent(nativeEvent, null, fcns);
return this;
}
/**
* Trigger a native event in all matched elements.
*
* @param nativeEvent the browser native event.
* @param datas a set of object passed as data when executed the handlers
* @param functions a set of function to run if the event is not canceled.
*/
public Events trigger(NativeEvent nativeEvent, Object[] datas, Function... functions) {
dispatchEvent(nativeEvent, datas, functions);
return this;
}
/**
* Trigger a html event in all matched elements.
*
* @param htmlEvent A string representing the desired html event.
* @param functions a set of function to run.
*/
public Events triggerHtmlEvent(String htmlEvent, Function... functions) {
return triggerHtmlEvent(htmlEvent, null, functions);
}
/**
* Trigger a html event in all matched elements.
*
* @param htmlEvent An string representing the desired html event.
* @param datas a set of object passed as data when executed the handlers
* @param functions a set of function to run.
*/
public Events triggerHtmlEvent(String htmlEvent, Object[] datas, final Function... functions) {
for (EventName part : EventName.split(htmlEvent)) {
NativeEvent e = document.createHtmlEvent(part.eventName, true, true);
JsUtils.prop(e, "namespace", part.nameSpace);
if ("submit".equals(part.eventName)) {
Function submitFunction = new Function() {
public void f(Element e) {
// first submit the form then call the others functions
if (FormElement.is(e)) {
e.cast().submit();
}
callHandlers(e, getEvent(), functions);
}
};
dispatchEvent(e, datas, submitFunction);
} else {
dispatchEvent(e, datas, functions);
}
}
return this;
}
/**
* Removes all handlers, that matches the events bits passed, from each element.
*
* Example: unbind(Event.ONCLICK | Event.ONMOUSEOVER)
*/
public Events unbind(int eventbits) {
for (Element e : elements()) {
if (isEventCapable(e)) {
EventsListener.getInstance(e).unbind(eventbits);
}
}
return this;
}
public Events off() {
for (Element e : elements()) {
if (isEventCapable(e)) {
EventsListener.getInstance(e).clean();
}
}
return this;
}
/**
* Removes all handlers, that matches the events bits and the namespace passed, from each element.
*
* Example: unbind(Event.ONCLICK | Event.ONMOUSEOVER, "my.namespace")
*/
public Events unbind(int eventbits, String name, Function f) {
for (Element e : elements()) {
if (isEventCapable(e)) {
EventsListener.getInstance(e).unbind(eventbits, name, null, f);
}
}
return this;
}
/**
* Removes all handlers, that matches the event name passed.
*
* This name could contain a namespace.
*
* Example: unbind("click.my.namespace")
*/
public Events unbind(String name) {
return unbind(name, null);
}
/**
* Removes the function passed as parameter from the event list matching the event name passed.
* This name could contain a namespace.
*
* Example: unbind("click.my.namespace", myFunction)
*/
public Events unbind(String name, Function f) {
for (Element e : elements()) {
if (isEventCapable(e)) {
EventsListener.getInstance(e).unbind(name, f);
}
}
return this;
}
public Events undelegate() {
for (Element e : elements()) {
if (isEventCapable(e)) {
EventsListener.getInstance(e).cleanEventDelegation();
}
}
return this;
}
private void dispatchEvent(NativeEvent evt, Function... funcs) {
dispatchEvent(evt, null, funcs);
}
public void dispatchEvent(NativeEvent evt, Object[] datas, Function... funcs) {
for (Element e : elements()) {
if (isEventCapable(e)) {
$(e).data(EventsListener.EVENT_DATA, datas);
// Ie6-8 don't dispatch bitless event
if ((browser.ie6 || browser.ie8) && Event.getTypeInt(evt.getType()) == -1) {
bubbleEventForIE(e, evt. cast());
} else {
e.dispatchEvent(evt);
}
if (!JsUtils.isDefaultPrevented(evt)) {
callHandlers(e, evt, funcs);
}
$(e).removeData(EventsListener.EVENT_DATA);
}
}
}
private void bubbleEventForIE(Element e, Event event) {
if (e == null || "html".equalsIgnoreCase(e.getTagName()) || isEventPropagationStopped(event)) {
return;
}
EventsListener.getInstance(e).dispatchEvent(event);
bubbleEventForIE(e.getParentElement(), event);
}
/**
* Only valid for IE6-8.
* @param event
* @return
*/
private boolean isEventPropagationStopped(Event event) {
// trick to avoid jnsi
return event. cast().getPropertyBoolean("cancelBubble");
}
private void callHandlers(Element e, NativeEvent evt, Function... functions) {
for (Function f : functions) {
f.setEvent(Event.as(evt));
f.f(e);
}
}
}