source: cows/branches/cows-vis/cows/pylons/project_templates/cows_server/+package+/public/js/yui/api/Drop.html @ 5259

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/cows/branches/cows-vis/cows/pylons/project_templates/cows_server/+package+/public/js/yui/api/Drop.html@5259
Revision 5259, 60.8 KB checked in by domlowe, 11 years ago (diff)

adding yui javascript

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
2<html>
3<head>
4        <title>API: dd  Drop   (YUI Library)</title>
5        <link rel="stylesheet" type="text/css" href="assets/api.css">
6    <script type="text/javascript" src="assets/api-js"></script>
7    <script type="text/javascript" src="assets/ac-js"></script>
8</head>
9
10<body id="yahoo-com">
11
12<div id="doc3" class="yui-t2">
13
14        <div id="hd">
15        <a href="http://developer.yahoo.com/yui/"><h1>Yahoo! UI Library</h1></a>
16        <h3>dd&nbsp; <span class="subtitle">3.0.0pr1</span></h3>
17        <p>
18        <a href="./index.html">Yahoo! UI Library</a> 
19            &gt; <a href="./module_dd.html">dd</a>
20                 &gt; Drop
21               
22            </p>
23
24
25        </div>
26
27        <div id="bd">
28                <div id="yui-main">
29                        <div class="yui-b">
30            <form name="yui-classopts-form">
31    <span id="classopts"><input type="checkbox" name="showprivate" id="showprivate" /> <label for="showprivate">Show Private</label></span>
32    <span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> <label for="showprotected">Show Protected</label></span>
33    <span id="classopts"><input type="checkbox" name="showdeprecated" id="showdeprecated" /> <label for="showdeprecated">Show Deprecated</label></span>
34            </form>
35
36                    <h2>
37                       
38
39                       
40                       
41                            Class <b>Drop</b>
42                        <span class="extends">
43                           - extends <a href="Base.html">Base</a>
44                        </span>
45
46                        <span class="extends">
47                        </span>
48                       
49                        </code>
50                    </h2>
51                    <!-- class tree goes here -->
52                   
53                        <dl class="subclasses">
54                            <dt>Known Subclasses:</dd>
55                            <dd>
56                                    <a href="DropPlugin.html">DropPlugin</a>
57                            </dd>
58                       </dl>
59               
60 
61
62                    <div class="summary description">
63                        This class provides the ability to create a Drop Target.
64                    </div>
65
66                        <div class="section constructor details">
67                        <h3 id="constructor">Constructor</h3>
68                        <div class="content">
69                            <div class="detail">
70                                <strong>Drop</strong>
71                                <code>
72                                    (
73                                    )
74                                </code>
75                                <div class="description">
76                                   
77                                   
78                                </div>
79                            </div>
80                        </div>
81                    </div>
82
83                        <div class="section field details">
84                            <h3 id="properties">Properties</h3>
85                            <div class="content">
86                                    <div class="private">
87                                    <h4><a name="property__groups">_groups</a>
88                                        <code>- private Array</code>
89                                    </h4>
90                                    <div class="detail">
91                                        <div class="description">
92                                            The groups this target belongs to.
93                                        </div>
94                                    </div>
95     
96                                       
97
98
99                                    <hr />
100                                    </div>
101                                    <div class="private">
102                                    <h4><a name="property__valid">_valid</a>
103                                        <code>- private Boolean</code>
104                                    </h4>
105                                    <div class="detail">
106                                        <div class="description">
107                                            Flag for determining if the target is valid in this operation.
108                                        </div>
109                                    </div>
110     
111                                       
112
113
114                                    <hr />
115                                    </div>
116                                    <div class="">
117                                    <h4><a name="property_overTarget">overTarget</a>
118                                        <code>- Boolean</code>
119                                    </h4>
120                                    <div class="detail">
121                                        <div class="description">
122                                            This flag is tripped when a drag element is over this target.
123                                        </div>
124                                    </div>
125     
126                                       
127
128
129                                    <hr />
130                                    </div>
131                                    <div class="">
132                                    <h4><a name="property_region">region</a>
133                                        <code>- Object</code>
134                                    </h4>
135                                    <div class="detail">
136                                        <div class="description">
137                                            A region object associated with this target, used for checking regions while dragging.
138                                        </div>
139                                    </div>
140     
141                                       
142
143
144                                    <hr />
145                                    </div>
146                                    <div class="">
147                                    <h4><a name="property_shim">shim</a>
148                                        <code>- {Object}</code>
149                                    </h4>
150                                    <div class="detail">
151                                        <div class="description">
152                                            Node reference to the targets shim
153                                        </div>
154                                    </div>
155     
156                                       
157
158
159                                    <hr />
160                                    </div>
161
162
163                            </div>
164                        </div>
165
166                        <div class="section field inheritance">
167                            <h4>Properties inherited from <a href="Attribute.html">Attribute</a>:</h4>
168                            <div class="content">
169                                <code>
170                                   
171                                </code>
172                            </div>
173                        </div>
174                        <div class="section field inheritance">
175                            <h4>Properties inherited from <a href="Base.html">Base</a>:</h4>
176                            <div class="content">
177                                <code>
178                                   
179                                        <a class="" href="Base.html#property_name">name</a>
180                                </code>
181                            </div>
182                        </div>
183
184                        <div class="section method details">
185                            <h3 id="methods">Methods</h3>
186                            <div class="content">
187                                    <div class="private">
188                                    <h4>
189                                        <a name="method__activateShim">_activateShim</a></h4>
190                                    <div class="detail">
191                                        <code>
192                                         private
193                                       
194                                       
195                                        void
196                                            <strong>_activateShim</strong>
197                                           (
198                                            )
199                                        </code>
200                                       
201                                        <div class="description">
202                                            Activates the shim and adds some interaction CSS classes
203                                        </div>
204
205                                        <div class="description">
206
207
208                                                <dl>
209                                                    <dt>Returns:
210                                                    <code>
211                                                        void
212                                                    </code></dt>
213                                                    <dd></dd>
214                                                </dl>
215
216
217             
218
219                                        </div>
220
221                                    </div>
222                                    <hr />
223                                    </div>
224                                    <div class="private">
225                                    <h4>
226                                        <a name="method__createEvents">_createEvents</a></h4>
227                                    <div class="detail">
228                                        <code>
229                                         private
230                                       
231                                       
232                                        void
233                                            <strong>_createEvents</strong>
234                                           (
235                                            )
236                                        </code>
237                                       
238                                        <div class="description">
239                                            This method creates all the events for this Event Target and publishes them so we get Event Bubbling.
240                                        </div>
241
242                                        <div class="description">
243
244
245                                                <dl>
246                                                    <dt>Returns:
247                                                    <code>
248                                                        void
249                                                    </code></dt>
250                                                    <dd></dd>
251                                                </dl>
252
253
254             
255
256                                        </div>
257
258                                    </div>
259                                    <hr />
260                                    </div>
261                                    <div class="private">
262                                    <h4>
263                                        <a name="method__createShim">_createShim</a></h4>
264                                    <div class="detail">
265                                        <code>
266                                         private
267                                       
268                                       
269                                        void
270                                            <strong>_createShim</strong>
271                                           (
272                                            )
273                                        </code>
274                                       
275                                        <div class="description">
276                                            Creates the Target shim and adds it to the DDM's playground..
277                                        </div>
278
279                                        <div class="description">
280
281
282                                                <dl>
283                                                    <dt>Returns:
284                                                    <code>
285                                                        void
286                                                    </code></dt>
287                                                    <dd></dd>
288                                                </dl>
289
290
291             
292
293                                        </div>
294
295                                    </div>
296                                    <hr />
297                                    </div>
298                                    <div class="private">
299                                    <h4>
300                                        <a name="method__deactivateShim">_deactivateShim</a></h4>
301                                    <div class="detail">
302                                        <code>
303                                         private
304                                       
305                                       
306                                        void
307                                            <strong>_deactivateShim</strong>
308                                           (
309                                            )
310                                        </code>
311                                       
312                                        <div class="description">
313                                            Removes classes from the target, resets some flags and sets the shims deactive position [-999, -999]
314                                        </div>
315
316                                        <div class="description">
317
318
319                                                <dl>
320                                                    <dt>Returns:
321                                                    <code>
322                                                        void
323                                                    </code></dt>
324                                                    <dd></dd>
325                                                </dl>
326
327
328             
329
330                                        </div>
331
332                                    </div>
333                                    <hr />
334                                    </div>
335                                    <div class="private">
336                                    <h4>
337                                        <a name="method__handleOut">_handleOut</a></h4>
338                                    <div class="detail">
339                                        <code>
340                                         private
341                                       
342                                       
343                                        void
344                                            <strong>_handleOut</strong>
345                                           (
346                                            )
347                                        </code>
348                                       
349                                        <div class="description">
350                                            Handles the mouseout DOM event on the Target Shim
351                                        </div>
352
353                                        <div class="description">
354
355
356                                                <dl>
357                                                    <dt>Returns:
358                                                    <code>
359                                                        void
360                                                    </code></dt>
361                                                    <dd></dd>
362                                                </dl>
363
364
365             
366
367                                        </div>
368
369                                    </div>
370                                    <hr />
371                                    </div>
372                                    <div class="private">
373                                    <h4>
374                                        <a name="method__handleOverEvent">_handleOverEvent</a></h4>
375                                    <div class="detail">
376                                        <code>
377                                         private
378                                       
379                                       
380                                        void
381                                            <strong>_handleOverEvent</strong>
382                                           (
383                                            )
384                                        </code>
385                                       
386                                        <div class="description">
387                                            Handles the mouseover DOM event on the Target Shim
388                                        </div>
389
390                                        <div class="description">
391
392
393                                                <dl>
394                                                    <dt>Returns:
395                                                    <code>
396                                                        void
397                                                    </code></dt>
398                                                    <dd></dd>
399                                                </dl>
400
401
402             
403
404                                        </div>
405
406                                    </div>
407                                    <hr />
408                                    </div>
409                                    <div class="private">
410                                    <h4>
411                                        <a name="method__handleOverTarget">_handleOverTarget</a></h4>
412                                    <div class="detail">
413                                        <code>
414                                         private
415                                       
416                                       
417                                        void
418                                            <strong>_handleOverTarget</strong>
419                                           (
420                                            )
421                                        </code>
422                                       
423                                        <div class="description">
424                                            This handles the over target call made from this object or from the DDM
425                                        </div>
426
427                                        <div class="description">
428
429
430                                                <dl>
431                                                    <dt>Returns:
432                                                    <code>
433                                                        void
434                                                    </code></dt>
435                                                    <dd></dd>
436                                                </dl>
437
438
439             
440
441                                        </div>
442
443                                    </div>
444                                    <hr />
445                                    </div>
446                                    <div class="private">
447                                    <h4>
448                                        <a name="method_destructor">destructor</a></h4>
449                                    <div class="detail">
450                                        <code>
451                                         private
452                                       
453                                       
454                                        void
455                                            <strong>destructor</strong>
456                                           (
457                                            )
458                                        </code>
459                                       
460                                        <div class="description">
461                                            Lifecycle destructor, unreg the drag from the DDM and remove listeners
462                                        </div>
463
464                                        <div class="description">
465
466
467                                                <dl>
468                                                    <dt>Returns:
469                                                    <code>
470                                                        void
471                                                    </code></dt>
472                                                    <dd></dd>
473                                                </dl>
474
475
476             
477
478                                        </div>
479
480                                    </div>
481                                    <hr />
482                                    </div>
483                                    <div class="">
484                                    <h4>
485                                        <a name="method_inGroup">inGroup</a></h4>
486                                    <div class="detail">
487                                        <code>
488                                       
489                                       
490                                       
491                                       
492                                            <strong>inGroup</strong>
493                                           (
494                                               
495                                                       
496                                                         groups
497                                                   
498                                               
499                                            )
500                                        </code>
501                                       
502                                        <div class="description">
503                                            Check if this target is in one of the supplied groups.
504                                        </div>
505
506                                        <div class="description">
507
508                                                <dl>
509                                                    <dt>Parameters:</dt>
510                                                        <dd>
511                                                            <code>groups &lt;Array&gt;</code>
512                                                             The groups to check against
513                                                        </dd>
514                                                </dl>
515
516
517
518             
519
520                                        </div>
521
522                                    </div>
523                                    <hr />
524                                    </div>
525                                    <div class="private">
526                                    <h4>
527                                        <a name="method_initializer">initializer</a></h4>
528                                    <div class="detail">
529                                        <code>
530                                         private
531                                       
532                                       
533                                        void
534                                            <strong>initializer</strong>
535                                           (
536                                            )
537                                        </code>
538                                       
539                                        <div class="description">
540                                            Private lifecycle method
541                                        </div>
542
543                                        <div class="description">
544
545
546                                                <dl>
547                                                    <dt>Returns:
548                                                    <code>
549                                                        void
550                                                    </code></dt>
551                                                    <dd></dd>
552                                                </dl>
553
554
555             
556
557                                        </div>
558
559                                    </div>
560                                    <hr />
561                                    </div>
562                                    <div class="">
563                                    <h4>
564                                        <a name="method_sizeShim">sizeShim</a></h4>
565                                    <div class="detail">
566                                        <code>
567                                       
568                                       
569                                       
570                                        void
571                                            <strong>sizeShim</strong>
572                                           (
573                                            )
574                                        </code>
575                                       
576                                        <div class="description">
577                                            Positions and sizes the shim with the raw data from the node, this can be used to programatically adjust the Targets shim for Animation..
578                                        </div>
579
580                                        <div class="description">
581
582
583                                                <dl>
584                                                    <dt>Returns:
585                                                    <code>
586                                                        void
587                                                    </code></dt>
588                                                    <dd></dd>
589                                                </dl>
590
591
592             
593
594                                        </div>
595
596                                    </div>
597                                    <hr />
598                                    </div>
599                            </div>
600                        </div>
601
602                            <div class="section field inheritance">
603                                <h4>Methods inherited from <a href="Attribute.html">Attribute</a>:</h4>
604                                <div class="content">
605                                    <code>
606                                            <a class="private" href="Attribute.html#method__cloneAttVal">_cloneAttVal</a><span class="private">,</span>                                            <a class="private" href="Attribute.html#method__defAttSet">_defAttSet</a><span class="private">,</span>                                            <a class="private" href="Attribute.html#method__fireAttChange">_fireAttChange</a><span class="private">,</span>                                            <a class="private" href="Attribute.html#method__getSubAttVal">_getSubAttVal</a><span class="private">,</span>                                            <a class="protected" href="Attribute.html#method__initAtts">_initAtts</a><span class="protected">,</span>                                            <a class="private" href="Attribute.html#method__initAttVal">_initAttVal</a><span class="private">,</span>                                            <a class="private" href="Attribute.html#method__setSubAttVal">_setSubAttVal</a><span class="private">,</span>                                            <a class="private" href="Attribute.html#method__splitAttrValues">_splitAttrValues</a><span class="private">,</span>                                            <a class="" href="Attribute.html#method_addAtt">addAtt</a><span class="">,</span>                                            <a class="" href="Attribute.html#method_get">get</a><span class="">,</span>                                            <a class="" href="Attribute.html#method_getAtts">getAtts</a><span class="">,</span>                                            <a class="" href="Attribute.html#method_on">on</a><span class="">,</span>                                            <a class="" href="Attribute.html#method_removeAtt">removeAtt</a><span class="">,</span>                                            <a class="" href="Attribute.html#method_set">set</a><span class="">,</span>                                            <a class="" href="Attribute.html#method_setAtts">setAtts</a>
607                                    </code>
608                                </div>
609                            </div>
610                            <div class="section field inheritance">
611                                <h4>Methods inherited from <a href="Base.html">Base</a>:</h4>
612                                <div class="content">
613                                    <code>
614                                            <a class="protected" href="Base.html#method__defDestroyFn">_defDestroyFn</a><span class="protected">,</span>                                            <a class="protected" href="Base.html#method__defInitFn">_defInitFn</a><span class="protected">,</span>                                            <a class="private" href="Base.html#method__destroyHierarchy">_destroyHierarchy</a><span class="private">,</span>                                            <a class="protected" href="Base.html#method__getClasses">_getClasses</a><span class="protected">,</span>                                            <a class="private" href="Base.html#method__initHierarchy">_initHierarchy</a><span class="private">,</span>                                            <a class="private" href="Base.html#method__prefixEvtType">_prefixEvtType</a><span class="private">,</span>                                            <a class="" href="Base.html#method_after">after</a><span class="">,</span>                                            <a class="" href="Base.html#method_destroy">destroy</a><span class="">,</span>                                            <a class="" href="Base.html#method_fire">fire</a><span class="">,</span>                                            <a class="" href="Base.html#method_init">init</a><span class="">,</span>                                            <a class="" href="Base.html#method_publish">publish</a><span class="">,</span>                                            <a class="" href="Base.html#method_subscribe">subscribe</a><span class="">,</span>                                            <a class="" href="Base.html#method_toString">toString</a><span class="">,</span>                                            <a class="" href="Base.html#method_unsubscribe">unsubscribe</a><span class="">,</span>                                            <a class="" href="Base.html#method_unsubscribeAll">unsubscribeAll</a>
615                                    </code>
616                                </div>
617                            </div>
618                            <div class="section field inheritance">
619                                <h4>Methods inherited from <a href="Event.Target.html">Event.Target</a>:</h4>
620                                <div class="content">
621                                    <code>
622                                            <a class="" href="Event.Target.html#method_addTarget">addTarget</a><span class="">,</span>                                            <a class="" href="Event.Target.html#method_after">after</a><span class="">,</span>                                            <a class="" href="Event.Target.html#method_bubble">bubble</a><span class="">,</span>                                            <a class="" href="Event.Target.html#method_fire">fire</a><span class="">,</span>                                            <a class="" href="Event.Target.html#method_getEvent">getEvent</a><span class="">,</span>                                            <a class="" href="Event.Target.html#method_publish">publish</a><span class="">,</span>                                            <a class="" href="Event.Target.html#method_ready">ready</a><span class="">,</span>                                            <a class="" href="Event.Target.html#method_removeTarget">removeTarget</a><span class="">,</span>                                            <a class="" href="Event.Target.html#method_subscribe">subscribe</a><span class="">,</span>                                            <a class="" href="Event.Target.html#method_unsubscribe">unsubscribe</a><span class="">,</span>                                            <a class="" href="Event.Target.html#method_unsubscribeAll">unsubscribeAll</a>
623                                    </code>
624                                </div>
625                            </div>
626
627                        <div class="section method details">
628                            <h3 id="events">Events</h3>
629                            <div class="content">
630                                    <div class="">
631                                    <h4>
632                                        <a name="event_drop:enter">drop:enter</a></h4>
633                                    <div class="detail">
634                                        <code>
635                                       
636                                       
637                                       
638                                            <strong>drop:enter</strong>
639
640                                            (
641                                            )
642
643                                        </code>
644                                       
645                                        <div class="description">
646                                            Fires when a drag element enters this target.
647                                        </div>
648
649                                        <div class="description">
650
651
652
653                                            <div class="bubbles">
654                                                <strong>Bubbles:</strong> This event bubbles to <a href="DDM.html">DDM</a>.
655                                            </div>       
656
657                                        </div>
658
659                                    </div>
660                                    <hr />
661                                    </div>
662                                    <div class="">
663                                    <h4>
664                                        <a name="event_drop:exit">drop:exit</a></h4>
665                                    <div class="detail">
666                                        <code>
667                                       
668                                       
669                                       
670                                            <strong>drop:exit</strong>
671
672                                            (
673                                            )
674
675                                        </code>
676                                       
677                                        <div class="description">
678                                            Fires when a drag element exits this target.
679                                        </div>
680
681                                        <div class="description">
682
683
684
685                                            <div class="bubbles">
686                                                <strong>Bubbles:</strong> This event bubbles to <a href="DDM.html">DDM</a>.
687                                            </div>       
688
689                                        </div>
690
691                                    </div>
692                                    <hr />
693                                    </div>
694                                    <div class="">
695                                    <h4>
696                                        <a name="event_drop:hit">drop:hit</a></h4>
697                                    <div class="detail">
698                                        <code>
699                                       
700                                       
701                                       
702                                            <strong>drop:hit</strong>
703
704                                            (
705                                            )
706
707                                        </code>
708                                       
709                                        <div class="description">
710                                            Fires when a draggable node is dropped on this Drop Target. (Fired from dd-ddm-drop)
711                                        </div>
712
713                                        <div class="description">
714
715
716
717                                            <div class="bubbles">
718                                                <strong>Bubbles:</strong> This event bubbles to <a href="DDM.html">DDM</a>.
719                                            </div>       
720
721                                        </div>
722
723                                    </div>
724                                    <hr />
725                                    </div>
726                                    <div class="">
727                                    <h4>
728                                        <a name="event_drop:over">drop:over</a></h4>
729                                    <div class="detail">
730                                        <code>
731                                       
732                                       
733                                       
734                                            <strong>drop:over</strong>
735
736                                            (
737                                            )
738
739                                        </code>
740                                       
741                                        <div class="description">
742                                            Fires when a drag element is over this target.
743                                        </div>
744
745                                        <div class="description">
746
747
748
749                                            <div class="bubbles">
750                                                <strong>Bubbles:</strong> This event bubbles to <a href="DDM.html">DDM</a>.
751                                            </div>       
752
753                                        </div>
754
755                                    </div>
756                                    <hr />
757                                    </div>
758                                    <div class="">
759                                    <h4>
760                                        <a name="event_groupsChange">groupsChange</a></h4>
761                                    <div class="detail">
762                                        <code>
763                                       
764                                       
765                                       
766                                            <strong>groupsChange</strong>
767
768                                            (
769                                               
770                                                       
771                                                         event
772                                                   
773                                               
774                                            )
775
776                                        </code>
777                                       
778                                        <div class="description">
779                                            Fires when the value for the configuration attribute 'groups' is changed. You can listen for the event using the <a href="Attribute.html#method_on>on</a> method if you wish to be notified before the attribute's value has changed, or using the <a href="Event.Target.html#method_after>after</a> method if you wish to be notified after the attribute's value has changed.
780                                        </div>
781
782                                        <div class="description">
783
784
785                                                <dl>
786                                                    <dt>Parameters:</dt>
787                                                        <dd>
788                                                            <code>event &lt;Event.Facade&gt;</code>
789                                                            An Event Facade object with      the following attribute specific properties added: <dl>            <dt>prevVal</dt>                <dd>The value of the attribute, prior to it being set</dd>              <dt>newVal</dt>         <dd>The value the attribute is to be set to</dd>                <dt>attrName</dt>               <dd>The name of the attribute being set</dd>            <dt>subAttrName</dt>            <dd>If setting a property within the attribute's value,           the name of the sub-attribute property being set</dd> </dl>
790                                                        </dd>
791                                                </dl>
792
793
794                                        </div>
795
796                                    </div>
797                                    <hr />
798                                    </div>
799                                    <div class="">
800                                    <h4>
801                                        <a name="event_lockChange">lockChange</a></h4>
802                                    <div class="detail">
803                                        <code>
804                                       
805                                       
806                                       
807                                            <strong>lockChange</strong>
808
809                                            (
810                                               
811                                                       
812                                                         event
813                                                   
814                                               
815                                            )
816
817                                        </code>
818                                       
819                                        <div class="description">
820                                            Fires when the value for the configuration attribute 'lock' is changed. You can listen for the event using the <a href="Attribute.html#method_on>on</a> method if you wish to be notified before the attribute's value has changed, or using the <a href="Event.Target.html#method_after>after</a> method if you wish to be notified after the attribute's value has changed.
821                                        </div>
822
823                                        <div class="description">
824
825
826                                                <dl>
827                                                    <dt>Parameters:</dt>
828                                                        <dd>
829                                                            <code>event &lt;Event.Facade&gt;</code>
830                                                            An Event Facade object with      the following attribute specific properties added: <dl>            <dt>prevVal</dt>                <dd>The value of the attribute, prior to it being set</dd>              <dt>newVal</dt>         <dd>The value the attribute is to be set to</dd>                <dt>attrName</dt>               <dd>The name of the attribute being set</dd>            <dt>subAttrName</dt>            <dd>If setting a property within the attribute's value,           the name of the sub-attribute property being set</dd> </dl>
831                                                        </dd>
832                                                </dl>
833
834
835                                        </div>
836
837                                    </div>
838                                    <hr />
839                                    </div>
840                                    <div class="">
841                                    <h4>
842                                        <a name="event_nodeChange">nodeChange</a></h4>
843                                    <div class="detail">
844                                        <code>
845                                       
846                                       
847                                       
848                                            <strong>nodeChange</strong>
849
850                                            (
851                                               
852                                                       
853                                                         event
854                                                   
855                                               
856                                            )
857
858                                        </code>
859                                       
860                                        <div class="description">
861                                            Fires when the value for the configuration attribute 'node' is changed. You can listen for the event using the <a href="Attribute.html#method_on>on</a> method if you wish to be notified before the attribute's value has changed, or using the <a href="Event.Target.html#method_after>after</a> method if you wish to be notified after the attribute's value has changed.
862                                        </div>
863
864                                        <div class="description">
865
866
867                                                <dl>
868                                                    <dt>Parameters:</dt>
869                                                        <dd>
870                                                            <code>event &lt;Event.Facade&gt;</code>
871                                                            An Event Facade object with      the following attribute specific properties added: <dl>            <dt>prevVal</dt>                <dd>The value of the attribute, prior to it being set</dd>              <dt>newVal</dt>         <dd>The value the attribute is to be set to</dd>                <dt>attrName</dt>               <dd>The name of the attribute being set</dd>            <dt>subAttrName</dt>            <dd>If setting a property within the attribute's value,           the name of the sub-attribute property being set</dd> </dl>
872                                                        </dd>
873                                                </dl>
874
875
876                                        </div>
877
878                                    </div>
879                                    <hr />
880                                    </div>
881                                    <div class="">
882                                    <h4>
883                                        <a name="event_paddingChange">paddingChange</a></h4>
884                                    <div class="detail">
885                                        <code>
886                                       
887                                       
888                                       
889                                            <strong>paddingChange</strong>
890
891                                            (
892                                               
893                                                       
894                                                         event
895                                                   
896                                               
897                                            )
898
899                                        </code>
900                                       
901                                        <div class="description">
902                                            Fires when the value for the configuration attribute 'padding' is changed. You can listen for the event using the <a href="Attribute.html#method_on>on</a> method if you wish to be notified before the attribute's value has changed, or using the <a href="Event.Target.html#method_after>after</a> method if you wish to be notified after the attribute's value has changed.
903                                        </div>
904
905                                        <div class="description">
906
907
908                                                <dl>
909                                                    <dt>Parameters:</dt>
910                                                        <dd>
911                                                            <code>event &lt;Event.Facade&gt;</code>
912                                                            An Event Facade object with      the following attribute specific properties added: <dl>            <dt>prevVal</dt>                <dd>The value of the attribute, prior to it being set</dd>              <dt>newVal</dt>         <dd>The value the attribute is to be set to</dd>                <dt>attrName</dt>               <dd>The name of the attribute being set</dd>            <dt>subAttrName</dt>            <dd>If setting a property within the attribute's value,           the name of the sub-attribute property being set</dd> </dl>
913                                                        </dd>
914                                                </dl>
915
916
917                                        </div>
918
919                                    </div>
920                                    <hr />
921                                    </div>
922                            </div>
923                        </div>
924
925
926                        <div class="section field inheritance">
927                            <h4>Events inherited from <a href="Base.html">Base</a>:</h4>
928                            <div class="content">
929                                <code>
930                                        <a class="" href="Base.html#event_destroy">destroy</a><span class="">,</span>                                        <a class="" href="Base.html#event_destroyedChange">destroyedChange</a><span class="">,</span>                                        <a class="" href="Base.html#event_init">init</a><span class="">,</span>                                        <a class="" href="Base.html#event_initializedChange">initializedChange</a><span class="">,</span>
931                                </code>
932                            </div>
933                        </div>
934
935                        <div class="section field details">
936                            <h3 id="configattributes">Configuration Attributes</h3>
937                            <div class="content">
938                                    <div class="">
939                                    <h4><a name="config_groups">groups</a>
940                                        <code>- Array</code>
941                                    </h4>
942                                    <div class="detail">
943                                        <div class="description">
944                                            Array of groups to add this drop into.
945                                        </div>
946                                    </div>
947 
948     
949
950                                    <hr />
951                                    </div>       
952                                    <div class="">
953                                    <h4><a name="config_lock">lock</a>
954                                        <code>- Boolean</code>
955                                    </h4>
956                                    <div class="detail">
957                                        <div class="description">
958                                            Set to lock this drop element.
959                                        </div>
960                                    </div>
961 
962     
963
964                                    <hr />
965                                    </div>       
966                                    <div class="">
967                                    <h4><a name="config_node">node</a>
968                                        <code>- Node</code>
969                                    </h4>
970                                    <div class="detail">
971                                        <div class="description">
972                                            Y.Node instanace to use as the element to make a Drop Target
973                                        </div>
974                                    </div>
975 
976     
977
978                                    <hr />
979                                    </div>       
980                                    <div class="">
981                                    <h4><a name="config_padding">padding</a>
982                                        <code>- String</code>
983                                    </h4>
984                                    <div class="detail">
985                                        <div class="description">
986                                            CSS style padding to make the Drop Target bigger than the node.
987                                        </div>
988                                    </div>
989 
990     
991
992                                    <hr />
993                                    </div>       
994
995                            </div>
996                        </div>
997
998                        <div class="section field inheritance">
999                            <h4>Configuration attributes inherited from <a href="Base.html">Base</a>:</h4>
1000                            <div class="content">
1001                                <code>
1002                                        <a class="" href="Base.html#config_destroyed">destroyed</a><span class="">,</span>                                        <a class="" href="Base.html#config_initialized">initialized</a><span class="">,</span>
1003                                </code>
1004                            </div>
1005                        </div>
1006
1007                        </div>
1008                </div>
1009                <div class="yui-b">
1010            <div class="nav">
1011
1012                    <div class="module">
1013                        <h4>Modules</h4>
1014                        <ul class="content">
1015
1016                                <li class=""><a href="module_anim.html">anim</a></li>
1017
1018                                <li class=""><a href="module_attribute.html">attribute</a></li>
1019
1020                                <li class=""><a href="module_base.html">base</a></li>
1021
1022                                <li class=""><a href="module_cookie.html">cookie</a></li>
1023
1024                                <li class="selected"><a href="module_dd.html">dd</a></li>
1025
1026                                <li class=""><a href="module_dd-plugin.html">dd-plugin</a></li>
1027
1028                                <li class=""><a href="module_dom.html">dom</a></li>
1029
1030                                <li class=""><a href="module_dump.html">dump</a></li>
1031
1032                                <li class=""><a href="module_event.html">event</a></li>
1033
1034                                <li class=""><a href="module_io.html">io</a></li>
1035
1036                                <li class=""><a href="module_json.html">json</a></li>
1037
1038                                <li class=""><a href="module_node.html">node</a></li>
1039
1040                                <li class=""><a href="module_oop.html">oop</a></li>
1041
1042                                <li class=""><a href="module_queue.html">queue</a></li>
1043
1044                                <li class=""><a href="module_substitute.html">substitute</a></li>
1045
1046                                <li class=""><a href="module_yui.html">yui</a></li>
1047                        </ul>
1048                    </div>
1049
1050                    <div class="module">
1051                        <h4>Classes</h4>
1052                        <ul class="content">
1053                                <li class=""><a href="DDM.html">DDM</a></li>
1054                                <li class=""><a href="Drag.html">Drag</a></li>
1055                                <li class=""><a href="DragConstained.html">DragConstained</a></li>
1056                                <li class="selected"><a href="Drop.html">Drop</a></li>
1057                                <li class=""><a href="Proxy.html">Proxy</a></li>
1058                        </ul>
1059                    </div>
1060
1061                    <div class="module">
1062                        <h4>Files</h4>
1063                        <ul class="content">       
1064                                <li class=""><a href="constrain.js.html">constrain.js</a></li>
1065                                <li class=""><a href="ddm-base.js.html">ddm-base.js</a></li>
1066                                <li class=""><a href="ddm-drop.js.html">ddm-drop.js</a></li>
1067                                <li class=""><a href="ddm.js.html">ddm.js</a></li>
1068                                <li class=""><a href="drag.js.html">drag.js</a></li>
1069                                <li class=""><a href="drop.js.html">drop.js</a></li>
1070                                <li class=""><a href="proxy.js.html">proxy.js</a></li>
1071                        </ul>
1072                    </div>
1073
1074                    <div class="module">
1075                        <h4>Properties</h4>
1076                        <ul class="content">       
1077                                <li class="private"><a href="#property__groups">_groups</a>
1078                                        <!--<code>&lt;{Object}&gt;</code>-->
1079                                </li>
1080                                <li class="private"><a href="#property__valid">_valid</a>
1081                                        <!--<code>&lt;{Object}&gt;</code>-->
1082                                </li>
1083                                <li class=""><a href="#property_overTarget">overTarget</a>
1084                                        <!--<code>&lt;{Object}&gt;</code>-->
1085                                </li>
1086                                <li class=""><a href="#property_region">region</a>
1087                                        <!--<code>&lt;{Object}&gt;</code>-->
1088                                </li>
1089                                <li class=""><a href="#property_shim">shim</a>
1090                                        <!--<code>&lt;{Object}&gt;</code>-->
1091                                </li>
1092                        </ul>
1093                    </div>
1094
1095                    <div class="module">
1096                        <h4>Methods</h4>
1097                        <ul class="content">       
1098                                <li class="private"><!--<code>void</code>-->
1099                                <a href="#method__activateShim">_activateShim</a>
1100                                </li>
1101                                <li class="private"><!--<code>void</code>-->
1102                                <a href="#method__createEvents">_createEvents</a>
1103                                </li>
1104                                <li class="private"><!--<code>void</code>-->
1105                                <a href="#method__createShim">_createShim</a>
1106                                </li>
1107                                <li class="private"><!--<code>void</code>-->
1108                                <a href="#method__deactivateShim">_deactivateShim</a>
1109                                </li>
1110                                <li class="private"><!--<code>void</code>-->
1111                                <a href="#method__handleOut">_handleOut</a>
1112                                </li>
1113                                <li class="private"><!--<code>void</code>-->
1114                                <a href="#method__handleOverEvent">_handleOverEvent</a>
1115                                </li>
1116                                <li class="private"><!--<code>void</code>-->
1117                                <a href="#method__handleOverTarget">_handleOverTarget</a>
1118                                </li>
1119                                <li class="private"><!--<code>void</code>-->
1120                                <a href="#method_destructor">destructor</a>
1121                                </li>
1122                                <li class=""><!--<code></code>-->
1123                                <a href="#method_inGroup">inGroup</a>
1124                                </li>
1125                                <li class="private"><!--<code>void</code>-->
1126                                <a href="#method_initializer">initializer</a>
1127                                </li>
1128                                <li class=""><!--<code>void</code>-->
1129                                <a href="#method_sizeShim">sizeShim</a>
1130                                </li>
1131                        </ul>
1132                    </div>
1133
1134                    <div class="module">
1135                        <h4>Events</h4>
1136                        <ul class="content">       
1137                                <li class="">
1138                                <a href="#event_drop:enter">drop:enter</a>
1139                                </li>
1140                                <li class="">
1141                                <a href="#event_drop:exit">drop:exit</a>
1142                                </li>
1143                                <li class="">
1144                                <a href="#event_drop:hit">drop:hit</a>
1145                                </li>
1146                                <li class="">
1147                                <a href="#event_drop:over">drop:over</a>
1148                                </li>
1149                                <li class="">
1150                                <a href="#event_groupsChange">groupsChange</a>
1151                                </li>
1152                                <li class="">
1153                                <a href="#event_lockChange">lockChange</a>
1154                                </li>
1155                                <li class="">
1156                                <a href="#event_nodeChange">nodeChange</a>
1157                                </li>
1158                                <li class="">
1159                                <a href="#event_paddingChange">paddingChange</a>
1160                                </li>
1161                        </ul>
1162                    </div>
1163
1164                    <div class="module">
1165                        <h4>Configuration Attributes</h4>
1166                        <ul class="content">       
1167                                <li class="">
1168                                <a href="#config_groups">groups</a>
1169                                </li>
1170                                <li class="">
1171                                <a href="#config_lock">lock</a>
1172                                </li>
1173                                <li class="">
1174                                <a href="#config_node">node</a>
1175                                </li>
1176                                <li class="">
1177                                <a href="#config_padding">padding</a>
1178                                </li>
1179                        </ul>
1180                    </div>
1181
1182            </div>
1183                </div>
1184        </div>
1185        <div id="ft">
1186        <hr />
1187        Copyright &copy; 2008 Yahoo! Inc. All rights reserved.
1188        </div>
1189</div>
1190</body>
1191</html>
Note: See TracBrowser for help on using the repository browser.