iflrandevu/doc/code/js/BackendSettings.html
2015-01-21 23:17:16 +01:00

509 lines
No EOL
6.6 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Namespace: BackendSettings</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Namespace: BackendSettings</h1>
<section>
<header>
<h2>
BackendSettings
</h2>
</header>
<article>
<div class="container-overview">
<div class="description">Contains the functionality of the backend settings page. Can either work for
system or user settings, but the actions allowed to the user are restricted to
his role (only admin has full privileges).</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="backend_settings.js.html">backend_settings.js</a>, <a href="backend_settings.js.html#line1">line 1</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id=".settings"><span class="type-signature">(static) </span>settings<span class="type-signature"> :object</span></h4>
<div class="description">
Tab settings object.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="backend_settings.js.html">backend_settings.js</a>, <a href="backend_settings.js.html#line23">line 23</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".wp"><span class="type-signature">(static) </span>wp<span class="type-signature"></span></h4>
<div class="description">
Use this WorkingPlan class instance to perform actions on the page's working plan
tables.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="backend_settings.js.html">backend_settings.js</a>, <a href="backend_settings.js.html#line16">line 16</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".bindEventHandlers"><span class="type-signature">(static) </span>bindEventHandlers<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Bind the backend/settings default event handlers. This method depends on the
backend/settings html, so do not use this method on a different page.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="backend_settings.js.html">backend_settings.js</a>, <a href="backend_settings.js.html#line106">line 106</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".initialize"><span class="type-signature">(static) </span>initialize<span class="signature">(bindEventHandlers)</span><span class="type-signature"> &rarr; {undefined}</span></h4>
<div class="description">
Initialize Page
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>bindEventHandlers</code></td>
<td class="type">
<span class="param-type">bool</span>
</td>
<td class="description last">(OPTIONAL)Determines whether to bind the default event
handlers (default = true).</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="backend_settings.js.html">backend_settings.js</a>, <a href="backend_settings.js.html#line32">line 32</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">undefined</span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AdminsHelper.html">AdminsHelper</a></li><li><a href="CategoriesHelper.html">CategoriesHelper</a></li><li><a href="CustomersHelper.html">CustomersHelper</a></li><li><a href="ProvidersHelper.html">ProvidersHelper</a></li><li><a href="SecretariesHelper.html">SecretariesHelper</a></li><li><a href="ServicesHelper.html">ServicesHelper</a></li><li><a href="SystemSettings.html">SystemSettings</a></li><li><a href="UserSettings.html">UserSettings</a></li><li><a href="WorkingPlan.html">WorkingPlan</a></li></ul><h3>Namespaces</h3><ul><li><a href="Backend.html">Backend</a></li><li><a href="BackendCalendar.html">BackendCalendar</a></li><li><a href="BackendCustomers.html">BackendCustomers</a></li><li><a href="BackendServices.html">BackendServices</a></li><li><a href="BackendSettings.html">BackendSettings</a></li><li><a href="BackendUsers.html">BackendUsers</a></li><li><a href="FrontendBook.html">FrontendBook</a></li><li><a href="GeneralFunctions.html">GeneralFunctions</a></li></ul><h3>Global</h3><ul><li><a href="global.html#enableCancel">enableCancel</a></li><li><a href="global.html#enableSubmit">enableSubmit</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha13</a> on Wed Jan 21 2015 23:15:07 GMT+0100 (CET)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>