mirrors/easyappointments
1
0
Fork 1
mirror of https://github.com/alextselegidis/easyappointments.git synced 2024-11-30 03:42:44 +03:00
Code Issues Projects Releases Packages Wiki Activity
easyappointments/doc/code/js/BackendCalendar.html

739 lines
10 KiB
HTML
Raw Normal View History

- Φόρτωση των καταχωρημένων ραντεβού στο ημερολόγιο (backend) - Προβολή λεπτομερειών ραντεβού - Δημιουργία διαλόγου επεξεργασίας (δεν ολοκληρώθηκε ακόμα) - Παραγωγή code docs (js + php)
2013-06-13 19:25:34 +03:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Namespace: BackendCalendar</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: BackendCalendar</h1>
<section>
<header>
<h2>
BackendCalendar
</h2>
</header>
<article>
<div class="container-overview">
<div class="description">This namespace contains functions that are used by the backend calendar page.</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="backend_calendar.js.html">backend_calendar.js</a>, <a href="backend_calendar.js.html#line1">line 1</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="bindEventHandlers"><span class="type-signature">&lt;static> </span>bindEventHandlers<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
This method binds the default event handlers for the backend calendar
page. If you do not need the default handlers then initialize the page
by setting the "defaultEventHandlers" argument to "false".
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="backend_calendar.js.html">backend_calendar.js</a>, <a href="backend_calendar.js.html#line152">line 152</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getCalendarHeight"><span class="type-signature">&lt;static> </span>getCalendarHeight<span class="signature">()</span><span class="type-signature"> &rarr; {int}</span></h4>
</dt>
<dd>
<div class="description">
This method calculates the proper calendar height, in order to be displayed
correctly, even when the browser window is resizing.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="backend_calendar.js.html">backend_calendar.js</a>, <a href="backend_calendar.js.html#line243">line 243</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns the calendar element height in pixels.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">int</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="initialize"><span class="type-signature">&lt;static> </span>initialize<span class="signature">(defaultEventHandlers)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
This function makes the necessary initialization for the default backend
calendar page. If this namespace is used in another page then this function
might not be needed.
</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>defaultEventHandlers</code></td>
<td class="type">
<span class="param-type">bool</span>
</td>
<td class="description last">(OPTIONAL = TRUE) Determines whether the
default event handlers will be set for the current page.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="backend_calendar.js.html">backend_calendar.js</a>, <a href="backend_calendar.js.html#line20">line 20</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="refreshCalendarAppointments"><span class="type-signature">&lt;static> </span>refreshCalendarAppointments<span class="signature">(calendarHandle, recordId, filterType, startDate, endDate)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
This method reloads the registered appointments for the selected date period
and filter type.
</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>calendarHandle</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">The calendar jQuery object.</td>
</tr>
<tr>
<td class="name"><code>recordId</code></td>
<td class="type">
<span class="param-type">int</span>
</td>
<td class="description last">The selected record id.</td>
</tr>
<tr>
<td class="name"><code>filterType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The filter type, could be either FILTER_TYPE_PROVIDER
or FILTER_TYPE_SERVICE</td>
</tr>
<tr>
<td class="name"><code>startDate</code></td>
<td class="type">
<span class="param-type">date</span>
</td>
<td class="description last">Visible start date of the calendar.</td>
</tr>
<tr>
<td class="name"><code>endDate</code></td>
<td class="type">
<span class="param-type">type</span>
</td>
<td class="description last">Visible end date of the calendar.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="backend_calendar.js.html">backend_calendar.js</a>, <a href="backend_calendar.js.html#line260">line 260</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="updateAppointment"><span class="type-signature">&lt;static> </span>updateAppointment<span class="signature">(appointmentData)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
This method stores the changes of an already registered appointment
into the database, via an ajax call.
</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>appointmentData</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Contain the new appointment data. The
id of the appointment MUST be already included.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="backend_calendar.js.html">backend_calendar.js</a>, <a href="backend_calendar.js.html#line305">line 305</a>
</li></ul></dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>Namespaces</h3><ul><li><a href="Backend.html">Backend</a></li><li><a href="BackendCalendar.html">BackendCalendar</a></li><li><a href="FrontendBook.html">FrontendBook</a></li><li><a href="GeneralFunctions.html">GeneralFunctions</a></li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> on Thu Jun 13 2013 16:52:48 GMT+0300 (EEST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
Reference in a new issue Copy permalink