1 <!DOCTYPE html
> <html> <head> <title>events.coffee
</title> <meta http-equiv=
"content-type" content=
"text/html; charset=UTF-8"> <link rel=
"stylesheet" media=
"all" href=
"docco.css" /> </head> <body> <div id=
"container"> <div id=
"background"></div> <div id=
"jump_to"> Jump To
… <div id=
"jump_wrapper"> <div id=
"jump_page"> <a class=
"source" href=
"bootstrap.html"> bootstrap.coffee
</a> <a class=
"source" href=
"chrome.html"> chrome.coffee
</a> <a class=
"source" href=
"console.html"> console.coffee
</a> <a class=
"source" href=
"unload.html"> unload.coffee
</a> <a class=
"source" href=
"window-utils.html"> window-utils.coffee
</a> <a class=
"source" href=
"button.html"> button.coffee
</a> <a class=
"source" href=
"commands.html"> commands.coffee
</a> <a class=
"source" href=
"events.html"> events.coffee
</a> <a class=
"source" href=
"help.html"> help.coffee
</a> <a class=
"source" href=
"hints.html"> hints.coffee
</a> <a class=
"source" href=
"marker.html"> marker.coffee
</a> <a class=
"source" href=
"prefs.html"> prefs.coffee
</a> <a class=
"source" href=
"utils.html"> utils.coffee
</a> <a class=
"source" href=
"vim.html"> vim.coffee
</a> </div> </div> </div> <table cellpadding=
"0" cellspacing=
"0"> <thead> <tr> <th class=
"docs"> <h1> events.coffee
</h1> </th> <th class=
"code"> </th> </tr> </thead> <tbody> <tr id=
"section-1"> <td class=
"docs"> <div class=
"pilwrap"> <a class=
"pilcrow" href=
"#section-1">¶</a> </div> </td> <td class=
"code"> <div class=
"highlight"><pre><span class=
"nv">utils =
</span><span class=
"nx">require
</span> <span class=
"s">'utils
'</span>
2 <span class=
"p">{
</span> <span class=
"nx">getCommand
</span> <span class=
"p">}
</span> <span class=
"o">=
</span> <span class=
"nx">require
</span> <span class=
"s">'commands
'</span>
3 <span class=
"p">{
</span> <span class=
"nx">Vim
</span> <span class=
"p">}
</span> <span class=
"o">=
</span> <span class=
"nx">require
</span> <span class=
"s">'vim
'</span>
4 <span class=
"p">{
</span> <span class=
"nx">getPref
</span> <span class=
"p">}
</span> <span class=
"o">=
</span> <span class=
"nx">require
</span> <span class=
"s">'prefs
'</span>
6 <span class=
"p">{
</span> <span class=
"nv">interfaces:
</span><span class=
"nx">Ci
</span> <span class=
"p">}
</span> <span class=
"o">=
</span> <span class=
"nx">Components
</span>
8 <span class=
"nv">vimBucket =
</span><span class=
"k">new
</span> <span class=
"nx">utils
</span><span class=
"p">.
</span><span class=
"nx">Bucket
</span> <span class=
"nx">utils
</span><span class=
"p">.
</span><span class=
"nx">getWindowId
</span><span class=
"p">,
</span> <span class=
"nf">(obj) -
></span> <span class=
"k">new
</span> <span class=
"nx">Vim
</span> <span class=
"nx">obj
</span>
10 <span class=
"nv">suppressEvent =
</span><span class=
"nf">(event) -
></span>
11 <span class=
"nx">event
</span><span class=
"p">.
</span><span class=
"nx">preventDefault
</span><span class=
"p">()
</span>
12 <span class=
"nx">event
</span><span class=
"p">.
</span><span class=
"nx">stopPropagation
</span><span class=
"p">()
</span></pre></div> </td> </tr> <tr id=
"section-2"> <td class=
"docs"> <div class=
"pilwrap"> <a class=
"pilcrow" href=
"#section-2">¶</a> </div> <p>The following handlers are installed on every top level DOM window
</p> </td> <td class=
"code"> <div class=
"highlight"><pre><span class=
"nv">handlers =
</span>
13 <span class=
"s">'keydown
'</span><span class=
"o">:
</span> <span class=
"nf">(event) -
></span>
14 <span class=
"k">if
</span> <span class=
"nx">getPref
</span> <span class=
"s">'disabled
'</span>
15 <span class=
"k">return
</span>
17 <span class=
"k">try
</span>
18 <span class=
"nv">isEditable =
</span> <span class=
"nx">utils
</span><span class=
"p">.
</span><span class=
"nx">isElementEditable
</span> <span class=
"nx">event
</span><span class=
"p">.
</span><span class=
"nx">originalTarget
</span>
19 <span class=
"nv">keyStr =
</span><span class=
"nx">utils
</span><span class=
"p">.
</span><span class=
"nx">keyboardEventKeyString
</span> <span class=
"nx">event
</span></pre></div> </td> </tr> <tr id=
"section-3"> <td class=
"docs"> <div class=
"pilwrap"> <a class=
"pilcrow" href=
"#section-3">¶</a> </div> <p>We only handle the key if there is no focused editable element
20 or if it's the
<em>Esc
</em> key, which will remote the focus from
21 the currently focused element
</p> </td> <td class=
"code"> <div class=
"highlight"><pre> <span class=
"k">if
</span> <span class=
"nx">keyStr
</span> <span class=
"o">and
</span> <span class=
"p">(
</span><span class=
"nx">keyStr
</span> <span class=
"o">==
</span> <span class=
"s">'Esc
'</span> <span class=
"o">or
</span> <span class=
"o">not
</span> <span class=
"nx">isEditable
</span><span class=
"p">)
</span>
22 <span class=
"k">if
</span> <span class=
"nb">window
</span> <span class=
"o">=
</span> <span class=
"nx">utils
</span><span class=
"p">.
</span><span class=
"nx">getCurrentTabWindow
</span> <span class=
"nx">event
</span>
23 <span class=
"k">if
</span> <span class=
"nx">vimBucket
</span><span class=
"p">.
</span><span class=
"nx">get
</span><span class=
"p">(
</span><span class=
"nb">window
</span><span class=
"p">)
</span><span class=
"o">?
</span><span class=
"p">.
</span><span class=
"nx">pushKey
</span> <span class=
"nx">keyStr
</span>
24 <span class=
"nx">suppressEvent
</span> <span class=
"nx">event
</span>
25 <span class=
"k">catch
</span> <span class=
"nx">err
</span>
26 <span class=
"nx">console
</span><span class=
"p">.
</span><span class=
"nx">log
</span> <span class=
"nx">err
</span>
28 <span class=
"s">'keypress
'</span><span class=
"o">:
</span> <span class=
"nf">(event) -
></span>
29 <span class=
"k">if
</span> <span class=
"nx">getPref
</span> <span class=
"s">'disabled
'</span>
30 <span class=
"k">return
</span>
32 <span class=
"k">try
</span></pre></div> </td> </tr> <tr id=
"section-4"> <td class=
"docs"> <div class=
"pilwrap"> <a class=
"pilcrow" href=
"#section-4">¶</a> </div> <p>Try to execute keys that were accumulated so far.
33 Suppress event if there is a matching command.
</p> </td> <td class=
"code"> <div class=
"highlight"><pre> <span class=
"k">if
</span> <span class=
"nb">window
</span> <span class=
"o">=
</span> <span class=
"nx">utils
</span><span class=
"p">.
</span><span class=
"nx">getCurrentTabWindow
</span> <span class=
"nx">event
</span>
34 <span class=
"k">if
</span> <span class=
"nx">vimBucket
</span><span class=
"p">.
</span><span class=
"nx">get
</span><span class=
"p">(
</span><span class=
"nb">window
</span><span class=
"p">)
</span><span class=
"o">?
</span><span class=
"p">.
</span><span class=
"nx">execKeys
</span><span class=
"p">()
</span>
35 <span class=
"nx">suppressEvent
</span> <span class=
"nx">event
</span>
36 <span class=
"k">catch
</span> <span class=
"nx">err
</span>
37 <span class=
"nx">console
</span><span class=
"p">.
</span><span class=
"nx">log
</span> <span class=
"nx">err
</span>
39 <span class=
"s">'TabClose
'</span><span class=
"o">:
</span> <span class=
"nf">(event) -
></span>
40 <span class=
"k">if
</span> <span class=
"nv">gBrowser =
</span><span class=
"nx">utils
</span><span class=
"p">.
</span><span class=
"nx">getEventTabBrowser
</span> <span class=
"nx">event
</span>
41 <span class=
"k">if
</span> <span class=
"nv">browser =
</span><span class=
"nx">gBrowser
</span><span class=
"p">.
</span><span class=
"nx">getBrowserForTab
</span> <span class=
"nx">event
</span><span class=
"p">.
</span><span class=
"nx">originalTarget
</span>
42 <span class=
"nx">vimBucket
</span><span class=
"p">.
</span><span class=
"nx">forget
</span> <span class=
"nx">browser
</span><span class=
"p">.
</span><span class=
"nx">contentWindow
</span><span class=
"p">.
</span><span class=
"nx">wrappedJSObject
</span></pre></div> </td> </tr> <tr id=
"section-5"> <td class=
"docs"> <div class=
"pilwrap"> <a class=
"pilcrow" href=
"#section-5">¶</a> </div> <p>When the top level window closes we should release all Vims that were
43 associated with tabs in this window
</p> </td> <td class=
"code"> <div class=
"highlight"><pre> <span class=
"s">'DOMWindowClose
'</span><span class=
"o">:
</span> <span class=
"nf">(event) -
></span>
44 <span class=
"k">if
</span> <span class=
"nv">gBrowser =
</span><span class=
"nx">event
</span><span class=
"p">.
</span><span class=
"nx">originalTarget
</span><span class=
"p">.
</span><span class=
"nx">gBrowser
</span>
45 <span class=
"k">for
</span> <span class=
"nx">tab
</span> <span class=
"k">in
</span> <span class=
"nx">gBrowser
</span><span class=
"p">.
</span><span class=
"nx">tabs
</span>
46 <span class=
"k">if
</span> <span class=
"nv">browser =
</span><span class=
"nx">gBrowser
</span><span class=
"p">.
</span><span class=
"nx">getBrowserForTab
</span> <span class=
"nx">tab
</span>
47 <span class=
"nx">vimBucket
</span><span class=
"p">.
</span><span class=
"nx">forget
</span> <span class=
"nx">browser
</span><span class=
"p">.
</span><span class=
"nx">contentWindow
</span><span class=
"p">.
</span><span class=
"nx">wrappedJSObject
</span>
49 <span class=
"nv">addEventListeners =
</span><span class=
"nf">(window) -
></span>
50 <span class=
"k">for
</span> <span class=
"nx">name
</span><span class=
"p">,
</span> <span class=
"nx">handler
</span> <span class=
"k">of
</span> <span class=
"nx">handlers
</span>
51 <span class=
"nb">window
</span><span class=
"p">.
</span><span class=
"nx">addEventListener
</span> <span class=
"nx">name
</span><span class=
"p">,
</span> <span class=
"nx">handler
</span><span class=
"p">,
</span> <span class=
"kc">true
</span>
53 <span class=
"nv">removeEventListeners =
</span><span class=
"o">-
></span>
54 <span class=
"k">for
</span> <span class=
"nx">name
</span><span class=
"p">,
</span> <span class=
"nx">handler
</span> <span class=
"k">of
</span> <span class=
"nx">handlers
</span>
55 <span class=
"nb">window
</span><span class=
"p">.
</span><span class=
"nx">removeEventListener
</span> <span class=
"nx">name
</span><span class=
"p">,
</span> <span class=
"nx">handler
</span><span class=
"p">,
</span> <span class=
"kc">true
</span>
57 <span class=
"nx">unload
</span> <span class=
"o">-
></span> <span class=
"nx">removeEventListeners
</span> <span class=
"nb">window
</span>
59 <span class=
"nv">exports.addEventListeners =
</span><span class=
"nx">addEventListeners
</span>
61 </pre></div> </td> </tr> </tbody> </table> </div> </body> </html>