/**
*
* Apache License
* Version 2.0, January 2004
* http://www.apache.org/licenses/
*
* TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
*
* 1. Definitions.
*
* "License" shall mean the terms and conditions for use, reproduction,
* and distribution as defined by Sections 1 through 9 of this document.
*
* "Licensor" shall mean the copyright owner or entity authorized by
* the copyright owner that is granting the License.
*
* "Legal Entity" shall mean the union of the acting entity and all
* other entities that control, are controlled by, or are under common
* control with that entity. For the purposes of this definition,
* "control" means (i) the power, direct or indirect, to cause the
* direction or management of such entity, whether by contract or
* otherwise, or (ii) ownership of fifty percent (50%) or more of the
* outstanding shares, or (iii) beneficial ownership of such entity.
*
* "You" (or "Your") shall mean an individual or Legal Entity
* exercising permissions granted by this License.
*
* "Source" form shall mean the preferred form for making modifications,
* including but not limited to software source code, documentation
* source, and configuration files.
*
* "Object" form shall mean any form resulting from mechanical
* transformation or translation of a Source form, including but
* not limited to compiled object code, generated documentation,
* and conversions to other media types.
*
* "Work" shall mean the work of authorship, whether in Source or
* Object form, made available under the License, as indicated by a
* copyright notice that is included in or attached to the work
* (an example is provided in the Appendix below).
*
* "Derivative Works" shall mean any work, whether in Source or Object
* form, that is based on (or derived from) the Work and for which the
* editorial revisions, annotations, elaborations, or other modifications
* represent, as a whole, an original work of authorship. For the purposes
* of this License, Derivative Works shall not include works that remain
* separable from, or merely link (or bind by name) to the interfaces of,
* the Work and Derivative Works thereof.
*
* "Contribution" shall mean any work of authorship, including
* the original version of the Work and any modifications or additions
* to that Work or Derivative Works thereof, that is intentionally
* submitted to Licensor for inclusion in the Work by the copyright owner
* or by an individual or Legal Entity authorized to submit on behalf of
* the copyright owner. For the purposes of this definition, "submitted"
* means any form of electronic, verbal, or written communication sent
* to the Licensor or its representatives, including but not limited to
* communication on electronic mailing lists, source code control systems,
* and issue tracking systems that are managed by, or on behalf of, the
* Licensor for the purpose of discussing and improving the Work, but
* excluding communication that is conspicuously marked or otherwise
* designated in writing by the copyright owner as "Not a Contribution."
*
* "Contributor" shall mean Licensor and any individual or Legal Entity
* on behalf of whom a Contribution has been received by Licensor and
* subsequently incorporated within the Work.
*
* 2. Grant of Copyright License. Subject to the terms and conditions of
* this License, each Contributor hereby grants to You a perpetual,
* worldwide, non-exclusive, no-charge, royalty-free, irrevocable
* copyright license to reproduce, prepare Derivative Works of,
* publicly display, publicly perform, sublicense, and distribute the
* Work and such Derivative Works in Source or Object form.
*
* 3. Grant of Patent License. Subject to the terms and conditions of
* this License, each Contributor hereby grants to You a perpetual,
* worldwide, non-exclusive, no-charge, royalty-free, irrevocable
* (except as stated in this section) patent license to make, have made,
* use, offer to sell, sell, import, and otherwise transfer the Work,
* where such license applies only to those patent claims licensable
* by such Contributor that are necessarily infringed by their
* Contribution(s) alone or by combination of their Contribution(s)
* with the Work to which such Contribution(s) was submitted. If You
* institute patent litigation against any entity (including a
* cross-claim or counterclaim in a lawsuit) alleging that the Work
* or a Contribution incorporated within the Work constitutes direct
* or contributory patent infringement, then any patent licenses
* granted to You under this License for that Work shall terminate
* as of the date such litigation is filed.
*
* 4. Redistribution. You may reproduce and distribute copies of the
* Work or Derivative Works thereof in any medium, with or without
* modifications, and in Source or Object form, provided that You
* meet the following conditions:
*
* (a) You must give any other recipients of the Work or
* Derivative Works a copy of this License; and
*
* (b) You must cause any modified files to carry prominent notices
* stating that You changed the files; and
*
* (c) You must retain, in the Source form of any Derivative Works
* that You distribute, all copyright, patent, trademark, and
* attribution notices from the Source form of the Work,
* excluding those notices that do not pertain to any part of
* the Derivative Works; and
*
* (d) If the Work includes a "NOTICE" text file as part of its
* distribution, then any Derivative Works that You distribute must
* include a readable copy of the attribution notices contained
* within such NOTICE file, excluding those notices that do not
* pertain to any part of the Derivative Works, in at least one
* of the following places: within a NOTICE text file distributed
* as part of the Derivative Works; within the Source form or
* documentation, if provided along with the Derivative Works; or,
* within a display generated by the Derivative Works, if and
* wherever such third-party notices normally appear. The contents
* of the NOTICE file are for informational purposes only and
* do not modify the License. You may add Your own attribution
* notices within Derivative Works that You distribute, alongside
* or as an addendum to the NOTICE text from the Work, provided
* that such additional attribution notices cannot be construed
* as modifying the License.
*
* You may add Your own copyright statement to Your modifications and
* may provide additional or different license terms and conditions
* for use, reproduction, or distribution of Your modifications, or
* for any such Derivative Works as a whole, provided Your use,
* reproduction, and distribution of the Work otherwise complies with
* the conditions stated in this License.
*
* 5. Submission of Contributions. Unless You explicitly state otherwise,
* any Contribution intentionally submitted for inclusion in the Work
* by You to the Licensor shall be under the terms and conditions of
* this License, without any additional terms or conditions.
* Notwithstanding the above, nothing herein shall supersede or modify
* the terms of any separate license agreement you may have executed
* with Licensor regarding such Contributions.
*
* 6. Trademarks. This License does not grant permission to use the trade
* names, trademarks, service marks, or product names of the Licensor,
* except as required for reasonable and customary use in describing the
* origin of the Work and reproducing the content of the NOTICE file.
*
* 7. Disclaimer of Warranty. Unless required by applicable law or
* agreed to in writing, Licensor provides the Work (and each
* Contributor provides its Contributions) on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
* implied, including, without limitation, any warranties or conditions
* of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
* PARTICULAR PURPOSE. You are solely responsible for determining the
* appropriateness of using or redistributing the Work and assume any
* risks associated with Your exercise of permissions under this License.
*
* 8. Limitation of Liability. In no event and under no legal theory,
* whether in tort (including negligence), contract, or otherwise,
* unless required by applicable law (such as deliberate and grossly
* negligent acts) or agreed to in writing, shall any Contributor be
* liable to You for damages, including any direct, indirect, special,
* incidental, or consequential damages of any character arising as a
* result of this License or out of the use or inability to use the
* Work (including but not limited to damages for loss of goodwill,
* work stoppage, computer failure or malfunction, or any and all
* other commercial damages or losses), even if such Contributor
* has been advised of the possibility of such damages.
*
* 9. Accepting Warranty or Additional Liability. While redistributing
* the Work or Derivative Works thereof, You may choose to offer,
* and charge a fee for, acceptance of support, warranty, indemnity,
* or other liability obligations and/or rights consistent with this
* License. However, in accepting such obligations, You may act only
* on Your own behalf and on Your sole responsibility, not on behalf
* of any other Contributor, and only if You agree to indemnify,
* defend, and hold each Contributor harmless for any liability
* incurred by, or claims asserted against, such Contributor by reason
* of your accepting any such warranty or additional liability.
*
* END OF TERMS AND CONDITIONS
*
* APPENDIX: How to apply the Apache License to your work.
*
* To apply the Apache License to your work, attach the following
* boilerplate notice, with the fields enclosed by brackets "[]"
* replaced with your own identifying information. (Don't include
* the brackets!) The text should be enclosed in the appropriate
* comment syntax for the file format. We also recommend that a
* file or class name and description of purpose be included on the
* same "printed page" as the copyright notice for easier
* identification within third-party archives.
*
* Copyright 2016 Alibaba Group
*
* 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.taobao.weex.ui.view.gesture;
import android.content.Context;
import android.graphics.Point;
import android.graphics.PointF;
import android.graphics.Rect;
import android.os.Looper;
import android.support.annotation.NonNull;
import android.view.GestureDetector;
import android.view.MotionEvent;
import android.view.View;
import android.view.View.OnTouchListener;
import com.alibaba.fastjson.JSONArray;
import com.alibaba.fastjson.JSONObject;
import com.taobao.weex.WXSDKManager;
import com.taobao.weex.ui.component.WXComponent;
import com.taobao.weex.ui.view.gesture.WXGestureType.GestureInfo;
import com.taobao.weex.ui.view.gesture.WXGestureType.HighLevelGesture;
import com.taobao.weex.ui.view.gesture.WXGestureType.LowLevelGesture;
import com.taobao.weex.utils.WXLogUtils;
import com.taobao.weex.utils.WXViewUtils;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class WXGesture implements OnTouchListener {
private final static String TAG = "Gesture";
private static final int CUR_EVENT = -1;
private WXComponent component;
private GestureDetector mGestureDetector;
private Rect globalRect;
private Point globalOffset;
private Point globalEventOffset;
private PointF locEventOffset;
private PointF locLeftTop;
private boolean scrolling;
public WXGesture(WXComponent wxComponent, Context context) {
this.component = wxComponent;
globalRect = new Rect();
globalOffset = new Point();
globalEventOffset = new Point();
locEventOffset = new PointF();
locLeftTop = new PointF();
mGestureDetector = new GestureDetector(context, new GestureListener(), new GestureHandler());
}
@Override
public boolean onTouch(View v, MotionEvent event) {
try {
boolean result = mGestureDetector.onTouchEvent(event);
switch (event.getActionMasked()) {
case MotionEvent.ACTION_POINTER_DOWN:
case MotionEvent.ACTION_DOWN:
result |= handleMotionEvent(LowLevelGesture.ACTION_DOWN, event);
break;
case MotionEvent.ACTION_MOVE:
result |= handleMotionEvent(LowLevelGesture.ACTION_MOVE, event);
break;
case MotionEvent.ACTION_UP:
if (scrolling) {
result |= handleMotionEvent(HighLevelGesture.PAN_END, event);
scrolling = false;
}
result |= handleMotionEvent(LowLevelGesture.ACTION_UP, event);
break;
case MotionEvent.ACTION_POINTER_UP:
result |= handleMotionEvent(LowLevelGesture.ACTION_UP, event);
break;
case MotionEvent.ACTION_CANCEL:
result |= handleMotionEvent(LowLevelGesture.ACTION_CANCEL, event);
break;
}
return result;
} catch (Exception e) {
WXLogUtils.e("Gesture RunTime Error ", e);
return false;
}
}
/**
* Handle low-level gesture
* @param WXGestureType possible low-level gesture, defined in {@link com.taobao.weex.common.Constants.Event}
* @param motionEvent motionEvent, which contains all pointers event in a period of time
* @return true if this event is handled, otherwise false.
*/
private boolean handleMotionEvent(WXGestureType WXGestureType, MotionEvent motionEvent) {
if (component.containsGesture(WXGestureType)) {
List<Map<String, Object>> list = createFireEventParam(motionEvent);
for (Map<String, Object> map : list) {
component.getInstance().fireEvent(component.getDomObject().getRef(),
WXGestureType.toString(), map);
}
return true;
} else {
return false;
}
}
/**
* Create a list of event for {@link com.taobao.weex.WXSDKInstance#fireEvent(String, String, Map, Map)}.
* As there is a batch mechanism in MotionEvent, so this method returns a list.
* @param motionEvent motionEvent, which contains all pointers event in a period of time
* @return List of Map, which contains touch object.
*/
private List<Map<String, Object>> createFireEventParam(MotionEvent motionEvent) {
List<Map<String, Object>> list = new ArrayList<>(motionEvent.getHistorySize() + 1);
list.addAll(getHistoricalEvents(motionEvent));
list.add(createFireEventParam(motionEvent, CUR_EVENT));
return list;
}
/**
* Get historical event. This is only applied to {@link MotionEvent#ACTION_MOVE}.
* For other types of motionEvent, historical event is meaningless.
* @param motionEvent motionEvent, which contains all pointers event in a period of time
* @return If motionEvent.getActionMasked()!=MotionEvent.ACTION_MOVE,
* this method will return an empty list.
* Otherwise this method will return the historical motionEvent, which may also be empty.
*/
private List<Map<String, Object>> getHistoricalEvents(MotionEvent motionEvent) {
List<Map<String, Object>> list = new ArrayList<>(motionEvent.getHistorySize());
if (motionEvent.getActionMasked() == MotionEvent.ACTION_MOVE) {
Map<String, Object> param;
for (int i = 0; i < motionEvent.getHistorySize(); i++) {
param = createFireEventParam(motionEvent, i);
list.add(param);
}
}
return list;
}
/**
* Create a map represented touch event at a certain moment.
* @param motionEvent motionEvent, which contains all pointers event in a period of time
* @param pos index used to retrieve a certain moment in a period of time.
* @return touchEvent
* @see <a href="https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent">touchEvent</a>
*/
private Map<String, Object> createFireEventParam(MotionEvent motionEvent, int pos) {
JSONArray jsonArray = new JSONArray(motionEvent.getPointerCount());
if (motionEvent.getActionMasked() == MotionEvent.ACTION_MOVE) {
for (int i = 0; i < motionEvent.getPointerCount(); i++) {
jsonArray.add(createJSONObject(motionEvent, pos, i));
}
} else if (isPointerNumChanged(motionEvent)) {
int pointerIndex = motionEvent.getActionIndex();
jsonArray.add(createJSONObject(motionEvent, CUR_EVENT, pointerIndex));
}
Map<String, Object> map = new HashMap<>();
map.put(GestureInfo.HISTORICAL_XY, jsonArray);
return map;
}
/**
* Tell whether the number of motion event's pointer changed.
* @param event the current motion event
* @return true for number of motion event's pointer changed, otherwise false.
*/
private boolean isPointerNumChanged(MotionEvent event) {
return event.getActionMasked() == MotionEvent.ACTION_DOWN ||
event.getActionMasked() == MotionEvent.ACTION_POINTER_DOWN ||
event.getActionMasked() == MotionEvent.ACTION_UP ||
event.getActionMasked() == MotionEvent.ACTION_POINTER_UP ||
event.getActionMasked() == MotionEvent.ACTION_CANCEL;
}
/**
* Tell whether component contains pan gesture
* @return true for contains pan gesture, otherwise false.
*/
private boolean containsPan() {
return component.containsGesture(HighLevelGesture.PAN_START) ||
component.containsGesture(HighLevelGesture.PAN_MOVE) ||
component.containsGesture(HighLevelGesture.PAN_END);
}
/**
* Create a touchObject for a pointer at a certain moment.
* @param motionEvent motionEvent, which contains all pointers event in a period of time
* @param pos index used to retrieve a certain moment in a period of time.
* @param pointerIndex pointerIndex
* @return JSONObject represent a touch event
* @see <a href="https://developer.mozilla.org/en-US/docs/Web/API/Touch">touch</a>
*/
private JSONObject createJSONObject(MotionEvent motionEvent, int pos, int pointerIndex) {
PointF screenXY, pageXY;
if (pos == CUR_EVENT) {
pageXY = getEventLocInPageCoordinate(motionEvent, pointerIndex);
screenXY = getEventLocInScreenCoordinate(motionEvent, pointerIndex);
} else {
pageXY = getEventLocInPageCoordinate(motionEvent, pointerIndex, pos);
screenXY = getEventLocInScreenCoordinate(motionEvent, pointerIndex, pos);
}
return createJSONObject(screenXY, pageXY, (float) motionEvent.getPointerId(pointerIndex));
}
/**
* Create a touchObject for a pointer at a certain moment.
* @param screenXY the point of event happened in screen coordinate
* @param pageXY the point of event happened in page coorindate
* @param pointerId pointerIndex pointerIndex
* @return JSONObject represent a touch event
* @see <a href="https://developer.mozilla.org/en-US/docs/Web/API/Touch">touch</a>
*/
@NonNull
private JSONObject createJSONObject(PointF screenXY, PointF pageXY, float pointerId) {
JSONObject jsonObject = new JSONObject();
jsonObject.put(GestureInfo.PAGE_X, pageXY.x);
jsonObject.put(GestureInfo.PAGE_Y, pageXY.y);
jsonObject.put(GestureInfo.SCREEN_X, screenXY.x);
jsonObject.put(GestureInfo.SCREEN_Y, screenXY.y);
jsonObject.put(GestureInfo.POINTER_ID, pointerId);
return jsonObject;
}
/**
* @see {@link #getEventLocInScreenCoordinate(MotionEvent, int, int)}
*/
private PointF getEventLocInScreenCoordinate(MotionEvent motionEvent, int pointerIndex) {
return getEventLocInScreenCoordinate(motionEvent, pointerIndex, CUR_EVENT);
}
/**
* Get event location in Screen's coordinate, e.g. root(global) coordinate.
* @see <a href="https://developer.mozilla.org/en-US/docs/Web/API/Touch/screenX">screenX</a>
* @see <a href="https://developer.mozilla.org/en-US/docs/Web/API/Touch/screenY">screenY</a>
* @param motionEvent the original motionEvent
* @param pointerIndex pointerIndex
* @param position if motionEvent.getHistoricalSize()!=0, the is the index of historical event,
* otherwise this is {@link #CUR_EVENT} which indicates historicalSize is zero
* @return the eventLocation in screen's coordinate
*/
private PointF getEventLocInScreenCoordinate(MotionEvent motionEvent, int pointerIndex, int position) {
float eventX, eventY;
if (position == CUR_EVENT) {
eventX = motionEvent.getX(pointerIndex);
eventY = motionEvent.getY(pointerIndex);
} else {
eventX = motionEvent.getHistoricalX(pointerIndex, position);
eventY = motionEvent.getHistoricalY(pointerIndex, position);
}
return getEventLocInScreenCoordinate(eventX, eventY);
}
/**
* Get event location in Screen's coordinate, e.g. root(global) coordinate.
* @param eventX {@link MotionEvent#getX()} or {@link MotionEvent#getHistoricalX(int, int)}
* @param eventY {@link MotionEvent#getX()} or {@link MotionEvent#getHistoricalX(int, int)}
* @return the eventLocation in screen's coordinate
* @see {@link #getEventLocInScreenCoordinate(MotionEvent, int, int)}
*/
@NonNull
private PointF getEventLocInScreenCoordinate(float eventX, float eventY) {
globalRect.set(0, 0, 0, 0);
globalOffset.set(0, 0);
globalEventOffset.set((int) eventX, (int) eventY);
component.getRealView().getGlobalVisibleRect(globalRect, globalOffset);
globalEventOffset.offset(globalOffset.x, globalOffset.y);
return new PointF(WXViewUtils.getWebPxByWidth(globalEventOffset.x),
WXViewUtils.getWebPxByWidth(globalEventOffset.y));
}
/**
* @see {@link #getEventLocInPageCoordinate(MotionEvent, int, int)}
*/
private PointF getEventLocInPageCoordinate(MotionEvent motionEvent, int pointerIndex) {
return getEventLocInPageCoordinate(motionEvent, pointerIndex, CUR_EVENT);
}
/**
* Get event's location in Document's (Page) coordinate.
* @see <a href="https://developer.mozilla.org/en-US/docs/Web/API/Touch/pageX">pageX</a>
* @see <a href="https://developer.mozilla.org/en-US/docs/Web/API/Touch/pageY">pageY</a>
* @param motionEvent the original motionEvent
* @param pointerIndex pointerIndex
* @param position if motionEvent.getHistoricalSize()!=0, the is the index of historical event,
* otherwise this is {@link #CUR_EVENT} which indicates historicalSize is zero
* @return the event location in page's coordinate.
*/
private PointF getEventLocInPageCoordinate(MotionEvent motionEvent, int pointerIndex, int position) {
float eventX, eventY;
if (position == CUR_EVENT) {
eventX = motionEvent.getX(pointerIndex);
eventY = motionEvent.getY(pointerIndex);
} else {
eventX = motionEvent.getHistoricalX(pointerIndex, position);
eventY = motionEvent.getHistoricalY(pointerIndex, position);
}
return getEventLocInPageCoordinate(eventX, eventY);
}
/**
* Get event's location in Document's (Page) coordinate.
* @param eventX {@link MotionEvent#getX()} or {@link MotionEvent#getHistoricalX(int, int)}
* @param eventY {@link MotionEvent#getX()} or {@link MotionEvent#getHistoricalX(int, int)}
* @return the event location in page's coordinate.
* @see {@link #getEventLocInPageCoordinate(MotionEvent, int, int)}
*/
@NonNull
private PointF getEventLocInPageCoordinate(float eventX, float eventY) {
locEventOffset.set(eventX, eventY);
locLeftTop.set(0, 0);
component.computeVisiblePointInViewCoordinate(locLeftTop);
locEventOffset.offset(locLeftTop.x, locLeftTop.y);
return new PointF(WXViewUtils.getWebPxByWidth(locEventOffset.x),
WXViewUtils.getWebPxByWidth(locEventOffset.y));
}
private static class GestureHandler extends android.os.Handler {
public GestureHandler() {
super(Looper.getMainLooper());
}
}
private class GestureListener extends GestureDetector.SimpleOnGestureListener {
private long swipeDownTime = -1;
private long panDownTime = -1;
@Override
public void onLongPress(MotionEvent e) {
if (component.containsGesture(HighLevelGesture.LONG_PRESS)) {
List<Map<String, Object>> list = createFireEventParam(e);
component.getInstance().fireEvent(
component.getDomObject().getRef(),
HighLevelGesture.LONG_PRESS.toString(),
list.get(list.size() - 1));
}
}
@Override
public boolean onScroll(MotionEvent e1, MotionEvent e2, float distanceX, float distanceY) {
boolean result = false;
if (containsPan() &&
(e2.getPointerId(e1.getActionIndex()) == e1.getPointerId(e1.getActionIndex()))) {
if (panDownTime != e1.getEventTime()) {
panDownTime = e1.getEventTime();
scrolling = true;
component.getInstance().fireEvent(
component.getDomObject().getRef(), HighLevelGesture.PAN_START.toString(),
createFireEventParam(e1, CUR_EVENT));
} else {
component.getInstance().fireEvent(
component.getDomObject().getRef(), HighLevelGesture.PAN_MOVE.toString(),
createFireEventParam(e2, CUR_EVENT));
}
result = true;
}
if (component.containsGesture(HighLevelGesture.SWIPE)) {
if (swipeDownTime != e1.getEventTime()) {
swipeDownTime = e1.getEventTime();
List<Map<String, Object>> list = createFireEventParam(e2);
Map<String, Object> param = list.get(list.size() - 1);
if (Math.abs(distanceX) > Math.abs(distanceY)) {
param.put(GestureInfo.DIRECTION, distanceX > 0 ? "left" : "right");
} else {
param.put(GestureInfo.DIRECTION, distanceY > 0 ? "up" : "down");
}
component.getInstance().fireEvent( component.getDomObject().getRef(),
HighLevelGesture.SWIPE.toString(), param);
result = true;
}
}
return result;
}
@Override
public boolean onDown(MotionEvent e) {
return true;
}
}
}