1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" version="-//W3C//DTD XHTML 1.1//EN" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<title>Prototype Window Class : Documentation</title>
<!-- Prototype Window Class Part -->
<script type="text/javascript" src="javascripts/prototype.js"> </script>
<script type="text/javascript" src="javascripts/effects.js"> </script>
<script type="text/javascript" src="javascripts/window.js"> </script>
<script type="text/javascript" src="javascripts/debug.js"> </script>
<link href="themes/default.css" rel="stylesheet" type="text/css" > </link>
<!-- Doc Part-->
<link href="stylesheets/style.css" rel="stylesheet" type="text/css" > </link>
<script type="text/javascript" src="js/application.js"> </script>
</head>
<body onload="Application.insertDocOverview()">
<script>Application.insertNavigation('documentation')</script>
<div id="wrapper">
<div id= "content" class="content">
<h2 class="first"> Overview</h2>
<div id="Overview"></div>
<h2>Window Class</h2>
Main class to handle windows<br/><br/>
<div class="function window" title="keepMultiModalWindow"><a name="keepMultiModalWindow"></a>
<p class="title"><span class="function">Window.keepMultiModalWindow</span> Constant for multi modal window behavior.<br><br>
By default (<strong>Window.keepMultiModalWindow=false</strong>), a new modal window will hide the previous one. if <strong>Window.keepMultiModalWindow=true</strong>, a new modal window will move the previous one under the overlay. </p>
</div>
<br style='clear:both'/>
<div class="function window" title="initialize"><a name="initialize"></a>
<p class="title"><span class="function">initialize(id, options)</span> Window constructor used when creating new window (new Window(id, options))</p>
<!--
<p class="parameter_header">
<span class="field">Argument</span>
<span class="explanation">Description</span>
</p>
-->
<p class="parameter">
<span class="field">id</span>
<span class="explanation">DOM id of the window must be unique</span>
</p>
<p class="parameter">
<span class="field">options</span>
<span class="explanation">
Hash map of window options, here is the key list:
<table>
<tr><th>Key</th> <th>Default</th> <th>Description </th></tr>
<tr><td class="key">id</td> <td class="default">generated</td> <td class="detail">window DOM id. Must be unique </td></tr>
<tr><td class="key">className</td> <td class="default">dialog</td> <td class="detail">Class name prefix </td></tr>
<tr><td class="key">title</td> <td class="default">none</td> <td class="detail">Window's title </td></tr>
<tr><td class="key">url</td> <td class="default">none</td> <td class="detail">URL of window content (use an iframe)</td></tr>
<tr><td class="key">parent</td> <td class="default">body</td> <td class="detail">Parent node of the window </td></tr>
<tr><td class="key">top | bottom</td> <td class="default">top:0</td> <td class="detail">Top or bottom position of the window in pixels </td></tr>
<tr><td class="key">right | left</td> <td class="default">left:0</td> <td class="detail">Right or left position of the window in pixels</td></tr>
<tr><td class="key">width / height</td> <td class="default">100</td> <td class="detail">width and height of the window </td></tr>
<tr><td class="key">maxWidth / maxHeight</td> <td class="default">none</td> <td class="detail">Maximum width and height of the window</td></tr>
<tr><td class="key">minWidth / minHeight</td> <td class="default">100/20</td> <td class="detail">Minimum width and height of the window </td></tr>
<tr><td class="key">resizable</td> <td class="default">true</td> <td class="detail">Specify if the window can be resized </td></tr>
<tr><td class="key">closable</td> <td class="default">true</td> <td class="detail">Specify if the window can be closed </td></tr>
<tr><td class="key">minimizable</td> <td class="default">true</td> <td class="detail">Specify if the window can be minimized </td></tr>
<tr><td class="key">maximizable</td> <td class="default">true</td> <td class="detail">Specify if the window can be maximized</td></tr>
<tr><td class="key">draggable</td> <td class="default">true</td> <td class="detail">Specify if the window can be moved </td></tr>
<tr><td class="key">showEffect</td> <td class="default">Effect.Appear or<br> Element.show</td> <td class="detail">Show effect function. The default value depends if effect.js of script.aculo.us is included </td></tr>
<tr><td class="key">hideEffect</td> <td class="default">Effect.Fade or<br> Element.hide</td> <td class="detail">Hide effect function. The default value depends if effect.js of script.aculo.us is included </td></tr>
<tr><td class="key">showEffectOptions</td> <td class="default">none</td> <td class="detail">Show effect options (see script.aculo.us documentation).</td></tr>
<tr><td class="key">hideEffectOptions</td> <td class="default">none</td> <td class="detail">Hid effect options (see script.aculo.us documentation).</td></tr>
<tr><td class="key">effectOptions</td> <td class="default">none</td> <td class="detail">Show and hide effect options (see script.aculo.us documentation).</td></tr>
<tr><td class="key">onload</td> <td class="default">none</td> <td class="detail">Onload function of the main window div or iframe</td></tr>
<tr><td class="key">opacity</td> <td class="default">1</td> <td class="detail">Window opacity </td></tr>
<tr><td class="key">recenterAuto</td> <td class="default">true</td> <td class="detail">Recenter modal window when browser size has changed</td></tr>
<tr><td class="key">gridX</td> <td class="default">1</td> <td class="detail">Move and resize will snap on a grid</td></tr>
<tr><td class="key">gridY</td> <td class="default">1</td> <td class="detail">Move and resize will snap on a grid</td></tr>
<tr><td class="key">recenterAuto</td> <td class="default">true</td> <td class="detail">Recenter modal window when browser size has changed</td></tr>
<tr><td class="key">wiredDrag</td> <td class="default">false</td> <td class="detail">Move/Resize will be done with a wired frame (customizable in CSS, class <strong><className>_wired_frame</strong>. Look in alphacube.css for an example) </td></tr>
<tr><td class="key">destroyOnClose</td> <td class="default">false</td> <td class="detail">Destroy window when closing window. By default, the window is just hidden</td></tr>
<tr><td class="key">all callbacks</td> <td class="default">none</td> <td class="detail">All callback used in observer. Callbacks override observer callbacks:<br/>
<em>onDestroy onStartResize onStartMove onResize onMove onEndResize onEndMove onFocus onBlur onBeforeShow onShow onHide onMinimize onMaximize onClose</em>
</td></tr>
</table>
</span>
</p>
</div>
<br style='clear:both'/>
<div class="function window" title="destroy"><a name="destroy"></a>
<p class="title"><span class="function">destroy()</span> Window destructor</p>
</div>
<br style='clear:both'/>
<div class="function window" title="getId"><a name="getId"></a>
<p class="title"><span class="function">getId()</span> Returns current window id</p>
</div>
<br style='clear:both'/>
<div class="function window" title="setDestroyOnClose"><a name="setDestroyOnClose"></a>
<p class="title"><span class="function">setDestroyOnClose()</span> The window will be destroy by clicking on close button instead of being hidden</p>
</div>
<br style='clear:both'/>
<div class="function window" title="setCloseCallback"><a name="setCloseCallback"></a>
<p class="title"><span class="function">setCloseCallback(function)</span> Sets close callback function</p>
<p class="parameter">
<span class="field">function</span>
<span class="explanation">Close callback function, return true if the window can be closed, else return false</span>
</p>
</div>
<br style='clear:both'/>
<div class="function window" title="setContent"><a name="setContent"></a>
<p class="title"><span class="function">setContent(id, autoresize, autoposition)</span> Sets window content using an existing element (does not work with url/iframe)</p>
<p class="parameter">
<span class="field">id</span>
<span class="explanation">Element id to insert in the window</span>
</p>
<p class="parameter">
<span class="field">autoresize (default false)</span>
<span class="explanation">Resizes the window to fit with its content</span>
</p>
<p class="parameter">
<span class="field">autoposition (default false)</span>
<span class="explanation">Sets the current window position to the specified input element</span>
</p>
</div>
<br style='clear:both'/>
<div class="function window" title="setHTMLContent"><a name="setHTMLContent"></a>
<p class="title"><span class="function">setHTMLContent(html)</span> Sets window HTML content.</p>
<p class="parameter">
<span class="field">html</span>
<span class="explanation">HTML code</span>
</p>
</div>
<br style='clear:both'/>
<div class="function window" title="setURL"><a name="setURL"></a>
<p class="title"><span class="function">setURL(url)</span> Sets window content using an URL.</p>
<p class="parameter">
<span class="field">url</span>
<span class="explanation">URL for content (content will be shown using an iframe)</span>
</p>
</div>
<br style='clear:both'/>
<div class="function window" title="getURL"><a name="getURL"></a>
<p class="title"><span class="function">getURL()</span> Returns window URL content. Returns nil if content is not an url.</p>
</div>
<br style='clear:both'/>
<div class="function window" title="refresh"><a name="refresh"></a>
<p class="title"><span class="function">refresh()</span> Refreshes window URL content.s</p>
</div>
<br style='clear:both'/>
<div class="function window" title="setAjaxContent"><a name="setAjaxContent"></a>
<p class="title"><span class="function">setAjaxContent(url, options, showCentered, showModal)</span> Sets window content using an Ajax request. The request must return HTML code. See script.aculo.us <a href="http://wiki.script.aculo.us/scriptaculous/show/Ajax.Request">Ajax.request </a>documentation for details. When the response is received, the window is shown.</p>
<p class="parameter">
<span class="field">url</span>
<span class="explanation">Ajax request URL</span>
</p>
<p class="parameter">
<span class="field">options</span>
<span class="explanation">Ajax request options</span>
</p>
<p class="parameter">
<span class="field">showCentered (default false)</span>
<span class="explanation">Displays window centered when response is received</span>
</p>
<p class="parameter">
<span class="field">showModal (default false)</span>
<span class="explanation">Displays window in modal mode when response is received</span>
</p>
</div>
<br style='clear:both'/>
<div class="function window" title="getContent"><a name="getContent"></a>
<p class="title"><span class="function">getContent()</span> Returns current window content (a div or an iframe)</p>
</div>
<br style='clear:both'/>
<div class="function window" title="setCookie"><a name="setCookie"></a>
<p class="title"><span class="function">setCookie(name, expires, path, domain, secure)</span> Sets cookie informations to store window size and position</p>
<p class="parameter">
<span class="field">name (default window's id)</span>
<span class="explanation">Cookie name</span>
</p>
<p class="parameter">
<span class="field">expires, path, domain, secure</span>
<span class="explanation">Cookie attributes</span>
</p>
</div>
<br style='clear:both'/>
<div class="function window" title="setLocation"><a name="setLocation"></a>
<p class="title"><span class="function">setLocation(top, left)</span> Sets window top-left position</p>
<p class="parameter">
<span class="field">top</span>
<span class="explanation">Top position in pixels</span>
</p>
<p class="parameter">
<span class="field">bottom</span>
<span class="explanation">Bottom position in pixels</span>
</p>
</div>
<br style='clear:both'/>
<div class="function window" title="getSize"><a name="getSize"></a>
<p class="title"><span class="function">getSize()</span> Gets window content size. Return an hash with width and height as keys</p>
</div>
<div class="function window" title="setSize"><a name="setSize"></a>
<p class="title"><span class="function">setSize(width, height)</span> Sets window content size</p>
<p class="parameter">
<span class="field">width</span>
<span class="explanation">Width in pixels</span>
</p>
<p class="parameter">
<span class="field">height</span>
<span class="explanation">Height in pixels</span>
</p>
</div>
<br style='clear:both'/>
<div class="function window" title="updateWidth"><a name="updateWidth"></a>
<p class="title"><span class="function">updateWidth()</span> Recompute window width, useful when you change window content and do not want scrolling</p>
</div>
<br style='clear:both'/>
<div class="function window" title="updateHeight"><a name="updateHeight"></a>
<p class="title"><span class="function">updateHeight()</span> Recompute window height, useful when you change window content and do not want scrolling</p>
</div>
<br style='clear:both'/>
<div class="function window" title="toFront"><a name="toFront"></a>
<p class="title"><span class="function">toFront()</span> Brings current window in front of all others</p>
</div>
<br style='clear:both'/>
<div class="function window" title="show"><a name="show"></a>
<p class="title"><span class="function">show(modal)</span> Shows window at its current position</p>
<p class="parameter">
<span class="field">modal (default false)</span>
<span class="explanation">Modal mode</span>
</p>
</div>
<br style='clear:both'/>
<div class="function window" title="showCenter"><a name="showCenter"></a>
<p class="title"><span class="function">showCenter(modal, top, left)</span> Shows window in page's center. You can set top (or left) if you want to center only left (or top) value</p>
<p class="parameter">
<span class="field">modal (default false)</span>
<span class="field">top (default null)</span>
<span class="field">left (default null)</span>
<span class="explanation">Modal mode</span>
</p>
</div>
<br style='clear:both'/>
<div class="function window" title="minimize"><a name="minimize"></a>
<p class="title"><span class="function">minimize()</span> Minimizes the window, only top bar will be displayed</p>
</div>
<br style='clear:both'/>
<div class="function window" title="maximize"><a name="maximize"></a>
<p class="title"><span class="function">maximize()</span> Maximizes the window, the window will fit the viewable area of the page</p>
</div>
<br style='clear:both'/>
<div class="function window" title="isMinimized"><a name="isMinimized"></a>
<p class="title"><span class="function">isMinimized()</span> Returns true if the window is minimized</p>
</div>
<br style='clear:both'/>
<div class="function window" title="isMaximized"><a name="isMaximized"></a>
<p class="title"><span class="function">isMaximized()</span> Returns true if the window is maximized</p>
</div>
<br style='clear:both'/>
<div class="function window" title="setOpacity"><a name="setOpacity"></a>
<p class="title"><span class="function">setOpacity(opacity)</span> Sets window opacity</p>
<p class="parameter">
<span class="field">opacity</span>
<span class="explanation">Float value between 0 and 1</span>
</p>
</div>
<br style='clear:both'/>
<div class="function window" title="setZIndex"><a name="setZIndex"></a>
<p class="title"><span class="function">setZIndex(zindex)</span> Sets window zindex</p>
<p class="parameter">
<span class="field">zindex</span>
<span class="explanation">Int value</span>
</p>
</div>
<br style='clear:both'/>
<div class="function window" title="setTitle"><a name="setTitle"></a>
<p class="title"><span class="function">setTitle(title)</span> Sets window title</p>
<p class="parameter">
<span class="field">title</span>
<span class="explanation">Window title (can be null)</span>
</p>
</div>
<br style='clear:both'/>
<div class="function window" title="getTitle"><a name="setTitle"></a>
<p class="title"><span class="function">getTitle()</span> Gets window title</p>
<p class="parameter">
<span class="explanation">Return window's title</span>
</p>
</div>
<br style='clear:both'/>
<div class="function window" title="setStatusBar"><a name="setStatusBar"></a>
<p class="title"><span class="function">setStatusBar(element)</span> Sets window status bar</p>
<p class="parameter">
<span class="field">element</span>
<span class="explanation">Can be HTML code or an element</span>
</p>
</div>
<br style='clear:both'/>
<h2> Dialog module</h2>
Dialog factory to open alert/confirm/info modal panels<br/><br/>
<div class="function dialogmodule" title="confirm"><a name="confirm"></a>
<p class="title"><span class="function">confirm(content, options)</span> Opens a modal dialog with two buttons (ok/cancel for example)</p>
<p class="parameter">
<span class="field">content</span>
<span class="explanation">
- If the content is a string, it will be the message displayed in the dialog (HTML code)<br>
- If the content is an hash map, it will be used for setting content with an AJAX request. The hashmap must have url key and an optional options key (ajax options request)
</span>
</p>
<p class="parameter">
<span class="field">options</span>
<span class="explanation">
Hash map of dialog options, here is the key list:
<table>
<tr><th>Key</th> <th>Default</th> <th>Description </th></tr>
<tr><td class="key">top</td> <td class="default">null</td> <td class="detail">Top position </td></tr>
<tr><td class="key">left</td> <td class="default">null</td> <td class="detail">Left position </td></tr>
<tr><td class="key">okLabel</td> <td class="default">Ok</td> <td class="detail">Ok button label </td></tr>
<tr><td class="key">cancelLabel</td> <td class="default">Cancel</td> <td class="detail">Cancel button label </td></tr>
<tr><td class="key">onOk</td> <td class="default">none</td> <td class="detail">Ok callback function called on ok button</td></tr>
<tr><td class="key">onCancel</td> <td class="default">none</td> <td class="detail">Cancel callback function called on ok button </td></tr>
<tr><td class="key">buttonClass</td> <td class="default">none</td> <td class="detail">Ok/Cancel button css class name </td></tr>
<tr><td class="key">All window parameters</td> <td class="default">none</td> <td class="detail">Add all window constructor options </td></tr>
</table>
</span>
</p>
</div>
<br style='clear:both'/>
<div class="function dialogmodule" title="alert"><a name="alert"></a>
<p class="title"><span class="function">alert(content, options)</span> Opens a modal alert with one button (ok for example)</p>
<p class="parameter">
<span class="field">content</span>
<span class="explanation">
- If the content is a string, it will be the message displayed in the dialog (HTML code)<br>
- If the content is an hash map, it will be used for setting content with an AJAX request. The hashmap must have url key and an optional options key (ajax options request)
</span>
</p>
<p class="parameter">
<span class="field">options</span>
<span class="explanation">
Hash map of dialog options, here is the key list:
<table>
<tr><th>Key</th> <th>Default</th> <th>Description </th></tr>
<tr><td class="key">top</td> <td class="default">null</td> <td class="detail">Top position </td></tr>
<tr><td class="key">left</td> <td class="default">null</td> <td class="detail">Left position </td></tr>
<tr><td class="key">okLabel</td> <td class="default">Ok</td> <td class="detail">Ok button label </td></tr>
<tr><td class="key">onOk</td> <td class="default">none</td> <td class="detail">Ok callback function called on ok button</td></tr>
<tr><td class="key">buttonClass</td> <td class="default">none</td> <td class="detail">Ok/Cancel button css class name </td></tr>
<tr><td class="key">All window parameters</td> <td class="default">none</td> <td class="detail">Add all window constructor options </td></tr>
</table>
</span>
</p>
</div>
<br style='clear:both'/>
<div class="function dialogmodule" title="info"><a name="info"></a>
<p class="title"><span class="function">info(content, options)</span> Opens a modal info panel without any button. It can have a progress image (Used to display submit waiting message for example)</p>
<p class="parameter">
<span class="field">content</span>
<span class="explanation">
- If the content is a string, it will be the message displayed in the dialog (HTML code)<br>
- If the content is an hash map, it will be used for setting content with an AJAX request. The hashmap must have url key and an optional options key (ajax options request)
</span>
</p>
<p class="parameter">
<span class="field">options</span>
<span class="explanation">
Hash map of dialog options, here is the key list:
<table>
<tr><th>Key</th> <th>Default</th> <th>Description </th></tr>
<tr><td class="key">top</td> <td class="default">null</td> <td class="detail">Top position </td></tr>
<tr><td class="key">left</td> <td class="default">null</td> <td class="detail">Left position </td></tr>
<tr><td class="key">showProgress</td> <td class="default">false</td> <td class="detail">Add a progress image (info found in the css file) </td></tr>
<tr><td class="key">All window parameters</td> <td class="default">none</td> <td class="detail">Add all window constructor options </td></tr>
</table>
</span>
</p>
</div>
<br style='clear:both'/>
<div class="function dialogmodule" title="setInfoMessage"><a name="setInfoMessage"></a>
<p class="title"><span class="function">setInfoMessage(message)</span> Sets info message (Used to display waiting information like 32% done for example)</p>
<p class="parameter">
<span class="field">message</span>
<span class="explanation">New info message</span>
</p>
</div>
<br style='clear:both'/>
<div class="function dialogmodule" title="closeInfo"><a name="closeInfo"></a>
<p class="title"><span class="function">closeInfo()</span> Closes the current modal dialog</p>
</div>
<div style="clear:both"></div>
<h2> Windows</h2>
Windows factory. Handles created windows, and windows observers<br/><br/>
<div class="function windows" title="overlayShowEffectOptions"><a name="overlayShowEffectOptions"></a>
<p class="title"><span class="function">overlayShowEffectOptions</span> Overlay show effect options. <br/> <br/>
By default it's <em>{duration: 0.5}</em>. If you set it to null, no effects will be applied
</p>
</div>
<br style='clear:both'/>
<div class="function windows" title="overlayHideEffectOptions"><a name="overlayHideEffectOptions"></a>
<p class="title"><span class="function">overlayHideEffectOptions</span> Overlay hide effect options. <br/> <br/>
By default it's <em>{duration: 0.5}</em>. If you set it to null, no effects will be applied.
</p>
</div>
<br style='clear:both'/>
<div class="function windows" title="addObserver"><a name="addObserver"></a>
<p class="title"><span class="function">addObserver(observer)</span> Registers a new windows observer. Should be able to respond to <br/>
<em>onDestroy onStartResize onStartMove onResize onMove onEndResize onEndMove onFocus onBlur onBeforeShow onShow onHide onMinimize onMaximize onClose</em>
</p>
<p class="parameter">
<span class="field">observer</span>
<span class="explanation">Observer object</span>
</p>
</div>
<br style='clear:both'/>
<div class="function windows" title="removeObserver"><a name="removeObserver"></a>
<p class="title"><span class="function">removeObserver(observer)</span> Unregisters a windows observer. </p>
<p class="parameter">
<span class="field">observer</span>
<span class="explanation">Observer object</span>
</p>
</div>
<br style='clear:both'/>
<div class="function windows" title="closeAll"><a name="closeAll"></a>
<p class="title"><span class="function">closeAll()</span> Closes all closeable windows. </p>
</div>
<br style='clear:both'/>
<div class="function windows" title="getFocusedWindow"><a name="getFocusedWindow"></a>
<p class="title"><span class="function">getFocusedWindow()</span> Returns the focused window. </p>
</div>
<br style='clear:both'/>
<div class="function windows" title="focus"><a name="focus"></a>
<p class="title"><span class="function">focus(id)</span> Focus a window using it's id. </p>
<p class="parameter">
<span class="field">id</span>
<span class="explanation">Window's id</span>
</p>
</div>
<br style='clear:both'/>
<div class="function windows" title="blur"><a name="focus"></a>
<p class="title"><span class="function">blur(id)</span> Blur a window using it's id. </p>
<p class="parameter">
<span class="field">id</span>
<span class="explanation">Window's id</span>
</p>
</div>
<br style='clear:both'/>
<h2> Add-ons</h2>
Add-on behaviors to PWC<br/><br/>
<div class="function addons" title="WindowsStore.init"><a name="WindowsStore.init"></a>
<p class="title"><span class="function">WindowsStore.init(cookieName, expired)</span> Save automatically show/hide window status. Just add WindowsStore.init() at the end of you HTML file. </p>
<p class="parameter">
<span class="field">cookieName</span>
<span class="explanation">Cookie name used to store window information (default: <em>__window_store__</em>)</span>
</p>
<p class="parameter">
<span class="field">expired</span>
<span class="explanation">Cookie expiration date (default: <em>In 3 years!!</em>)</span>
</p>
</div>
<br style='clear:both'/>
<div class="function addons" title="WindowCloseKey.init"><a name="WindowCloseKey.init"></a>
<p class="title"><span class="function">WindowCloseKey.init(keyCode)</span> Handle key to close windows or dialogs. Just add WindowsStore.init() at the end of you HTML file. </p>
<p class="parameter">
<span class="field">keyCode</span>
<span class="explanation">Key used to close windows (default: <em>Event.KEY_ESC</em>)</span>
</p>
</div>
<br style='clear:both'/>
<div class="function addons" title="TooltipManager"><a name="TooltipManager"></a>
<p class="title"><span class="function">TooltipManager</span> Singleton to handle tooltips using PWC. </p>
<p class="parameter">
<span class="explanation">Tooltips are not "regular" tooltips that show/hide on specific areas. Those tooltips are PWC windows that keeps alive in you move the mouse over it.
Like this, you can have forms, links are anything you want in your tooltips.<br/><br/>
Tooltips content can be set by giving a html element already present in the page (usually hidden), by ajax using an url or by url.
It works in two modes:
<li>An unobtrusive mode using specific class name. In this mode only HTML and Ajax content are supported</li>
<li>Regular mode by adding tooltip using javascript code.</li>
<br/>
Check sample code in samples/tooltips/tooltip.html to see how it works.
</span>
</p>
</div>
<br style='clear:both'/>
</div>
</div>
<script type="text/javascript">Application.addRightColumn()</script>
<br/>
<br/>
</body>
</html>
|
