← Back to branch summary

~jstys-z/helioviewer.org/client5

« back to all changes in this revision

Viewing changes to docs/symbols/MessageConsole.html

  • Committer: V. Keith Hughitt
  • Date: 2009-04-01 21:08:05 UTC
  • Revision ID: hughitt1@kore-20090401210805-372f7dgih07vxk42
nightly build 04-01-2009

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/symbols/MessageConsole.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 
2
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
3
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
4
        <head>
 
5
                <meta http-equiv="content-type" content="text/html; charset=utf-8" />
 
6
                <meta name="generator" content="JsDoc Toolkit" />
 
7
                
 
8
                <title>JsDoc Reference - MessageConsole</title>
 
9
 
 
10
                <style type="text/css">
 
11
                        /* default.css */
 
12
body
 
13
{
 
14
        font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
 
15
        width: 800px;
 
16
}
 
17
 
 
18
.header
 
19
{
 
20
        clear: both;
 
21
        background-color: #ccc;
 
22
        padding: 8px;
 
23
}
 
24
 
 
25
h1
 
26
{
 
27
        font-size: 150%;
 
28
        font-weight: bold;
 
29
        padding: 0;
 
30
        margin: 1em 0 0 .3em;
 
31
}
 
32
 
 
33
hr
 
34
{
 
35
        border: none 0;
 
36
        border-top: 1px solid #7F8FB1;
 
37
        height: 1px;
 
38
}
 
39
 
 
40
pre.code
 
41
{
 
42
        display: block;
 
43
        padding: 8px;
 
44
        border: 1px dashed #ccc;
 
45
}
 
46
 
 
47
#index
 
48
{
 
49
        margin-top: 24px;
 
50
        float: left;
 
51
        width: 160px;
 
52
        position: absolute;
 
53
        left: 8px;
 
54
        background-color: #F3F3F3;
 
55
        padding: 8px;
 
56
}
 
57
 
 
58
#content
 
59
{
 
60
        margin-left: 190px;
 
61
        width: 600px;
 
62
}
 
63
 
 
64
.classList
 
65
{
 
66
        list-style-type: none;
 
67
        padding: 0;
 
68
        margin: 0 0 0 8px;
 
69
        font-family: arial, sans-serif;
 
70
        font-size: 1em;
 
71
        overflow: auto;
 
72
}
 
73
 
 
74
.classList li
 
75
{
 
76
        padding: 0;
 
77
        margin: 0 0 8px 0;
 
78
}
 
79
 
 
80
.summaryTable { width: 100%; }
 
81
 
 
82
h1.classTitle
 
83
{
 
84
        font-size:170%;
 
85
        line-height:130%;
 
86
}
 
87
 
 
88
h2 { font-size: 110%; }
 
89
caption, div.sectionTitle
 
90
{
 
91
        background-color: #7F8FB1;
 
92
        color: #fff;
 
93
        font-size:130%;
 
94
        text-align: left;
 
95
        padding: 2px 6px 2px 6px;
 
96
        border: 1px #7F8FB1 solid;
 
97
}
 
98
 
 
99
div.sectionTitle { margin-bottom: 8px; }
 
100
.summaryTable thead { display: none; }
 
101
 
 
102
.summaryTable td
 
103
{
 
104
        vertical-align: top;
 
105
        padding: 4px;
 
106
        border-bottom: 1px #7F8FB1 solid;
 
107
        border-right: 1px #7F8FB1 solid;
 
108
}
 
109
 
 
110
/*col#summaryAttributes {}*/
 
111
.summaryTable td.attributes
 
112
{
 
113
        border-left: 1px #7F8FB1 solid;
 
114
        width: 140px;
 
115
        text-align: right;
 
116
}
 
117
 
 
118
td.attributes, .fixedFont
 
119
{
 
120
        line-height: 15px;
 
121
        color: #002EBE;
 
122
        font-family: "Courier New",Courier,monospace;
 
123
        font-size: 13px;
 
124
}
 
125
 
 
126
.summaryTable td.nameDescription
 
127
{
 
128
        text-align: left;
 
129
        font-size: 13px;
 
130
        line-height: 15px;
 
131
}
 
132
 
 
133
.summaryTable td.nameDescription, .description
 
134
{
 
135
        line-height: 15px;
 
136
        padding: 4px;
 
137
        padding-left: 4px;
 
138
}
 
139
 
 
140
.summaryTable { margin-bottom: 8px; }
 
141
 
 
142
ul.inheritsList
 
143
{
 
144
        list-style: square;
 
145
        margin-left: 20px;
 
146
        padding-left: 0;
 
147
}
 
148
 
 
149
.detailList {
 
150
        margin-left: 20px; 
 
151
        line-height: 15px;
 
152
}
 
153
.detailList dt { margin-left: 20px; }
 
154
 
 
155
.detailList .heading
 
156
{
 
157
        font-weight: bold;
 
158
        padding-bottom: 6px;
 
159
        margin-left: 0;
 
160
}
 
161
 
 
162
.light, td.attributes, .light a:link, .light a:visited
 
163
{
 
164
        color: #777;
 
165
        font-style: italic;
 
166
}
 
167
 
 
168
.fineprint
 
169
{
 
170
        text-align: right;
 
171
        font-size: 10px;
 
172
}
 
173
                </style>
 
174
        </head>
 
175
 
 
176
        <body>
 
177
<!-- ============================== header ================================= -->        
 
178
                <!-- begin static/header.html -->
 
179
                <div id="header">
 
180
</div>
 
181
                <!-- end static/header.html -->
 
182
 
 
183
<!-- ============================== classes index ============================ -->
 
184
                <div id="index">
 
185
                        <!-- begin publish.classesIndex -->
 
186
                        <div align="center"><a href="../index.html">Class Index</a>
 
187
| <a href="../files.html">File Index</a></div>
 
188
<hr />
 
189
<h2>Classes</h2>
 
190
<ul class="classList">
 
191
        
 
192
        <li><i><a href="../symbols/_global_.html">_global_</a></i></li>
 
193
        
 
194
        <li><a href="../symbols/Calendar.html">Calendar</a></li>
 
195
        
 
196
        <li><a href="../symbols/Date.html">Date</a></li>
 
197
        
 
198
        <li><a href="../symbols/EventLayer.html">EventLayer</a></li>
 
199
        
 
200
        <li><a href="../symbols/EventLayerAccordion.html">EventLayerAccordion</a></li>
 
201
        
 
202
        <li><a href="../symbols/EventMarker.html">EventMarker</a></li>
 
203
        
 
204
        <li><a href="../symbols/EventTimeline.html">EventTimeline</a></li>
 
205
        
 
206
        <li><a href="../symbols/Helioviewer.html">Helioviewer</a></li>
 
207
        
 
208
        <li><a href="../symbols/Helioviewer%23handlers.html">Helioviewer#handlers</a></li>
 
209
        
 
210
        <li><a href="../symbols/IconPicker.html">IconPicker</a></li>
 
211
        
 
212
        <li><a href="../symbols/Layer.html">Layer</a></li>
 
213
        
 
214
        <li><a href="../symbols/LayerManager.html">LayerManager</a></li>
 
215
        
 
216
        <li><a href="../symbols/LoadingIndicator.html">LoadingIndicator</a></li>
 
217
        
 
218
        <li><a href="../symbols/Math.html">Math</a></li>
 
219
        
 
220
        <li><a href="../symbols/MessageConsole.html">MessageConsole</a></li>
 
221
        
 
222
        <li><a href="../symbols/MovieBuilder.html">MovieBuilder</a></li>
 
223
        
 
224
        <li><a href="../symbols/String.html">String</a></li>
 
225
        
 
226
        <li><a href="../symbols/TileLayer.html">TileLayer</a></li>
 
227
        
 
228
        <li><a href="../symbols/TileLayerAccordion.html">TileLayerAccordion</a></li>
 
229
        
 
230
        <li><a href="../symbols/TimeControls.html">TimeControls</a></li>
 
231
        
 
232
        <li><a href="../symbols/UIElement.html">UIElement</a></li>
 
233
        
 
234
        <li><a href="../symbols/UserSettings.html">UserSettings</a></li>
 
235
        
 
236
        <li><a href="../symbols/Viewport.html">Viewport</a></li>
 
237
        
 
238
        <li><a href="../symbols/ViewportHandlers.html">ViewportHandlers</a></li>
 
239
        
 
240
        <li><a href="../symbols/ZoomControl.html">ZoomControl</a></li>
 
241
        
 
242
</ul>
 
243
<hr />
 
244
                        <!-- end publish.classesIndex -->
 
245
                </div>
 
246
                
 
247
                <div id="content">
 
248
<!-- ============================== class title ============================ -->
 
249
                        <h1 class="classTitle">
 
250
                                
 
251
                                Class MessageConsole
 
252
                        </h1>
 
253
 
 
254
<!-- ============================== class summary ========================== -->                        
 
255
                        <p class="description">
 
256
                                
 
257
                        
 
258
                                
 
259
                                
 
260
                                
 
261
                                        <br /><i>Defined in: </i> <a href="../symbols/src/lib_helioviewer_MessageConsole.js.html">MessageConsole.js</a>.
 
262
                                
 
263
                        </p>
 
264
 
 
265
<!-- ============================== constructor summary ==================== -->                        
 
266
                        
 
267
                        <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class MessageConsole.">
 
268
                                <caption>Class Summary</caption>
 
269
                                <thead>
 
270
                                        <tr>
 
271
                                                <th scope="col">Constructor Attributes</th>
 
272
                                                <th scope="col">Constructor Name and Description</th>
 
273
                                        </tr>
 
274
                                </thead>
 
275
                                <tbody>
 
276
                                        <tr>
 
277
                                                <td class="attributes">&nbsp;</td>
 
278
                                                <td class="nameDescription" >
 
279
                                                        <div class="fixedFont">
 
280
                                                                <b><a href="../symbols/MessageConsole.html">MessageConsole</a></b>(controller, container, viewport)
 
281
                                                        </div>
 
282
                                                        <div class="description">Creates a new MessageConsole.</div>
 
283
                                                </td>
 
284
                                        </tr>
 
285
                                </tbody>
 
286
                        </table>
 
287
                        
 
288
 
 
289
<!-- ============================== properties summary ===================== -->
 
290
                        
 
291
 
 
292
<!-- ============================== methods summary ======================== -->
 
293
                        
 
294
                                
 
295
                                
 
296
                                <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class MessageConsole.">
 
297
                                        <caption>Method Summary</caption>
 
298
                                        <thead>
 
299
                                                <tr>
 
300
                                                        <th scope="col">Method Attributes</th>
 
301
                                                        <th scope="col">Method Name and Description</th>
 
302
                                                </tr>
 
303
                                        </thead>
 
304
                                        <tbody>
 
305
                                        
 
306
                                                <tr>
 
307
                                                        <td class="attributes">&nbsp;</td>
 
308
                                                        <td class="nameDescription">
 
309
                                                                <div class="fixedFont"><b><a href="../symbols/MessageConsole.html#error">error</a></b>(msg)
 
310
                                                                </div>
 
311
                                                                <div class="description">Displays an error message in the message console</div>
 
312
                                                        </td>
 
313
                                                </tr>
 
314
                                        
 
315
                                                <tr>
 
316
                                                        <td class="attributes">&nbsp;</td>
 
317
                                                        <td class="nameDescription">
 
318
                                                                <div class="fixedFont"><b><a href="../symbols/MessageConsole.html#link">link</a></b>(msg, Hyperlink)
 
319
                                                                </div>
 
320
                                                                <div class="description">Displays message along with a hyperlink in the message console</div>
 
321
                                                        </td>
 
322
                                                </tr>
 
323
                                        
 
324
                                                <tr>
 
325
                                                        <td class="attributes">&nbsp;</td>
 
326
                                                        <td class="nameDescription">
 
327
                                                                <div class="fixedFont"><b><a href="../symbols/MessageConsole.html#log">log</a></b>(msg)
 
328
                                                                </div>
 
329
                                                                <div class="description">Logs a message to the message-console</div>
 
330
                                                        </td>
 
331
                                                </tr>
 
332
                                        
 
333
                                                <tr>
 
334
                                                        <td class="attributes">&nbsp;</td>
 
335
                                                        <td class="nameDescription">
 
336
                                                                <div class="fixedFont"><b><a href="../symbols/MessageConsole.html#warn">warn</a></b>(msg)
 
337
                                                                </div>
 
338
                                                                <div class="description">Displays a warning message in the message console</div>
 
339
                                                        </td>
 
340
                                                </tr>
 
341
                                        
 
342
                                        </tbody>
 
343
                                </table>
 
344
                                
 
345
                                
 
346
                                
 
347
                        
 
348
<!-- ============================== events summary ======================== -->
 
349
                        
 
350
 
 
351
<!-- ============================== constructor details ==================== -->                
 
352
                        
 
353
                        <div class="details"><a name="constructor"> </a>
 
354
                                <div class="sectionTitle">
 
355
                                        Class Detail
 
356
                                </div>
 
357
                                
 
358
                                <div class="fixedFont">
 
359
                                                <b>MessageConsole</b>(controller, container, viewport)
 
360
                                </div>
 
361
                                
 
362
                                <div class="description">
 
363
                                        Creates a new MessageConsole.<br><br>
 
364
MessageConsole Provides a mechanism for displayed useful information to the user.
 
365
For ease of use, the class provides methods comparable to Firebug's for outputting
 
366
messages of different natures: "log" for generic unstyled messages, or for debbuging
 
367
use, "info" to inform the user of some interesting change or event, and "warning" and
 
368
"error" for getting the user's attention.
 
369
                                        
 
370
                                </div>
 
371
                                
 
372
                                
 
373
                                
 
374
                                
 
375
                                        
 
376
                                                <dl class="detailList">
 
377
                                                <dt class="heading">Parameters:</dt>
 
378
                                                
 
379
                                                        <dt>
 
380
                                                                <span class="light fixedFont">{Object}</span>  <b>controller</b>
 
381
                                                                
 
382
                                                        </dt>
 
383
                                                                <dd>A reference to the Helioviewer (controller)</dd>
 
384
                                                
 
385
                                                        <dt>
 
386
                                                                <span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span>  <b>container</b>
 
387
                                                                
 
388
                                                        </dt>
 
389
                                                                <dd>The id of the container for messages to be displayed in</dd>
 
390
                                                
 
391
                                                        <dt>
 
392
                                                                <span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span>  <b>viewport</b>
 
393
                                                                
 
394
                                                        </dt>
 
395
                                                                <dd>The id of the viewport container</dd>
 
396
                                                
 
397
                                                </dl>
 
398
                                        
 
399
                                        
 
400
                                        
 
401
                                        
 
402
                                        
 
403
                                        
 
404
                                        
 
405
 
 
406
                        </div>
 
407
                        
 
408
 
 
409
<!-- ============================== field details ========================== -->                
 
410
                        
 
411
 
 
412
<!-- ============================== method details ========================= -->                
 
413
                        
 
414
                                <div class="sectionTitle">
 
415
                                        Method Detail
 
416
                                </div>
 
417
                                
 
418
                                        <a name="error"> </a>
 
419
                                        <div class="fixedFont">
 
420
                                        
 
421
                                        
 
422
                                        <b>error</b>(msg)
 
423
                                        
 
424
                                        </div>
 
425
                                        <div class="description">
 
426
                                                Displays an error message in the message console
 
427
                                                
 
428
                                                
 
429
                                        </div>
 
430
                                        
 
431
                                        
 
432
                                        
 
433
                                                
 
434
                                                        <dl class="detailList">
 
435
                                                        <dt class="heading">Parameters:</dt>
 
436
                                                        
 
437
                                                                <dt>
 
438
                                                                        <span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>msg</b>
 
439
                                                                        
 
440
                                                                </dt>
 
441
                                                                <dd>Message to display</dd>
 
442
                                                        
 
443
                                                        </dl>
 
444
                                                
 
445
                                                
 
446
                                                
 
447
                                                
 
448
                                                
 
449
                                                
 
450
                                                
 
451
 
 
452
                                        <hr />
 
453
                                
 
454
                                        <a name="link"> </a>
 
455
                                        <div class="fixedFont">
 
456
                                        
 
457
                                        
 
458
                                        <b>link</b>(msg, Hyperlink)
 
459
                                        
 
460
                                        </div>
 
461
                                        <div class="description">
 
462
                                                Displays message along with a hyperlink in the message console
 
463
                                                
 
464
                                                
 
465
                                        </div>
 
466
                                        
 
467
                                        
 
468
                                        
 
469
                                                
 
470
                                                        <dl class="detailList">
 
471
                                                        <dt class="heading">Parameters:</dt>
 
472
                                                        
 
473
                                                                <dt>
 
474
                                                                        <span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>msg</b>
 
475
                                                                        
 
476
                                                                </dt>
 
477
                                                                <dd>Message to display</dd>
 
478
                                                        
 
479
                                                                <dt>
 
480
                                                                        <span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>Hyperlink</b>
 
481
                                                                        
 
482
                                                                </dt>
 
483
                                                                <dd>text (Note: Event-handler should be used to handle hyperlink clicks. The link address thus is set to "#")</dd>
 
484
                                                        
 
485
                                                        </dl>
 
486
                                                
 
487
                                                
 
488
                                                
 
489
                                                
 
490
                                                
 
491
                                                
 
492
                                                
 
493
 
 
494
                                        <hr />
 
495
                                
 
496
                                        <a name="log"> </a>
 
497
                                        <div class="fixedFont">
 
498
                                        
 
499
                                        
 
500
                                        <b>log</b>(msg)
 
501
                                        
 
502
                                        </div>
 
503
                                        <div class="description">
 
504
                                                Logs a message to the message-console
 
505
                                                
 
506
                                                
 
507
                                        </div>
 
508
                                        
 
509
                                        
 
510
                                        
 
511
                                                
 
512
                                                        <dl class="detailList">
 
513
                                                        <dt class="heading">Parameters:</dt>
 
514
                                                        
 
515
                                                                <dt>
 
516
                                                                        <span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>msg</b>
 
517
                                                                        
 
518
                                                                </dt>
 
519
                                                                <dd>Message to display</dd>
 
520
                                                        
 
521
                                                        </dl>
 
522
                                                
 
523
                                                
 
524
                                                
 
525
                                                
 
526
                                                
 
527
                                                
 
528
                                                
 
529
 
 
530
                                        <hr />
 
531
                                
 
532
                                        <a name="warn"> </a>
 
533
                                        <div class="fixedFont">
 
534
                                        
 
535
                                        
 
536
                                        <b>warn</b>(msg)
 
537
                                        
 
538
                                        </div>
 
539
                                        <div class="description">
 
540
                                                Displays a warning message in the message console
 
541
                                                
 
542
                                                
 
543
                                        </div>
 
544
                                        
 
545
                                        
 
546
                                        
 
547
                                                
 
548
                                                        <dl class="detailList">
 
549
                                                        <dt class="heading">Parameters:</dt>
 
550
                                                        
 
551
                                                                <dt>
 
552
                                                                        <span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>msg</b>
 
553
                                                                        
 
554
                                                                </dt>
 
555
                                                                <dd>Message to display</dd>
 
556
                                                        
 
557
                                                        </dl>
 
558
                                                
 
559
                                                
 
560
                                                
 
561
                                                
 
562
                                                
 
563
                                                
 
564
                                                
 
565
 
 
566
                                        
 
567
                                
 
568
                        
 
569
                        
 
570
<!-- ============================== event details ========================= -->         
 
571
                        
 
572
                        
 
573
                        <hr />
 
574
                </div>
 
575
 
 
576
                
 
577
<!-- ============================== footer ================================= -->
 
578
                <div class="fineprint" style="clear:both">
 
579
                        
 
580
                        Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Wed Feb 25 2009 14:47:29 GMT-0500 (EST)
 
581
                </div>
 
582
        </body>
 
583
</html>