Skip to content

UIGestureRecognizer:cancelled 事件 ​

cancelled 事件在连续手势被打断时派发。

语法 ​

addEventListener('cancelled', (event) => { })

事件对象 ​

事件对象的类型是 UIGestureRecognizerEvent,除了 type 和 target,还带两个只读字段:

字段类型含义
locationCGPoint 或 null手势的位置,在识别器所在视图的坐标系里,单位 pt。多根手指时是它们的中心点。要换算到别的视图,用视图的 convertPoint()
numberOfTouches数事件发生时参与手势的手指个数

三种识别器的事件对象各多两个只读字段,都是事件发生那一刻的值:

识别器事件对象的类型字段类型含义
UIPanGestureRecognizer、UIScreenEdgePanGestureRecognizerUIPanGestureRecognizerEventtranslationCGPoint从手势开始到这个事件为止手指移动了多少,在识别器所在视图的坐标系里,单位 pt
velocityCGPoint手指移动的速度,坐标系同上,单位是 pt 每秒
UIPinchGestureRecognizerUIPinchGestureRecognizerEventscale数两指的间距相对手势开始时的倍数
velocity数scale 每秒变化多少
UIRotationGestureRecognizerUIRotationGestureRecognizerEventrotation数相对手势开始时转过的角度,单位是弧度
velocity数旋转的速度,单位是弧度每秒

回调参数的类型声明是 Event,读这些字段要转一下类型,见示例。这些值只能从事件对象上读:回调比手势晚执行,回头在识别器上读不到当时的值。

不能取消:preventDefault() 没有效果。事件只派发给识别器自己,不传给视图或父视图。

什么时候派发 ​

  • 长按进行中 App 退到后台时派发(真机实测)。
  • 长按进行中识别器的 isEnabled 被设成 false 时也应当派发,未在模拟器验证。
  • 点按和轻扫不派发。
  • 派发了 cancelled 的手势不再派发 ended。手势进行中改了界面的,在这里恢复。

示例 ​

js
const card = new UIView();
const press = new UILongPressGestureRecognizer();
press.addEventListener('began', () => {
  card.alpha = 0.6;
});
const restore = () => {
  card.alpha = 1;
};
press.addEventListener('ended', restore);
press.addEventListener('cancelled', restore);
card.addGestureRecognizer(press);

效果:按住 card 0.5 秒后它变淡。松手,或者长按被打断,都恢复不透明。透明度的变化未在模拟器验证。

对应的 iOS API ​

UIGestureRecognizerStateCancelled。原生的 action 方法收到所有阶段,在方法里判断 state;这里监听 'cancelled'。

参见 ​