1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
---
title: Event.cancelable
slug: Web/API/Event/cancelable
tags:
- API
- DOM
- DOM Reference
- Event
- Property
- Read-only
- Reference
- イベント
- プロパティ
- 読み取り専用
translation_of: Web/API/Event/cancelable
---
<div>{{ ApiRef("DOM") }}</div>
<p><span class="seoSummary">The <strong><dfn><code>cancelable</code></dfn></strong> は {{domxref("Event")}} インターフェイスの読み取り専用プロパティで、イベントがキャンセル可能かどうか、イベントが発生しないように抑止することができるかを示します。</span>イベントがキャンセルでき<em>ない</em>場合、 <code>cancelable</code> プロパティは <code>false</code> となり、イベントが発生することをイベントリスナーが抑止することができないことを示します。</p>
<p>複数の種類のイベントを扱うイベントリスナーは、 {{domxref("event.preventDefault", "preventDefault()")}} メソッドを呼び出す前に <code>cancelable</code> をチェックしたほうが良いかもしれません。</p>
<p>ブラウザーネイティブのイベントのうち、キャンセル可能なもののほとんどは、ユーザーのページとの対話の結果から発生したものです。 {{domxref("Element/click_event", "click")}}, {{domxref("Document/scroll_event", "scroll")}}, {{domxref("Window/beforeunload_event", "beforeunload")}} の各イベントをキャンセルすると、それぞれユーザーが何かをクリックすること、ページをスクロールすること、他のページに移動することをそれぞれ抑止することができます。</p>
<p>その他の JavaScript によって作成された<a href="/ja/docs/Web/API/Event/Event">カスタムイベント</a>は、作成時にキャンセル可能であるかどうかを制御します。</p>
<h2 id="Syntax" name="Syntax">構文</h2>
<pre class="syntaxbox"><var>bool</var> = <em>event</em>.cancelable;
</pre>
<h3 id="Value" name="Value">値</h3>
<p>結果は {{domxref("Boolean")}} で、イベントがキャンセル可能であれば <code>true</code> です。</p>
<h2 id="Example" name="Example">例</h2>
<p>例えば、ブラウザーベンダーは {{domxref("Document/wheel_event", "wheel")}} イベントが、<a href="https://github.com/WICG/interventions/issues/33" rel="external">最初にリスナーが呼び出されたとき</a>のみキャンセル可能にしようと提案しています。 — その後の <code>wheel</code> イベントはキャンセルできません。</p>
<pre class="brush:js">function preventScrollWheel(event) {
if (typeof event.cancelable !== 'boolean' || event.cancelable) {
// The event can be canceled, so we do so.
event.preventDefault();
} else {
// The event cannot be canceled, so it is not safe
// to call preventDefault() on it.
console.warn(`The following event couldn't be canceled:`);
console.dir(event);
}
}
document.addEventListener('wheel', preventScrollWheel);
</pre>
<h2 id="Notes" name="Notes">メモ</h2>
<p>イベントがキャンセル可能か不可能かは、イベントが初期化されたときに決定されます。</p>
<p>イベントをキャンセルするには、イベントの {{domxref("event.preventDefault", "preventDefault()")}} メソッドを呼び出してください。これはイベントに関連付けられた既定の動作を実行する実装を維持します。</p>
<h2 id="Specifications" name="Specifications">仕様書</h2>
<table class="standard-table">
<thead>
<tr>
<th scope="col">仕様書</th>
<th scope="col">状態</th>
<th scope="col">備考</th>
</tr>
</thead>
<tbody>
<tr>
<td>{{SpecName('DOM WHATWG', '#dom-event-cancelable', 'Event.cancelable')}}</td>
<td>{{ Spec2('DOM WHATWG') }}</td>
<td></td>
</tr>
<tr>
<td>{{SpecName('DOM2 Events', '#Events-Event-canCancel', 'Event.cancelable')}}</td>
<td>{{ Spec2('DOM2 Events') }}</td>
<td>初回定義</td>
</tr>
</tbody>
</table>
<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザーの互換性</h2>
<div class="hidden">このページの互換性一覧表は構造化データから生成されています。データに協力していただけるのであれば、 <a class="external" href="https://github.com/mdn/browser-compat-data">https://github.com/mdn/browser-compat-data</a> をチェックアウトしてプルリクエストを送信してください。</div>
<p>{{Compat("api.Event.cancelable")}}</p>
|
