cstd

<!DOCTYPE html> <html> <head> <meta charset='UTF-8'> <title>CoffeeScript standarts</title> <script src='../javascript/application.js'></script> <script src='../javascript/search.js'></script> <link rel='stylesheet' href='../stylesheets/application.css' type='text/css'> </head> <body> <div id='base' data-path='../'></div> <div id='header'> <div id='menu'> <a href='../extra/README.md.html' title='CSTD'> CSTD </a> » <a href='../alphabetical_index.html' title='Index'> Index </a> » <span class='title'>CSEmitter</span> </div> </div> <div id='content'> <h1> Class: CSEmitter </h1> <table class='box'> <tr> <td>Defined in:</td> <td>lib/emitter.coffee</td> </tr> <tr> <td>Inherits:</td> <td> <a href='../class/CSObject.html'>CSObject</a> </td> </tr> </table> <h2>Overview</h2> <div class='docstring'> <p>abstract class CSEmitter for child class</p> </div> <div class='tags'> </div> <h2>Instance Method Summary</h2> <ul class='summary'> <li> <span class='signature'> <a href='#destructor-dynamic'> # (null) <b>destructor</b><span>()</span> </a> </span> <span class='desc'> destructor clear all handlers, and clean map and links </span> </li> <li> <span class='signature'> <a href='#on-dynamic'> # (CSEmitter) <b>on</b><span>(name, handler)</span> </a> </span> <span class='desc'> Add event listener <code>handler</code> by <code>name</code> event. </span> </li> <li> <span class='signature'> <a href='#off-dynamic'> # (CSEmitter|null) <b>off</b><span>(name, handler)</span> </a> </span> <span class='desc'> Remove listener <code>handler</code> for event <code>name</code> by this object. </span> </li> <li> <span class='signature'> <a href='#once-dynamic'> # (CSEmitter) <b>once</b><span>(name, handler)</span> </a> </span> <span class='desc'> Same as the <code>on</code>, but handler call only one and before regular handlers </span> </li> <li> <span class='signature'> <a href='#emit-dynamic'> # (Object<__DedicatedArray, CSEvent>) <b>emit</b><span>(nameOrEvent)</span> </a> </span> <span class='desc'> Emit event by name or by event. </span> </li> </ul> <h2> <small>Inherited Method Summary</small> <h3 class='inherited'> Methods inherited from <a href='../class/CSObject.html'>CSObject</a> </h3> <p class='inherited'> <a href='../class/CSObject.html#destructor-dynamic'>#destructor</a> </p> </h2> <h2>Constructor Details</h2> <div class='methods'> <div class='method_details'> <p class='signature' id='constructor-dynamic'> # (void) <b>constructor</b><span>(list)</span> <br> </p> <div class='docstring'> <div class='abstract note'> <strong> This method is abstract. </strong> </div> <p>Init map by array of emit names</p> </div> <div class='tags'> <h3>Parameters:</h3> <ul class='param'> <li> <span class='name'>list</span> <span class='type'> ( <tt>Array<String></tt> ) </span> — <span class='desc'>is array of natural events </span> </li> </ul> <h3>Throws:</h3> <ul class='throw'> <li> <span class='type'></span> ( <tt>TypeError</tt> ) — <span class='desc'>if call from <code>new</code> </span> </li> </ul> </div> </div> </div> <h2>Instance Method Details</h2> <div class='methods'> <div class='method_details'> <p class='signature' id='destructor-dynamic'> # (null) <b>destructor</b><span>()</span> <br> </p> <div class='docstring'> <p>destructor clear all handlers, and clean map and links</p> </div> <div class='tags'> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> <tt>null</tt> </li> </ul> </div> </div> <div class='method_details'> <p class='signature' id='on-dynamic'> # (CSEmitter) <b>on</b><span>(name, handler)</span> <br> </p> <div class='docstring'> <p>Add event listener <code>handler</code> by <code>name</code> event.</p><p>@callback <a href='../class/CSEvent.html'>CSEvent</a> call with CSEvent object</p> </div> <div class='tags'> <h3>Parameters:</h3> <ul class='param'> <li> <span class='name'>name</span> <span class='type'> ( <tt>String</tt> ) </span> — <span class='desc'>name of a event handle that </span> </li> <li> <span class='name'>handler</span> <span class='type'> ( <tt>Function</tt> ) </span> — <span class='desc'>function, call when fired event </span> </li> </ul> <h3>Throws:</h3> <ul class='throw'> <li> <span class='type'></span> ( <tt>Error</tt> ) — <span class='desc'>if no arguments </span> </li> <li> <span class='type'></span> ( <tt>TypeError</tt> ) — <span class='desc'>if <code>name</code> not a String or <code>handler</code> not a Function </span> </li> <li> <span class='type'></span> ( <tt>TypeError</tt> ) — <span class='desc'>if <code>handler</code> not passed </span> </li> </ul> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> ( <tt><a href='../class/CSEmitter.html'>CSEmitter</a></tt> ) — <span class='desc'><code>this</code> </span> </li> </ul> </div> </div> <div class='method_details'> <p class='signature' id='off-dynamic'> # (CSEmitter|null) <b>off</b><span>(name, handler)</span> <br> </p> <div class='docstring'> <p>Remove listener <code>handler</code> for event <code>name</code> by this object. If <code>handler</code> not passed, remove all handlers by <code>name</code> event type. Return <code>null</code> if handler not found.</p> </div> <div class='tags'> <h3>Parameters:</h3> <ul class='param'> <li> <span class='name'>name</span> <span class='type'> ( <tt>String</tt> ) </span> — <span class='desc'>string, name of disable events </span> </li> <li> <span class='name'>handler</span> <span class='type'> ( <tt>Function</tt> ) </span> — <span class='desc'>function, if pass argument, clear only <code>handler</code> </span> </li> </ul> <h3>Throws:</h3> <ul class='throw'> <li> <span class='type'></span> ( <tt>Error</tt> ) — <span class='desc'>if no arguments </span> </li> <li> <span class='type'></span> ( <tt>TypeError</tt> ) — <span class='desc'>if <code>name</code> not a String or <code>handler</code> not a Function </span> </li> <li> <span class='type'></span> ( <tt>Error</tt> ) — <span class='desc'>if <code>name</code> is unknown type event </span> </li> </ul> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> ( <tt>CSEmitter|null</tt> ) — <span class='desc'><code>this</code> or <code>handler</code> not found indicator </span> </li> </ul> </div> </div> <div class='method_details'> <p class='signature' id='once-dynamic'> # (CSEmitter) <b>once</b><span>(name, handler)</span> <br> </p> <div class='docstring'> <p>Same as the <code>on</code>, but handler call only one and before regular handlers</p> </div> <div class='tags'> <h3>Parameters:</h3> <ul class='param'> <li> <span class='name'>`name`</span> <span class='type'> ( <tt>String</tt> ) </span> — <span class='desc'>string </span> </li> <li> <span class='name'>handler</span> <span class='type'> ( <tt>Function</tt> ) </span> — <span class='desc'>listener </span> </li> </ul> <h3>Throws:</h3> <ul class='throw'> <li> <span class='type'></span> ( <tt>Error</tt> ) — <span class='desc'>if no arguments </span> </li> <li> <span class='type'></span> ( <tt>TypeError</tt> ) — <span class='desc'>if <code>name</code> not a String or <code>handler</code> not a Function </span> </li> <li> <span class='type'></span> ( <tt>TypeError</tt> ) — <span class='desc'>if <code>handler</code> not pass </span> </li> </ul> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> ( <tt><a href='../class/CSEmitter.html'>CSEmitter</a></tt> ) — <span class='desc'><code>this</code> </span> </li> </ul> </div> </div> <div class='method_details'> <p class='signature' id='emit-dynamic'> # (Object<__DedicatedArray, CSEvent>) <b>emit</b><span>(nameOrEvent)</span> <br> </p> <div class='docstring'> <div class='abstract note'> <strong> This method is abstract. </strong> </div> <p>Emit event by name or by event. if <code>nameOrEvent</code> is string than CSEvent create by func without value</p> </div> <div class='tags'> <h3>Parameters:</h3> <ul class='param'> <li> <span class='name'>nameOrEvent</span> <span class='type'> ( <tt>String|CSEvent</tt> ) </span> — <span class='desc'>type event or event (CSEvent) </span> </li> </ul> <h3>Throws:</h3> <ul class='throw'> <li> <span class='type'></span> ( <tt>Error</tt> ) — <span class='desc'>if call without realisation </span> </li> <li> <span class='type'></span> ( <tt>TypeError</tt> ) — <span class='desc'>if <code>nameOrEvent</code> unknown type </span> </li> <li> <span class='type'></span> ( <tt>Error</tt> ) — <span class='desc'>if try call unknown name of event </span> </li> </ul> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> ( <tt>Object<__DedicatedArray, CSEvent></tt> ) — <span class='desc'>for internal usage </span> </li> </ul> </div> </div> </div> </div> <div id='footer'> By <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'> Codo </a> 2.1.0 ✲ Press H to see the keyboard shortcuts ✲ <a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a> ✲ <a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a> </div> <iframe id='search_frame'></iframe> <div id='fuzzySearch'> <input type='text'> <ol></ol> </div> <div id='help'> <p> Quickly fuzzy find classes, mixins, methods, file: </p> <ul> <li> <span>T</span> Open fuzzy finder dialog </li> </ul> <p> Control the navigation frame: </p> <ul> <li> <span>L</span> Toggle list view </li> <li> <span>C</span> Show class list </li> <li> <span>I</span> Show mixin list </li> <li> <span>F</span> Show file list </li> <li> <span>M</span> Show method list </li> <li> <span>E</span> Show extras list </li> </ul> <p> You can focus and blur the search input: </p> <ul> <li> <span>S</span> Focus search input </li> <li> <span>Esc</span> Blur search input </li> </ul> </div> </body> </html>