docs/window-utils.html

   1 <!DOCTYPE html>  <html> <head>   <title>window-utils.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 &hellip;         <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>               window-utils.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">&#182;</a>               </div>               <p>Waits for a browser window to finish loading before running the callback</p>
   2
   3 <p>@usage runOnLoad(window, callback): Apply a callback to to run on a window when it loads.
   4 @param [function] callback: 1-parameter function that gets a browser window.
   5 @param [function] winType: a parameter that defines what kind of window is "browser window".</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="nv">runOnLoad = </span><span class="nf">(window, callback, winType) -&gt;</span></pre></div>             </td>           </tr>                               <tr id="section-2">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-2">&#182;</a>               </div>               <p>Listen for one load event before checking the window type</p>             </td>             <td class="code">               <div class="highlight"><pre>  <span class="nv">cb = </span><span class="o">-&gt;</span>
   6     <span class="nb">window</span><span class="p">.</span><span class="nx">removeEventListener</span> <span class="s">&quot;load&quot;</span><span class="p">,</span> <span class="nx">arguments</span><span class="p">.</span><span class="nx">callee</span><span class="p">,</span> <span class="kc">false</span></pre></div>             </td>           </tr>                               <tr id="section-3">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-3">&#182;</a>               </div>               <p>Now that the window has loaded, only handle browser windows</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="k">if</span> <span class="nb">window</span><span class="p">.</span><span class="nb">document</span><span class="p">.</span><span class="nx">documentElement</span><span class="p">.</span><span class="nx">getAttribute</span><span class="p">(</span><span class="s">&quot;windowtype&quot;</span><span class="p">)</span> <span class="o">==</span> <span class="nx">winType</span>
   7       <span class="nx">callback</span> <span class="nb">window</span>
   8
   9   <span class="nb">window</span><span class="p">.</span><span class="nx">addEventListener</span> <span class="s">&quot;load&quot;</span><span class="p">,</span> <span class="nx">cb</span><span class="p">,</span> <span class="kc">false</span></pre></div>             </td>           </tr>                               <tr id="section-4">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-4">&#182;</a>               </div>               <p>Add functionality to existing browser windows</p>
  10
  11 <p>@usage runOnWindows(callback): Apply a callback to each open browser window.
  12 @param [function] callback: 1-parameter function that gets a browser window.
  13 @param [function] winType: a parameter that defines what kind of window is "browser window".</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="nv">runOnWindows = </span><span class="nf">(callback, winType) -&gt;</span></pre></div>             </td>           </tr>                               <tr id="section-5">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-5">&#182;</a>               </div>               <p>Wrap the callback in a function that ignores failures</p>             </td>             <td class="code">               <div class="highlight"><pre>  <span class="nv">watcher = </span><span class="nf">(window) -&gt;</span> <span class="k">try</span> <span class="nx">callback</span><span class="p">(</span><span class="nb">window</span><span class="p">)</span></pre></div>             </td>           </tr>                               <tr id="section-6">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-6">&#182;</a>               </div>               <p>Add functionality to existing windows</p>             </td>             <td class="code">               <div class="highlight"><pre>  <span class="nv">browserWindows = </span><span class="nx">Services</span><span class="p">.</span><span class="nx">wm</span><span class="p">.</span><span class="nx">getEnumerator</span><span class="p">(</span><span class="nx">winType</span><span class="p">)</span>
  14   <span class="k">while</span> <span class="nx">browserWindows</span><span class="p">.</span><span class="nx">hasMoreElements</span><span class="p">()</span></pre></div>             </td>           </tr>                               <tr id="section-7">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-7">&#182;</a>               </div>               <p>Only run the watcher immediately if the browser is completely loaded</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="nv">browserWindow = </span><span class="nx">browserWindows</span><span class="p">.</span><span class="nx">getNext</span><span class="p">()</span>
  15     <span class="k">if</span> <span class="nx">browserWindow</span><span class="p">.</span><span class="nb">document</span><span class="p">.</span><span class="nx">readyState</span> <span class="o">==</span> <span class="s">&quot;complete&quot;</span>
  16       <span class="nx">watcher</span><span class="p">(</span><span class="nx">browserWindow</span><span class="p">);</span></pre></div>             </td>           </tr>                               <tr id="section-8">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-8">&#182;</a>               </div>               <p>Wait for the window to load before continuing</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="k">else</span>
  17       <span class="nx">runOnLoad</span><span class="p">(</span><span class="nx">browserWindow</span><span class="p">,</span> <span class="nx">watcher</span><span class="p">,</span> <span class="nx">winType</span><span class="p">)</span></pre></div>             </td>           </tr>                               <tr id="section-9">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-9">&#182;</a>               </div>               <p>Apply a callback to each open and new browser windows.</p>
  18
  19 <p>@usage watchWindows(callback): Apply a callback to each browser window.
  20 @param [function] callback: 1-parameter function that gets a browser window.
  21 @param [function] winType: a parameter that defines what kind of window is "browser window".</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="nv">watchWindows = </span><span class="nf">(callback, winType) -&gt;</span></pre></div>             </td>           </tr>                               <tr id="section-10">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-10">&#182;</a>               </div>               <p>Wrap the callback in a function that ignores failures</p>             </td>             <td class="code">               <div class="highlight"><pre>  <span class="nv">watcher = </span><span class="nf">(window) -&gt;</span> <span class="k">try</span> <span class="nx">callback</span><span class="p">(</span><span class="nb">window</span><span class="p">)</span></pre></div>             </td>           </tr>                               <tr id="section-11">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-11">&#182;</a>               </div>               <p>Add functionality to existing windows</p>             </td>             <td class="code">               <div class="highlight"><pre>  <span class="nx">runOnWindows</span> <span class="nx">callback</span><span class="p">,</span> <span class="nx">winType</span></pre></div>             </td>           </tr>                               <tr id="section-12">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-12">&#182;</a>               </div>               <p>Watch for new browser windows opening then wait for it to load</p>             </td>             <td class="code">               <div class="highlight"><pre>  <span class="nv">windowWatcher = </span><span class="nf">(subject, topic) -&gt;</span>
  22     <span class="k">if</span> <span class="nx">topic</span> <span class="o">==</span> <span class="s">&quot;domwindowopened&quot;</span>
  23       <span class="nx">runOnLoad</span> <span class="nx">subject</span><span class="p">,</span> <span class="nx">watcher</span><span class="p">,</span> <span class="nx">winType</span>
  24
  25   <span class="nx">Services</span><span class="p">.</span><span class="nx">ww</span><span class="p">.</span><span class="nx">registerNotification</span> <span class="nx">windowWatcher</span></pre></div>             </td>           </tr>                               <tr id="section-13">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-13">&#182;</a>               </div>               <p>Make sure to stop watching for windows if we're unloading</p>             </td>             <td class="code">               <div class="highlight"><pre>  <span class="nx">unload</span> <span class="o">-&gt;</span> <span class="nx">Services</span><span class="p">.</span><span class="nx">ww</span><span class="p">.</span><span class="nx">unregisterNotification</span><span class="p">(</span><span class="nx">windowWatcher</span><span class="p">)</span>
  26
  27 </pre></div>             </td>           </tr>                </tbody>     </table>   </div> </body> </html>