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

1221 lines
No EOL
13 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: WorkingPlan</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">Class: WorkingPlan</h1>
<section>
<header>
<h2>
WorkingPlan
</h2>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="WorkingPlan"><span class="type-signature"></span>new WorkingPlan<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Contains the working plan functionality. The working plan DOM elements must be same
in every page this class is used.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="working_plan.js.html">working_plan.js</a>, <a href="working_plan.js.html#line1">line 1</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="bindEventHandlers"><span class="type-signature"></span>bindEventHandlers<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Binds the event handlers for the working plan dom elements.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="working_plan.js.html">working_plan.js</a>, <a href="working_plan.js.html#line139">line 139</a>
</li></ul></dd>
</dl>
<h4 class="name" id="convertDayToValue"><span class="type-signature"></span>convertDayToValue<span class="signature">(value)</span><span class="type-signature"></span></h4>
<div class="description">
This is necessary for translated days.
</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>value</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Day value could be like "Monday", "Tuesday" etc.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="working_plan.js.html">working_plan.js</a>, <a href="working_plan.js.html#line389">line 389</a>
</li></ul></dd>
</dl>
<h4 class="name" id="convertValueToDay"><span class="type-signature"></span>convertValueToDay<span class="signature">(value)</span><span class="type-signature"></span></h4>
<div class="description">
This is necessary for translated days.
</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>value</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Day value could be like "monday", "tuesday" etc.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="working_plan.js.html">working_plan.js</a>, <a href="working_plan.js.html#line358">line 358</a>
</li></ul></dd>
</dl>
<h4 class="name" id="editableBreakDay"><span class="type-signature"></span>editableBreakDay<span class="signature">($selector)</span><span class="type-signature"></span></h4>
<div class="description">
This method makes editable the break day cells.
</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>$selector</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">The jquery selector ready for use.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="working_plan.js.html">working_plan.js</a>, <a href="working_plan.js.html#line80">line 80</a>
</li></ul></dd>
</dl>
<h4 class="name" id="editableBreakTime"><span class="type-signature"></span>editableBreakTime<span class="signature">($selector)</span><span class="type-signature"></span></h4>
<div class="description">
This method makes editable the break time cells.
</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>$selector</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">The jquery selector ready for use.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="working_plan.js.html">working_plan.js</a>, <a href="working_plan.js.html#line117">line 117</a>
</li></ul></dd>
</dl>
<h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">()</span><span class="type-signature"> &rarr; {object}</span></h4>
<div class="description">
Get the working plan settings.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="working_plan.js.html">working_plan.js</a>, <a href="working_plan.js.html#line277">line 277</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns the working plan settings object.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h4 class="name" id="reset"><span class="type-signature"></span>reset<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Reset the current plan back to the company's default working plan.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="working_plan.js.html">working_plan.js</a>, <a href="working_plan.js.html#line349">line 349</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setup"><span class="type-signature"></span>setup<span class="signature">(workingPlan)</span><span class="type-signature"></span></h4>
<div class="description">
Setup the dom elements of a given working plan.
</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>workingPlan</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Contains the working hours and breaks for each day of the week.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="working_plan.js.html">working_plan.js</a>, <a href="working_plan.js.html#line30">line 30</a>
</li></ul></dd>
</dl>
<h4 class="name" id="timepickers"><span class="type-signature"></span>timepickers<span class="signature">(disabled)</span><span class="type-signature"></span></h4>
<div class="description">
Enables or disabled the timepicker functionality from the working plan input
text fields.
</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>disabled</code></td>
<td class="type">
<span class="param-type">bool</span>
</td>
<td class="description last">(OPTIONAL = false) If true then the timepickers will be
disabled.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="working_plan.js.html">working_plan.js</a>, <a href="working_plan.js.html#line316">line 316</a>
</li></ul></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:08 GMT+0100 (CET)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>