mirrors/CyberChef
1
0
Fork 0
mirror of https://github.com/gchq/CyberChef.git synced 2025-04-21 07:16:17 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
CyberChef/docs/HTMLApp.html
n1474335 56dbb3fa40 Initial pages commit
2016-11-28 11:01:54 +00:00

3838 lines
No EOL
47 KiB
HTML
Executable file
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>CyberChef Class: HTMLApp</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: HTMLApp</h1>
<section>
<header>
<h2>
HTMLApp
</h2>
</header>
<article>
<div class="container-overview">
<hr>
<dt>
<h4 class="name" id="HTMLApp"><span class="type-signature"></span>new HTMLApp(categories, operations, default_favourites, options)</h4>
</dt>
<dd>
<div class="description">
<p>HTML view for CyberChef responsible for building the web page and dealing with all user<br>interactions.</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>categories</code></td>
<td class="type">
<span class="param-type"><a href="Array.html">Array</a>.&lt;<a href="global.html#CatConf">CatConf</a>></span>
</td>
<td class="description last"><p>The list of categories and operations to be populated.</p></td>
</tr>
<tr>
<td class="name"><code>operations</code></td>
<td class="type">
<span class="param-type">Object.&lt;string, <a href="global.html#OpConf">OpConf</a>></span>
</td>
<td class="description last"><p>The list of operation configuration objects.</p></td>
</tr>
<tr>
<td class="name"><code>default_favourites</code></td>
<td class="type">
<span class="param-type"><a href="Array.html">Array</a>.&lt;<a href="String.html">String</a>></span>
</td>
<td class="description last"><p>A list of default favourite operations.</p></td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>Default setting for app options.</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_HTMLApp.js.html">views/html/HTMLApp.js</a>,
<a href="views_html_HTMLApp.js.html#sunlight-1-line-17">line 17</a>
</li>
</ul>
</dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Methods</h3>
<dl>
<hr>
<dt>
<h4 class="name" id="setup"><span class="type-signature"></span>setup()</h4>
</dt>
<dd>
<div class="description">
<p>This function sets up the stage and creates listeners for all 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_HTMLApp.js.html">views/html/HTMLApp.js</a>,
<a href="views_html_HTMLApp.js.html#sunlight-1-line-40">line 40</a>
</li>
</ul>
</dd>
</dl>
<h5>Fires:</h5>
<ul>
<li><a href="Manager.html#event:appstart">Manager#event:appstart</a></li>
</ul>
</dd>
<hr>
<dt>
<h4 class="name" id="handle_error"><span class="type-signature"></span>handle_error(err)</h4>
</dt>
<dd>
<div class="description">
<p>An error handler for displaying the error to the user.</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>err</code></td>
<td class="type">
<span class="param-type">Error</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_HTMLApp.js.html">views/html/HTMLApp.js</a>,
<a href="views_html_HTMLApp.js.html#sunlight-1-line-57">line 57</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="bake"><span class="type-signature"></span>bake( [step])</h4>
</dt>
<dd>
<div class="description">
<p>Calls the Chef to bake the current input using the current recipe.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>step</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>Set to true if we should only execute one operation instead of the<br> whole recipe.</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_HTMLApp.js.html">views/html/HTMLApp.js</a>,
<a href="views_html_HTMLApp.js.html#sunlight-1-line-70">line 70</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="auto_bake"><span class="type-signature"></span>auto_bake()</h4>
</dt>
<dd>
<div class="description">
<p>Runs Auto Bake if it is set.</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_HTMLApp.js.html">views/html/HTMLApp.js</a>,
<a href="views_html_HTMLApp.js.html#sunlight-1-line-108">line 108</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="silent_bake"><span class="type-signature"></span>silent_bake()</h4>
</dt>
<dd>
<div class="description">
<p>Runs a silent bake forcing the browser to load and cache all the relevant JavaScript code needed<br>to do a real bake.</p>
<p>The output will not be modified (hence &quot;silent&quot; bake). This will only actually execute the<br>recipe if auto-bake is enabled, otherwise it will just load the recipe, ingredients and dish.</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_HTMLApp.js.html">views/html/HTMLApp.js</a>,
<a href="views_html_HTMLApp.js.html#sunlight-1-line-124">line 124</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>The number of miliseconds it took to run the silent bake.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="get_input"><span class="type-signature"></span>get_input()</h4>
</dt>
<dd>
<div class="description">
<p>Gets the user's input data.</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_HTMLApp.js.html">views/html/HTMLApp.js</a>,
<a href="views_html_HTMLApp.js.html#sunlight-1-line-141">line 141</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="set_input"><span class="type-signature"></span>set_input(input)</h4>
</dt>
<dd>
<div class="description">
<p>Sets the user's input data.</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>input</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The string to set the input to</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_HTMLApp.js.html">views/html/HTMLApp.js</a>,
<a href="views_html_HTMLApp.js.html#sunlight-1-line-157">line 157</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="populate_operations_list"><span class="type-signature"></span>populate_operations_list()</h4>
</dt>
<dd>
<div class="description">
<p>Populates the operations accordion list with the categories and operations specified in the<br>view constructor.</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_HTMLApp.js.html">views/html/HTMLApp.js</a>,
<a href="views_html_HTMLApp.js.html#sunlight-1-line-170">line 170</a>
</li>
</ul>
</dd>
</dl>
<h5>Fires:</h5>
<ul>
<li><a href="Manager.html#event:oplistcreate">Manager#event:oplistcreate</a></li>
</ul>
</dd>
<hr>
<dt>
<h4 class="name" id="initialise_splitter"><span class="type-signature"></span>initialise_splitter()</h4>
</dt>
<dd>
<div class="description">
<p>Sets up the adjustable splitter to allow the user to resize areas of the page.</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_HTMLApp.js.html">views/html/HTMLApp.js</a>,
<a href="views_html_HTMLApp.js.html#sunlight-1-line-206">line 206</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="load_local_storage"><span class="type-signature"></span>load_local_storage()</h4>
</dt>
<dd>
<div class="description">
<p>Loads the information previously saved to the HTML5 local storage object so that user options<br>and favourites can be restored.</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_HTMLApp.js.html">views/html/HTMLApp.js</a>,
<a href="views_html_HTMLApp.js.html#sunlight-1-line-227">line 227</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="load_favourites"><span class="type-signature"></span>load_favourites()</h4>
</dt>
<dd>
<div class="description">
<p>Loads the user's favourite operations from the HTML5 local storage object and populates the<br>Favourites category with them.<br>If the user currently has no saved favourites, the defaults from the view constructor are used.</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_HTMLApp.js.html">views/html/HTMLApp.js</a>,
<a href="views_html_HTMLApp.js.html#sunlight-1-line-245">line 245</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="valid_favourites"><span class="type-signature"></span>valid_favourites(favourites)</h4>
</dt>
<dd>
<div class="description">
<p>Filters the list of favourite operations that the user had stored and removes any that are no<br>longer available. The user is notified if this is the case.</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>favourites</code></td>
<td class="type">
<span class="param-type"><a href="Array.html">Array</a>.&lt;string></span>
</td>
<td class="description last"><p>A list of the user's favourite operations</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_HTMLApp.js.html">views/html/HTMLApp.js</a>,
<a href="views_html_HTMLApp.js.html#sunlight-1-line-276">line 276</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A list of the valid favourites</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Array.html">Array</a>.&lt;string></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="save_favourites"><span class="type-signature"></span>save_favourites(favourites)</h4>
</dt>
<dd>
<div class="description">
<p>Saves a list of favourite operations to the HTML5 local storage object.</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>favourites</code></td>
<td class="type">
<span class="param-type"><a href="Array.html">Array</a>.&lt;string></span>
</td>
<td class="description last"><p>A list of the user's favourite operations</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_HTMLApp.js.html">views/html/HTMLApp.js</a>,
<a href="views_html_HTMLApp.js.html#sunlight-1-line-295">line 295</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="reset_favourites"><span class="type-signature"></span>reset_favourites()</h4>
</dt>
<dd>
<div class="description">
<p>Resets favourite operations back to the default as specified in the view constructor and<br>refreshes the operation list.</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_HTMLApp.js.html">views/html/HTMLApp.js</a>,
<a href="views_html_HTMLApp.js.html#sunlight-1-line-304">line 304</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="add_favourite"><span class="type-signature"></span>add_favourite(name)</h4>
</dt>
<dd>
<div class="description">
<p>Adds an operation to the user's favourites.</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</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_HTMLApp.js.html">views/html/HTMLApp.js</a>,
<a href="views_html_HTMLApp.js.html#sunlight-1-line-317">line 317</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="load_URI_params"><span class="type-signature"></span>load_URI_params()</h4>
</dt>
<dd>
<div class="description">
<p>Checks for input and recipe in the URI parameters and loads them if present.</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_HTMLApp.js.html">views/html/HTMLApp.js</a>,
<a href="views_html_HTMLApp.js.html#sunlight-1-line-336">line 336</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="next_ing_id"><span class="type-signature"></span>next_ing_id()</h4>
</dt>
<dd>
<div class="description">
<p>Returns the next ingredient ID and increments it for next time.</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_HTMLApp.js.html">views/html/HTMLApp.js</a>,
<a href="views_html_HTMLApp.js.html#sunlight-1-line-401">line 401</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="get_recipe_config"><span class="type-signature"></span>get_recipe_config()</h4>
</dt>
<dd>
<div class="description">
<p>Gets the current recipe configuration.</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_HTMLApp.js.html">views/html/HTMLApp.js</a>,
<a href="views_html_HTMLApp.js.html#sunlight-1-line-411">line 411</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Array.html">Array</a>.&lt;Object></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="set_recipe_config"><span class="type-signature"></span>set_recipe_config(recipe_config)</h4>
</dt>
<dd>
<div class="description">
<p>Given a recipe configuration, sets the recipe to that configuration.</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>recipe_config</code></td>
<td class="type">
<span class="param-type"><a href="Array.html">Array</a>.&lt;Object></span>
</td>
<td class="description last"><p>The recipe configuration</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_HTMLApp.js.html">views/html/HTMLApp.js</a>,
<a href="views_html_HTMLApp.js.html#sunlight-1-line-423">line 423</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="reset_layout"><span class="type-signature"></span>reset_layout()</h4>
</dt>
<dd>
<div class="description">
<p>Resets the splitter positions to default.</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_HTMLApp.js.html">views/html/HTMLApp.js</a>,
<a href="views_html_HTMLApp.js.html#sunlight-1-line-463">line 463</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="set_compile_message"><span class="type-signature"></span>set_compile_message()</h4>
</dt>
<dd>
<div class="description">
<p>Sets the compile message.</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_HTMLApp.js.html">views/html/HTMLApp.js</a>,
<a href="views_html_HTMLApp.js.html#sunlight-1-line-477">line 477</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="alert"><span class="type-signature"></span>alert(str, style, timeout [, silent])</h4>
</dt>
<dd>
<div class="description">
<p>Pops up a message to the user and writes it to the console log.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>str</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The message to display (HTML supported)</p></td>
</tr>
<tr>
<td class="name"><code>style</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The colour of the popup<br> &quot;danger&quot; = red<br> &quot;warning&quot; = amber<br> &quot;info&quot; = blue<br> &quot;success&quot; = green</p></td>
</tr>
<tr>
<td class="name"><code>timeout</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The number of milliseconds before the popup closes automatically<br> 0 for never (until the user closes it)</p></td>
</tr>
<tr>
<td class="name"><code>silent</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>Don't show the message in the popup, only print it to the<br> console</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_HTMLApp.js.html">views/html/HTMLApp.js</a>,
<a href="views_html_HTMLApp.js.html#sunlight-1-line-516">line 516</a>
</li>
</ul>
</dd>
</dl>
<h5>Example</h5>
<pre class="sunlight-highlight-javascript">// Pops up a red box with the message &quot;[current time] Error: Something has gone wrong!&quot;
// that will need to be dismissed by the user.
this.alert(&quot;Error: Something has gone wrong!&quot;, &quot;danger&quot;, 0);
// Pops up a blue information box with the message &quot;[current time] Happy Christmas!&quot;
// that will disappear after 5 seconds.
this.alert(&quot;Happy Christmas!&quot;, &quot;info&quot;, 5000);</pre>
</dd>
<hr>
<dt>
<h4 class="name" id="confirm"><span class="type-signature"></span>confirm(title, body, callback [, scope])</h4>
</dt>
<dd>
<div class="description">
<p>Pops up a box asking the user a question and sending the answer to a specified callback function.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>title</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The title of the box</p></td>
</tr>
<tr>
<td class="name"><code>body</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The question (HTML supported)</p></td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>A function accepting one boolean argument which handles the<br> response e.g. function(answer) {...}</p></td>
</tr>
<tr>
<td class="name"><code>scope</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
this
</td>
<td class="description last"><p>The object to bind to the callback function</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_HTMLApp.js.html">views/html/HTMLApp.js</a>,
<a href="views_html_HTMLApp.js.html#sunlight-1-line-570">line 570</a>
</li>
</ul>
</dd>
</dl>
<h5>Example</h5>
<pre class="sunlight-highlight-javascript">// Pops up a box asking if the user would like a cookie. Prints the answer to the console.
this.confirm(&quot;Question&quot;, &quot;Would you like a cookie?&quot;, function(answer) {console.log(answer);});</pre>
</dd>
<hr>
<dt>
<h4 class="name" id="alert_close_click"><span class="type-signature"></span>alert_close_click()</h4>
</dt>
<dd>
<div class="description">
<p>Handler for the alert close button click event.<br>Closes the alert box.</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_HTMLApp.js.html">views/html/HTMLApp.js</a>,
<a href="views_html_HTMLApp.js.html#sunlight-1-line-598">line 598</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="state_change"><span class="type-signature"></span>state_change(e)</h4>
</dt>
<dd>
<div class="description">
<p>Handler for CyerChef statechange events.<br>Fires whenever the input or recipe changes in any way.</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_HTMLApp.js.html">views/html/HTMLApp.js</a>,
<a href="views_html_HTMLApp.js.html#sunlight-1-line-610">line 610</a>
</li>
</ul>
</dd>
</dl>
<h5>Listens to Events:</h5>
<ul>
<li><a href="Manager.html#event:statechange">Manager#event:statechange</a></li>
</ul>
</dd>
<hr>
<dt>
<h4 class="name" id="pop_state"><span class="type-signature"></span>pop_state(e)</h4>
</dt>
<dd>
<div class="description">
<p>Handler for the history popstate event.<br>Reloads parameters from the URL.</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_HTMLApp.js.html">views/html/HTMLApp.js</a>,
<a href="views_html_HTMLApp.js.html#sunlight-1-line-627">line 627</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="call_api"><span class="type-signature"></span>call_api()</h4>
</dt>
<dd>
<div class="description">
<p>Function to call an external API from this view.</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_HTMLApp.js.html">views/html/HTMLApp.js</a>,
<a href="views_html_HTMLApp.js.html#sunlight-1-line-637">line 637</a>
</li>
</ul>
</dd>
</dl>
</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 View git blame Copy permalink