mirrors/CyberChef
1
0
Fork 0
mirror of https://github.com/gchq/CyberChef.git synced 2025-04-21 23:36:16 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
CyberChef/docs/RecipeWaiter.html

2973 lines
37 KiB
HTML
Raw Normal View History

Initial pages commit
2016-11-28 11:01:54 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>CyberChef Class: RecipeWaiter</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top navbar-inverse">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand" href="index.html"><img class="branding-logo" src="../build/prod/images/cyberchef-32x32.png"
alt="logo"/>CyberChef</a>
<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<div class="navbar-collapse collapse" id="topNavigation">
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
<ul class="dropdown-menu inline">
<li><a href="FlowControl.html">FlowControl</a></li><li><a href="Utils.html">Utils</a></li><li><a href="Base.html">Base</a></li><li><a href="Base64.html">Base64</a></li><li><a href="BitwiseOp.html">BitwiseOp</a></li><li><a href="ByteRepr.html">ByteRepr</a></li><li><a href="CharEnc.html">CharEnc</a></li><li><a href="Checksum.html">Checksum</a></li><li><a href="Cipher.html">Cipher</a></li><li><a href="Code.html">Code</a></li><li><a href="Compress.html">Compress</a></li><li><a href="Convert.html">Convert</a></li><li><a href="DateTime.html">DateTime</a></li><li><a href="Endian.html">Endian</a></li><li><a href="Entropy.html">Entropy</a></li><li><a href="Extract.html">Extract</a></li><li><a href="FileType.html">FileType</a></li><li><a href="HTML.html">HTML</a></li><li><a href="HTTP.html">HTTP</a></li><li><a href="Hash.html">Hash</a></li><li><a href="Hexdump.html">Hexdump</a></li><li><a href="IP.html">IP</a></li><li><a href="JS.html">JS</a></li><li><a href="MAC.html">MAC</a></li><li><a href="Numberwang.html">Numberwang</a></li><li><a href="OS.html">OS</a></li><li><a href="PublicKey.html">PublicKey</a></li><li><a href="Punycode.html">Punycode</a></li><li><a href="QuotedPrintable.html">QuotedPrintable</a></li><li><a href="Rotate.html">Rotate</a></li><li><a href="SeqUtils.html">SeqUtils</a></li><li><a href="StrUtils.html">StrUtils</a></li><li><a href="Tidy.html">Tidy</a></li><li><a href="URL_.html">URL_</a></li><li><a href="UUID.html">UUID</a></li><li><a href="Unicode.html">Unicode</a></li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
<ul class="dropdown-menu inline">
<li><a href="Chef.html">Chef</a></li><li><a href="Dish.html">Dish</a></li><li><a href="Ingredient.html">Ingredient</a></li><li><a href="Operation.html">Operation</a></li><li><a href="Recipe.html">Recipe</a></li><li><a href="ControlsWaiter.html">ControlsWaiter</a></li><li><a href="HTMLApp.html">HTMLApp</a></li><li><a href="HTMLCategory.html">HTMLCategory</a></li><li><a href="HTMLIngredient.html">HTMLIngredient</a></li><li><a href="HTMLOperation.html">HTMLOperation</a></li><li><a href="HighlighterWaiter.html">HighlighterWaiter</a></li><li><a href="InputWaiter.html">InputWaiter</a></li><li><a href="Manager.html">Manager</a></li><li><a href="OperationsWaiter.html">OperationsWaiter</a></li><li><a href="OptionsWaiter.html">OptionsWaiter</a></li><li><a href="OutputWaiter.html">OutputWaiter</a></li><li><a href="RecipeWaiter.html">RecipeWaiter</a></li><li><a href="SeasonalWaiter.html">SeasonalWaiter</a></li><li><a href="WindowWaiter.html">WindowWaiter</a></li>
</ul>
</li>
<li class="dropdown">
<a href="events.list.html" class="dropdown-toggle" data-toggle="dropdown">Events<b class="caret"></b></a>
<ul class="dropdown-menu inline">
<li><a href="Manager.html#event:appstart">Manager#event:appstart</a></li><li><a href="Manager.html#event:operationadd">Manager#event:operationadd</a></li><li><a href="Manager.html#event:operationremove">Manager#event:operationremove</a></li><li><a href="Manager.html#event:oplistcreate">Manager#event:oplistcreate</a></li><li><a href="Manager.html#event:statechange">Manager#event:statechange</a></li>
</ul>
</li>
<li class="dropdown">
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
<ul class="dropdown-menu inline">
<li><a href="global.html#Categories">Categories</a></li><li><a href="global.html#OperationConfig">OperationConfig</a></li><li><a href="global.html#main">main</a></li>
</ul>
</li>
</ul>
<div class="col-sm-3 col-md-3">
<form class="navbar-form" role="search">
<div class="input-group">
<input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
<div class="input-group-btn">
<button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
</div>
</div>
</form>
</div>
</div>
</div>
</div>
<div class="container" id="toc-content">
<div class="row">
<div class="col-md-8">
<div id="main">
<h1 class="page-title">Class: RecipeWaiter</h1>
<section>
<header>
<h2>
RecipeWaiter
</h2>
</header>
<article>
<div class="container-overview">
<hr>
<dt>
<h4 class="name" id="RecipeWaiter"><span class="type-signature"></span>new RecipeWaiter(app, manager)</h4>
</dt>
<dd>
<div class="description">
<p>Waiter to handle events related to the recipe.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>app</code></td>
<td class="type">
<span class="param-type"><a href="HTMLApp.html">HTMLApp</a></span>
</td>
<td class="description last"><p>The main view object for CyberChef.</p></td>
</tr>
<tr>
<td class="name"><code>manager</code></td>
<td class="type">
<span class="param-type"><a href="Manager.html">Manager</a></span>
</td>
<td class="description last"><p>The CyberChef event manager.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-author method-doc-label method-doc-details-label">Author:</dt>
<dd class="tag-author">
<ul>
<li>&lt;p>n1474335 [n1474335@gmail.com]&lt;/p></li>
</ul>
</dd>
<dt class="tag-copyright method-doc-label method-doc-details-label">Copyright:</dt>
<dd class="tag-copyright">
<ul class="dummy">
<li>Crown Copyright 2016</li>
</ul>
</dd>
<dt class="tag-license method-doc-label method-doc-details-label">License:</dt>
<dd class="tag-license">
<ul class="dummy">
<li>Apache-2.0</li>
</ul>
</dd>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="views_html_RecipeWaiter.js.html">views/html/RecipeWaiter.js</a>,
<a href="views_html_RecipeWaiter.js.html#sunlight-1-line-14">line 14</a>
</li>
</ul>
</dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Methods</h3>
<dl>
<hr>
<dt>
<h4 class="name" id="initialise_operation_drag_n_drop"><span class="type-signature"></span>initialise_operation_drag_n_drop()</h4>
</dt>
<dd>
<div class="description">
<p>Sets up the drag and drop capability for operations in the operations and recipe areas.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="views_html_RecipeWaiter.js.html">views/html/RecipeWaiter.js</a>,
<a href="views_html_RecipeWaiter.js.html#sunlight-1-line-24">line 24</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="create_sortable_seed_list"><span class="type-signature"></span>create_sortable_seed_list(list_el)</h4>
</dt>
<dd>
<div class="description">
<p>Creates a drag-n-droppable seed list of operations.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>list_el</code></td>
<td class="type">
<span class="param-type">element</span>
</td>
<td class="description last"><p>The list the initialise</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="views_html_RecipeWaiter.js.html">views/html/RecipeWaiter.js</a>,
<a href="views_html_RecipeWaiter.js.html#sunlight-1-line-68">line 68</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="op_sort_end"><span class="type-signature"></span>op_sort_end(evt)</h4>
</dt>
<dd>
<div class="description">
<p>Handler for operation sort end events.<br>Removes the operation from the list if it has been dropped outside. If not, adds it to the list<br>at the appropriate place and initialises it.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>evt</code></td>
<td class="type">
<span class="param-type">event</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="views_html_RecipeWaiter.js.html">views/html/RecipeWaiter.js</a>,
<a href="views_html_RecipeWaiter.js.html#sunlight-1-line-96">line 96</a>
</li>
</ul>
</dd>
</dl>
<h5>Fires:</h5>
<ul>
<li><a href="Manager.html#event:operationadd">Manager#event:operationadd</a></li>
</ul>
</dd>
<hr>
<dt>
<h4 class="name" id="fav_dragover"><span class="type-signature"></span>fav_dragover(e)</h4>
</dt>
<dd>
<div class="description">
<p>Handler for favourite dragover events.<br>If the element being dragged is an operation, displays a visual cue so that the user knows it can<br>be dropped here.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>e</code></td>
<td class="type">
<span class="param-type">event</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="views_html_RecipeWaiter.js.html">views/html/RecipeWaiter.js</a>,
<a href="views_html_RecipeWaiter.js.html#sunlight-1-line-125">line 125</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="fav_dragleave"><span class="type-signature"></span>fav_dragleave(e)</h4>
</dt>
<dd>
<div class="description">
<p>Handler for favourite dragleave events.<br>Removes the visual cue.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>e</code></td>
<td class="type">
<span class="param-type">event</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="views_html_RecipeWaiter.js.html">views/html/RecipeWaiter.js</a>,
<a href="views_html_RecipeWaiter.js.html#sunlight-1-line-150">line 150</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="fav_drop"><span class="type-signature"></span>fav_drop(e)</h4>
</dt>
<dd>
<div class="description">
<p>Handler for favourite drop events.<br>Adds the dragged operation to the favourites list.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>e</code></td>
<td class="type">
<span class="param-type">event</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="views_html_RecipeWaiter.js.html">views/html/RecipeWaiter.js</a>,
<a href="views_html_RecipeWaiter.js.html#sunlight-1-line-163">line 163</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="ing_change"><span class="type-signature"></span>ing_change()</h4>
</dt>
<dd>
<div class="description">
<p>Handler for ingredient change events.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="views_html_RecipeWaiter.js.html">views/html/RecipeWaiter.js</a>,
<a href="views_html_RecipeWaiter.js.html#sunlight-1-line-178">line 178</a>
</li>
</ul>
</dd>
</dl>
<h5>Fires:</h5>
<ul>
<li><a href="Manager.html#event:statechange">Manager#event:statechange</a></li>
</ul>
</dd>
<hr>
<dt>
<h4 class="name" id="disable_click"><span class="type-signature"></span>disable_click(e)</h4>
</dt>
<dd>
<div class="description">
<p>Handler for disable click events.<br>Updates the icon status.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>e</code></td>
<td class="type">
<span class="param-type">event</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="views_html_RecipeWaiter.js.html">views/html/RecipeWaiter.js</a>,
<a href="views_html_RecipeWaiter.js.html#sunlight-1-line-190">line 190</a>
</li>
</ul>
</dd>
</dl>
<h5>Fires:</h5>
<ul>
<li><a href="Manager.html#event:statechange">Manager#event:statechange</a></li>
</ul>
</dd>
<hr>
<dt>
<h4 class="name" id="breakpoint_click"><span class="type-signature"></span>breakpoint_click(e)</h4>
</dt>
<dd>
<div class="description">
<p>Handler for breakpoint click events.<br>Updates the icon status.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>e</code></td>
<td class="type">
<span class="param-type">event</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="views_html_RecipeWaiter.js.html">views/html/RecipeWaiter.js</a>,
<a href="views_html_RecipeWaiter.js.html#sunlight-1-line-215">line 215</a>
</li>
</ul>
</dd>
</dl>
<h5>Fires:</h5>
<ul>
<li><a href="Manager.html#event:statechange">Manager#event:statechange</a></li>
</ul>
</dd>
<hr>
<dt>
<h4 class="name" id="operation_dblclick"><span class="type-signature"></span>operation_dblclick(e)</h4>
</dt>
<dd>
<div class="description">
<p>Handler for operation doubleclick events.<br>Removes the operation from the recipe and auto bakes.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>e</code></td>
<td class="type">
<span class="param-type">event</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="views_html_RecipeWaiter.js.html">views/html/RecipeWaiter.js</a>,
<a href="views_html_RecipeWaiter.js.html#sunlight-1-line-237">line 237</a>
</li>
</ul>
</dd>
</dl>
<h5>Fires:</h5>
<ul>
<li><a href="Manager.html#event:statechange">Manager#event:statechange</a></li>
</ul>
</dd>
<hr>
<dt>
<h4 class="name" id="operation_child_dblclick"><span class="type-signature"></span>operation_child_dblclick(e)</h4>
</dt>
<dd>
<div class="description">
<p>Handler for operation child doubleclick events.<br>Removes the operation from the recipe.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>e</code></td>
<td class="type">
<span class="param-type">event</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="views_html_RecipeWaiter.js.html">views/html/RecipeWaiter.js</a>,
<a href="views_html_RecipeWaiter.js.html#sunlight-1-line-250">line 250</a>
</li>
</ul>
</dd>
</dl>
<h5>Fires:</h5>
<ul>
<li><a href="Manager.html#event:statechange">Manager#event:statechange</a></li>
</ul>
</dd>
<hr>
<dt>
<h4 class="name" id="get_config"><span class="type-signature"></span>get_config()</h4>
</dt>
<dd>
<div class="description">
<p>Generates a configuration object to represent the current recipe.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="views_html_RecipeWaiter.js.html">views/html/RecipeWaiter.js</a>,
<a href="views_html_RecipeWaiter.js.html#sunlight-1-line-261">line 261</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">recipe_config</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="update_breakpoint_indicator"><span class="type-signature"></span>update_breakpoint_indicator(position)</h4>
</dt>
<dd>
<div class="description">
<p>Moves or removes the breakpoint indicator in the recipe based on the position.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>position</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="views_html_RecipeWaiter.js.html">views/html/RecipeWaiter.js</a>,
<a href="views_html_RecipeWaiter.js.html#sunlight-1-line-312">line 312</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="build_recipe_operation"><span class="type-signature"></span>build_recipe_operation(el)</h4>
</dt>
<dd>
<div class="description">
<p>Given an operation stub element, this function converts it into a full recipe element with<br>arguments.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>el</code></td>
<td class="type">
<span class="param-type">element</span>
</td>
<td class="description last"><p>The operation stub element from the operations pane</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="views_html_RecipeWaiter.js.html">views/html/RecipeWaiter.js</a>,
<a href="views_html_RecipeWaiter.js.html#sunlight-1-line-330">line 330</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="add_operation"><span class="type-signature"></span>add_operation(name)</h4>
</dt>
<dd>
<div class="description">
<p>Adds the specified operation to the recipe.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The name of the operation to add</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="views_html_RecipeWaiter.js.html">views/html/RecipeWaiter.js</a>,
<a href="views_html_RecipeWaiter.js.html#sunlight-1-line-354">line 354</a>
</li>
</ul>
</dd>
</dl>
<h5>Fires:</h5>
<ul>
<li><a href="Manager.html#event:operationadd">Manager#event:operationadd</a></li>
</ul>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">element</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="clear_recipe"><span class="type-signature"></span>clear_recipe()</h4>
</dt>
<dd>
<div class="description">
<p>Removes all operations from the recipe.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="views_html_RecipeWaiter.js.html">views/html/RecipeWaiter.js</a>,
<a href="views_html_RecipeWaiter.js.html#sunlight-1-line-371">line 371</a>
</li>
</ul>
</dd>
</dl>
<h5>Fires:</h5>
<ul>
<li><a href="Manager.html#event:operationremove">Manager#event:operationremove</a></li>
</ul>
</dd>
<hr>
<dt>
<h4 class="name" id="dropdown_toggle_click"><span class="type-signature"></span>dropdown_toggle_click(e)</h4>
</dt>
<dd>
<div class="description">
<p>Handler for operation dropdown events from toggle_string arguments.<br>Sets the selected option as the name of the button.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>e</code></td>
<td class="type">
<span class="param-type">event</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="views_html_RecipeWaiter.js.html">views/html/RecipeWaiter.js</a>,
<a href="views_html_RecipeWaiter.js.html#sunlight-1-line-386">line 386</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="op_add"><span class="type-signature"></span>op_add(e)</h4>
</dt>
<dd>
<div class="description">
<p>Handler for operationadd events.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>e</code></td>
<td class="type">
<span class="param-type">event</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="views_html_RecipeWaiter.js.html">views/html/RecipeWaiter.js</a>,
<a href="views_html_RecipeWaiter.js.html#sunlight-1-line-402">line 402</a>
</li>
</ul>
</dd>
</dl>
<h5>Fires:</h5>
<ul>
<li><a href="Manager.html#event:statechange">Manager#event:statechange</a></li>
</ul>
<h5>Listens to Events:</h5>
<ul>
<li><a href="Manager.html#event:operationadd">Manager#event:operationadd</a></li>
</ul>
</dd>
<hr>
<dt>
<h4 class="name" id="op_remove"><span class="type-signature"></span>op_remove(e)</h4>
</dt>
<dd>
<div class="description">
<p>Handler for operationremove events.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>e</code></td>
<td class="type">
<span class="param-type">event</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="views_html_RecipeWaiter.js.html">views/html/RecipeWaiter.js</a>,
<a href="views_html_RecipeWaiter.js.html#sunlight-1-line-414">line 414</a>
</li>
</ul>
</dd>
</dl>
<h5>Fires:</h5>
<ul>
<li><a href="Manager.html#event:statechange">Manager#event:statechange</a></li>
</ul>
<h5>Listens to Events:</h5>
<ul>
<li><a href="Manager.html#event:operationremove">Manager#event:operationremove</a></li>
</ul>
</dd>
</dl>
</article>
</section>
</div>
</div>
<div class="clearfix"></div>
<div class="col-md-3">
<div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
</div>
</div>
</div>
<div class="modal fade" id="searchResults">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
<h4 class="modal-title">Search results</h4>
</div>
<div class="modal-body"></div>
<div class="modal-footer">
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
</div>
</div><!-- /.modal-content -->
</div><!-- /.modal-dialog -->
</div>
<footer>
<span class="copyright">
&copy; Crown Copyright 2016
</span>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
on Mon Nov 28th 2016
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
</footer>
<script src="scripts/docstrap.lib.js"></script>
<script src="scripts/toc.js"></script>
<script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
<script>
$( function () {
$( "[id*='$']" ).each( function () {
var $this = $( this );
$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
} );
$( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
var $this = $( this );
var example = $this.find( "code" );
exampleText = example.html();
var lang = /{@lang (.*?)}/.exec( exampleText );
if ( lang && lang[1] ) {
exampleText = exampleText.replace( lang[0], "" );
example.html( exampleText );
lang = lang[1];
} else {
var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
lang = langClassMatch ? langClassMatch[1] : "javascript";
}
if ( lang ) {
$this
.addClass( "sunlight-highlight-" + lang )
.addClass( "linenums" )
.html( example.html() );
}
} );
Sunlight.highlightAll( {
lineNumbers : true,
showMenu : true,
enableDoclinks : true
} );
$.catchAnchorLinks( {
navbarOffset: 10
} );
$( "#toc" ).toc( {
anchorName : function ( i, heading, prefix ) {
return $( heading ).attr( "id" ) || ( prefix + i );
},
selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
showAndHide : false,
smoothScrolling: true
} );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
$( '.dropdown-toggle' ).dropdown();
$( "table" ).each( function () {
var $this = $( this );
$this.addClass('table');
} );
} );
</script>
<!--Navigation and Symbol Display-->
<!--Google Analytics-->
<script type="text/javascript">
$(document).ready(function() {
SearcherDisplay.init();
});
</script>
</body>
</html>
Reference in a new issue Copy permalink