annotate jquery-ui/development-bundle/docs/droppable.html @ 25:1456ddf7583e

getAllProjectsAndTags changed
author dwinter
date Thu, 01 Mar 2012 08:44:16 +0100
parents b2e4605f20b2
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
1
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
2 <ul class="UIAPIPlugin-toc">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
3 <li><a href="#overview">Overview</a></li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
4 <li><a href="#options">Options</a></li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
5 <li><a href="#events">Events</a></li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
6 <li><a href="#methods">Methods</a></li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
7 <li><a href="#theming">Theming</a></li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
8 </ul>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
9 <div class="UIAPIPlugin">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
10 <h1>jQuery UI Droppable</h1>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
11 <div id="overview">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
12 <h2 class="top-header">Overview</h2>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
13 <div id="overview-main">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
14 <p>The jQuery UI Droppable plugin makes selected elements droppable (meaning they accept being dropped on by draggables). You can specify which (individually) or which kind of draggables each will accept.</p>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
15 <p>All callbacks receive two arguments: The original browser event and a prepared ui object, view below for a documentation of this object (if you name your second argument 'ui'):</p>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
16 <ul>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
17 <li> <b>ui.draggable</b> - current draggable element, a jQuery object.</li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
18 <li> <b>ui.helper</b> - current draggable helper, a jQuery object</li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
19 <li> <b>ui.position</b> - current position of the draggable helper { top: , left: }</li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
20 <li> <b>ui.offset</b> - current absolute position of the draggable helper { top: , left: }</li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
21 </ul>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
22 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
23 <div id="overview-dependencies">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
24 <h3>Dependencies</h3>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
25 <ul>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
26 <li>UI Core</li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
27 <li>UI Widget</li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
28 <li>UI Mouse</li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
29 <li><a href="http://docs.jquery.com/UI/Draggable" title="UI/Draggable">UI Draggable</a></li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
30 </ul>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
31 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
32 <div id="overview-example">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
33 <h3>Example</h3>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
34 <div id="overview-example" class="example">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
35 <ul><li><a href="#demo"><span>Demo</span></a></li><li><a href="#source"><span>View Source</span></a></li></ul>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
36 <p><div id="demo" class="tabs-container" rel="100">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
37 Makes the div droppable (a drop target for a draggable).<br />
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
38 </p>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
39 <pre>$(&quot;#draggable&quot;).draggable();
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
40 $(&quot;#droppable&quot;).droppable({
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
41 drop: function() { alert('dropped'); }
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
42 });
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
43 </pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
44 <p></div><div id="source" class="tabs-container">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
45 </p>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
46 <pre>&lt;!DOCTYPE html&gt;
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
47 &lt;html&gt;
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
48 &lt;head&gt;
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
49 &lt;link href=&quot;http://ajax.googleapis.com/ajax/libs/jqueryui/1.8/themes/base/jquery-ui.css&quot; rel=&quot;stylesheet&quot; type=&quot;text/css&quot;/&gt;
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
50 &lt;script src=&quot;http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js&quot;&gt;&lt;/script&gt;
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
51 &lt;script src=&quot;http://ajax.googleapis.com/ajax/libs/jqueryui/1.8/jquery-ui.min.js&quot;&gt;&lt;/script&gt;
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
52 &lt;style type=&quot;text/css&quot;&gt;
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
53 #draggable { width: 75px; height: 25px; background: silver; padding: 10px; }
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
54 #droppable { position: absolute; left: 250px; top: 0; width: 125px; height: 75px; background: gray; color: white; padding: 10px; }
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
55 &lt;/style&gt;
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
56 &lt;script&gt;
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
57 $(document).ready(function() {
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
58 $(&quot;#draggable&quot;).draggable();
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
59 $(&quot;#droppable&quot;).droppable({
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
60 drop: function() { alert('dropped'); }
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
61 });
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
62 });
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
63 &lt;/script&gt;
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
64 &lt;/head&gt;
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
65 &lt;body style="font-size:62.5%;"&gt;
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
66
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
67 &lt;div id=&quot;droppable&quot;&gt;Drop here&lt;/div&gt;
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
68 &lt;div id=&quot;draggable&quot;&gt;Drag me&lt;/div&gt;
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
69
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
70 &lt;/body&gt;
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
71 &lt;/html&gt;
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
72 </pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
73 <p></div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
74 </p><p></div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
75 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
76 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
77 <div id="options">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
78 <h2 class="top-header">Options</h2>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
79 <ul class="options-list">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
80
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
81 <li class="option" id="option-disabled">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
82 <div class="option-header">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
83 <h3 class="option-name"><a href="#option-disabled">disabled</a></h3>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
84 <dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
85 <dt class="option-type-label">Type:</dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
86 <dd class="option-type">Boolean</dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
87
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
88 <dt class="option-default-label">Default:</dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
89 <dd class="option-default">false</dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
90
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
91 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
92 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
93 <div class="option-description">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
94 <p>Disables (true) or enables (false) the droppable. Can be set when initialising (first creating) the droppable.</p>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
95 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
96 <div class="option-examples">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
97 <h4>Code examples</h4>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
98 <dl class="option-examples-list">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
99
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
100 <dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
101 Initialize a droppable with the <code>disabled</code> option specified.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
102 </dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
103 <dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
104 <pre><code>$( ".selector" ).droppable({ disabled: true });</code></pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
105 </dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
106
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
107
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
108 <dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
109 Get or set the <code>disabled</code> option, after init.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
110 </dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
111 <dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
112 <pre><code>//getter
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
113 var disabled = $( ".selector" ).droppable( "option", "disabled" );
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
114 //setter
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
115 $( ".selector" ).droppable( "option", "disabled", true );</code></pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
116 </dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
117
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
118 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
119 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
120 </li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
121
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
122
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
123 <li class="option" id="option-accept">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
124 <div class="option-header">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
125 <h3 class="option-name"><a href="#option-accept">accept</a></h3>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
126 <dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
127 <dt class="option-type-label">Type:</dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
128 <dd class="option-type">Selector, Function</dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
129
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
130 <dt class="option-default-label">Default:</dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
131 <dd class="option-default">'*'</dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
132
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
133 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
134 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
135 <div class="option-description">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
136 <p>All draggables that match the selector will be accepted. If a function is specified, the function will be called for each draggable on the page (passed as the first argument to the function), to provide a custom filter. The function should return true if the draggable should be accepted.</p>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
137 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
138 <div class="option-examples">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
139 <h4>Code examples</h4>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
140 <dl class="option-examples-list">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
141
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
142 <dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
143 Initialize a droppable with the <code>accept</code> option specified.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
144 </dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
145 <dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
146 <pre><code>$( ".selector" ).droppable({ accept: '.special' });</code></pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
147 </dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
148
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
149
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
150 <dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
151 Get or set the <code>accept</code> option, after init.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
152 </dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
153 <dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
154 <pre><code>//getter
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
155 var accept = $( ".selector" ).droppable( "option", "accept" );
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
156 //setter
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
157 $( ".selector" ).droppable( "option", "accept", '.special' );</code></pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
158 </dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
159
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
160 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
161 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
162 </li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
163
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
164
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
165 <li class="option" id="option-activeClass">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
166 <div class="option-header">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
167 <h3 class="option-name"><a href="#option-activeClass">activeClass</a></h3>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
168 <dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
169 <dt class="option-type-label">Type:</dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
170 <dd class="option-type">String</dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
171
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
172 <dt class="option-default-label">Default:</dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
173 <dd class="option-default">false</dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
174
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
175 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
176 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
177 <div class="option-description">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
178 <p>If specified, the class will be added to the droppable while an acceptable draggable is being dragged.</p>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
179 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
180 <div class="option-examples">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
181 <h4>Code examples</h4>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
182 <dl class="option-examples-list">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
183
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
184 <dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
185 Initialize a droppable with the <code>activeClass</code> option specified.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
186 </dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
187 <dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
188 <pre><code>$( ".selector" ).droppable({ activeClass: 'ui-state-highlight' });</code></pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
189 </dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
190
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
191
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
192 <dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
193 Get or set the <code>activeClass</code> option, after init.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
194 </dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
195 <dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
196 <pre><code>//getter
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
197 var activeClass = $( ".selector" ).droppable( "option", "activeClass" );
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
198 //setter
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
199 $( ".selector" ).droppable( "option", "activeClass", 'ui-state-highlight' );</code></pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
200 </dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
201
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
202 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
203 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
204 </li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
205
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
206
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
207 <li class="option" id="option-addClasses">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
208 <div class="option-header">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
209 <h3 class="option-name"><a href="#option-addClasses">addClasses</a></h3>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
210 <dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
211 <dt class="option-type-label">Type:</dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
212 <dd class="option-type">Boolean</dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
213
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
214 <dt class="option-default-label">Default:</dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
215 <dd class="option-default">true</dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
216
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
217 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
218 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
219 <div class="option-description">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
220 <p>If set to false, will prevent the ui-droppable class from being added. This may be desired as a performance optimization when calling .droppable() init on many hundreds of elements.</p>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
221 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
222 <div class="option-examples">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
223 <h4>Code examples</h4>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
224 <dl class="option-examples-list">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
225
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
226 <dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
227 Initialize a droppable with the <code>addClasses</code> option specified.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
228 </dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
229 <dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
230 <pre><code>$( ".selector" ).droppable({ addClasses: false });</code></pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
231 </dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
232
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
233
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
234 <dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
235 Get or set the <code>addClasses</code> option, after init.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
236 </dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
237 <dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
238 <pre><code>//getter
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
239 var addClasses = $( ".selector" ).droppable( "option", "addClasses" );
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
240 //setter
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
241 $( ".selector" ).droppable( "option", "addClasses", false );</code></pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
242 </dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
243
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
244 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
245 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
246 </li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
247
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
248
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
249 <li class="option" id="option-greedy">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
250 <div class="option-header">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
251 <h3 class="option-name"><a href="#option-greedy">greedy</a></h3>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
252 <dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
253 <dt class="option-type-label">Type:</dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
254 <dd class="option-type">Boolean</dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
255
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
256 <dt class="option-default-label">Default:</dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
257 <dd class="option-default">false</dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
258
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
259 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
260 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
261 <div class="option-description">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
262 <p>If true, will prevent event propagation on nested droppables.</p>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
263 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
264 <div class="option-examples">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
265 <h4>Code examples</h4>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
266 <dl class="option-examples-list">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
267
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
268 <dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
269 Initialize a droppable with the <code>greedy</code> option specified.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
270 </dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
271 <dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
272 <pre><code>$( ".selector" ).droppable({ greedy: true });</code></pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
273 </dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
274
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
275
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
276 <dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
277 Get or set the <code>greedy</code> option, after init.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
278 </dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
279 <dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
280 <pre><code>//getter
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
281 var greedy = $( ".selector" ).droppable( "option", "greedy" );
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
282 //setter
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
283 $( ".selector" ).droppable( "option", "greedy", true );</code></pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
284 </dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
285
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
286 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
287 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
288 </li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
289
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
290
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
291 <li class="option" id="option-hoverClass">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
292 <div class="option-header">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
293 <h3 class="option-name"><a href="#option-hoverClass">hoverClass</a></h3>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
294 <dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
295 <dt class="option-type-label">Type:</dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
296 <dd class="option-type">String</dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
297
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
298 <dt class="option-default-label">Default:</dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
299 <dd class="option-default">false</dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
300
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
301 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
302 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
303 <div class="option-description">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
304 <p>If specified, the class will be added to the droppable while an acceptable draggable is being hovered.</p>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
305 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
306 <div class="option-examples">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
307 <h4>Code examples</h4>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
308 <dl class="option-examples-list">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
309
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
310 <dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
311 Initialize a droppable with the <code>hoverClass</code> option specified.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
312 </dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
313 <dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
314 <pre><code>$( ".selector" ).droppable({ hoverClass: 'drophover' });</code></pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
315 </dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
316
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
317
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
318 <dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
319 Get or set the <code>hoverClass</code> option, after init.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
320 </dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
321 <dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
322 <pre><code>//getter
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
323 var hoverClass = $( ".selector" ).droppable( "option", "hoverClass" );
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
324 //setter
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
325 $( ".selector" ).droppable( "option", "hoverClass", 'drophover' );</code></pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
326 </dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
327
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
328 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
329 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
330 </li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
331
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
332
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
333 <li class="option" id="option-scope">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
334 <div class="option-header">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
335 <h3 class="option-name"><a href="#option-scope">scope</a></h3>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
336 <dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
337 <dt class="option-type-label">Type:</dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
338 <dd class="option-type">String</dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
339
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
340 <dt class="option-default-label">Default:</dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
341 <dd class="option-default">'default'</dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
342
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
343 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
344 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
345 <div class="option-description">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
346 <p>Used to group sets of draggable and droppable items, in addition to droppable's accept option. A draggable with the same scope value as a droppable will be accepted.</p>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
347 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
348 <div class="option-examples">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
349 <h4>Code examples</h4>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
350 <dl class="option-examples-list">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
351
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
352 <dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
353 Initialize a droppable with the <code>scope</code> option specified.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
354 </dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
355 <dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
356 <pre><code>$( ".selector" ).droppable({ scope: 'tasks' });</code></pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
357 </dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
358
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
359
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
360 <dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
361 Get or set the <code>scope</code> option, after init.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
362 </dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
363 <dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
364 <pre><code>//getter
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
365 var scope = $( ".selector" ).droppable( "option", "scope" );
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
366 //setter
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
367 $( ".selector" ).droppable( "option", "scope", 'tasks' );</code></pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
368 </dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
369
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
370 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
371 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
372 </li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
373
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
374
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
375 <li class="option" id="option-tolerance">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
376 <div class="option-header">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
377 <h3 class="option-name"><a href="#option-tolerance">tolerance</a></h3>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
378 <dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
379 <dt class="option-type-label">Type:</dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
380 <dd class="option-type">String</dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
381
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
382 <dt class="option-default-label">Default:</dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
383 <dd class="option-default">'intersect'</dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
384
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
385 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
386 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
387 <div class="option-description">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
388 <p>Specifies which mode to use for testing whether a draggable is 'over' a droppable. Possible values: 'fit', 'intersect', 'pointer', 'touch'.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
389 </p>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
390 <ul>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
391 <li><b>fit</b>: draggable overlaps the droppable entirely</li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
392 <li><b>intersect</b>: draggable overlaps the droppable at least 50%</li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
393 <li><b>pointer</b>: mouse pointer overlaps the droppable</li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
394 <li><b>touch</b>: draggable overlaps the droppable any amount</li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
395 </ul>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
396 <p></p>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
397 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
398 <div class="option-examples">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
399 <h4>Code examples</h4>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
400 <dl class="option-examples-list">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
401
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
402 <dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
403 Initialize a droppable with the <code>tolerance</code> option specified.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
404 </dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
405 <dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
406 <pre><code>$( ".selector" ).droppable({ tolerance: 'fit' });</code></pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
407 </dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
408
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
409
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
410 <dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
411 Get or set the <code>tolerance</code> option, after init.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
412 </dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
413 <dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
414 <pre><code>//getter
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
415 var tolerance = $( ".selector" ).droppable( "option", "tolerance" );
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
416 //setter
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
417 $( ".selector" ).droppable( "option", "tolerance", 'fit' );</code></pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
418 </dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
419
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
420 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
421 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
422 </li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
423
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
424 </ul>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
425 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
426 <div id="events">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
427 <h2 class="top-header">Events</h2>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
428 <ul class="events-list">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
429
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
430 <li class="event" id="event-create">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
431 <div class="event-header">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
432 <h3 class="event-name"><a href="#event-create">create</a></h3>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
433 <dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
434 <dt class="event-type-label">Type:</dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
435 <dd class="event-type">dropcreate</dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
436 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
437 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
438 <div class="event-description">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
439 <p>This event is triggered when droppable is created.</p>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
440 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
441 <div class="event-examples">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
442 <h4>Code examples</h4>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
443 <dl class="event-examples-list">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
444
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
445 <dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
446 Supply a callback function to handle the <code>create</code> event as an init option.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
447 </dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
448 <dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
449 <pre><code>$( &quot;.selector&quot; ).droppable({
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
450 create: function(event, ui) { ... }
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
451 });</code></pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
452 </dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
453
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
454
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
455 <dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
456 Bind to the <code>create</code> event by type: <code>dropcreate</code>.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
457 </dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
458 <dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
459 <pre><code>$( &quot;.selector&quot; ).bind( &quot;dropcreate&quot;, function(event, ui) {
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
460 ...
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
461 });</code></pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
462 </dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
463
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
464 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
465 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
466 </li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
467
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
468
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
469 <li class="event" id="event-activate">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
470 <div class="event-header">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
471 <h3 class="event-name"><a href="#event-activate">activate</a></h3>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
472 <dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
473 <dt class="event-type-label">Type:</dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
474 <dd class="event-type">dropactivate</dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
475 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
476 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
477 <div class="event-description">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
478 <p>This event is triggered any time an accepted draggable starts dragging. This can be useful if you want to make the droppable 'light up' when it can be dropped on.</p>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
479 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
480 <div class="event-examples">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
481 <h4>Code examples</h4>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
482 <dl class="event-examples-list">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
483
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
484 <dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
485 Supply a callback function to handle the <code>activate</code> event as an init option.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
486 </dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
487 <dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
488 <pre><code>$( &quot;.selector&quot; ).droppable({
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
489 activate: function(event, ui) { ... }
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
490 });</code></pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
491 </dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
492
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
493
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
494 <dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
495 Bind to the <code>activate</code> event by type: <code>dropactivate</code>.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
496 </dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
497 <dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
498 <pre><code>$( &quot;.selector&quot; ).bind( &quot;dropactivate&quot;, function(event, ui) {
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
499 ...
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
500 });</code></pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
501 </dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
502
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
503 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
504 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
505 </li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
506
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
507
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
508 <li class="event" id="event-deactivate">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
509 <div class="event-header">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
510 <h3 class="event-name"><a href="#event-deactivate">deactivate</a></h3>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
511 <dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
512 <dt class="event-type-label">Type:</dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
513 <dd class="event-type">dropdeactivate</dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
514 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
515 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
516 <div class="event-description">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
517 <p>This event is triggered any time an accepted draggable stops dragging.</p>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
518 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
519 <div class="event-examples">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
520 <h4>Code examples</h4>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
521 <dl class="event-examples-list">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
522
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
523 <dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
524 Supply a callback function to handle the <code>deactivate</code> event as an init option.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
525 </dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
526 <dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
527 <pre><code>$( &quot;.selector&quot; ).droppable({
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
528 deactivate: function(event, ui) { ... }
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
529 });</code></pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
530 </dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
531
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
532
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
533 <dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
534 Bind to the <code>deactivate</code> event by type: <code>dropdeactivate</code>.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
535 </dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
536 <dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
537 <pre><code>$( &quot;.selector&quot; ).bind( &quot;dropdeactivate&quot;, function(event, ui) {
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
538 ...
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
539 });</code></pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
540 </dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
541
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
542 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
543 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
544 </li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
545
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
546
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
547 <li class="event" id="event-over">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
548 <div class="event-header">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
549 <h3 class="event-name"><a href="#event-over">over</a></h3>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
550 <dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
551 <dt class="event-type-label">Type:</dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
552 <dd class="event-type">dropover</dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
553 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
554 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
555 <div class="event-description">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
556 <p>This event is triggered as an accepted draggable is dragged 'over' (within the tolerance of) this droppable.</p>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
557 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
558 <div class="event-examples">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
559 <h4>Code examples</h4>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
560 <dl class="event-examples-list">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
561
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
562 <dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
563 Supply a callback function to handle the <code>over</code> event as an init option.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
564 </dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
565 <dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
566 <pre><code>$( &quot;.selector&quot; ).droppable({
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
567 over: function(event, ui) { ... }
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
568 });</code></pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
569 </dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
570
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
571
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
572 <dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
573 Bind to the <code>over</code> event by type: <code>dropover</code>.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
574 </dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
575 <dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
576 <pre><code>$( &quot;.selector&quot; ).bind( &quot;dropover&quot;, function(event, ui) {
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
577 ...
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
578 });</code></pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
579 </dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
580
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
581 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
582 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
583 </li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
584
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
585
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
586 <li class="event" id="event-out">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
587 <div class="event-header">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
588 <h3 class="event-name"><a href="#event-out">out</a></h3>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
589 <dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
590 <dt class="event-type-label">Type:</dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
591 <dd class="event-type">dropout</dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
592 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
593 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
594 <div class="event-description">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
595 <p>This event is triggered when an accepted draggable is dragged out (within the tolerance of) this droppable.</p>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
596 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
597 <div class="event-examples">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
598 <h4>Code examples</h4>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
599 <dl class="event-examples-list">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
600
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
601 <dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
602 Supply a callback function to handle the <code>out</code> event as an init option.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
603 </dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
604 <dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
605 <pre><code>$( &quot;.selector&quot; ).droppable({
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
606 out: function(event, ui) { ... }
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
607 });</code></pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
608 </dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
609
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
610
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
611 <dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
612 Bind to the <code>out</code> event by type: <code>dropout</code>.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
613 </dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
614 <dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
615 <pre><code>$( &quot;.selector&quot; ).bind( &quot;dropout&quot;, function(event, ui) {
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
616 ...
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
617 });</code></pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
618 </dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
619
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
620 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
621 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
622 </li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
623
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
624
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
625 <li class="event" id="event-drop">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
626 <div class="event-header">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
627 <h3 class="event-name"><a href="#event-drop">drop</a></h3>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
628 <dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
629 <dt class="event-type-label">Type:</dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
630 <dd class="event-type">drop</dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
631 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
632 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
633 <div class="event-description">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
634 <p>This event is triggered when an accepted draggable is dropped 'over' (within the tolerance of) this droppable. In the callback, $(this) represents the droppable the draggable is dropped on.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
635 ui.draggable represents the draggable.</p>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
636 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
637 <div class="event-examples">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
638 <h4>Code examples</h4>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
639 <dl class="event-examples-list">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
640
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
641 <dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
642 Supply a callback function to handle the <code>drop</code> event as an init option.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
643 </dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
644 <dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
645 <pre><code>$( &quot;.selector&quot; ).droppable({
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
646 drop: function(event, ui) { ... }
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
647 });</code></pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
648 </dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
649
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
650
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
651 <dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
652 Bind to the <code>drop</code> event by type: <code>drop</code>.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
653 </dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
654 <dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
655 <pre><code>$( &quot;.selector&quot; ).bind( &quot;drop&quot;, function(event, ui) {
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
656 ...
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
657 });</code></pre>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
658 </dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
659
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
660 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
661 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
662 </li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
663
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
664 </ul>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
665 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
666 <div id="methods">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
667 <h2 class="top-header">Methods</h2>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
668 <ul class="methods-list">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
669
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
670 <li class="method" id="method-destroy">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
671 <div class="method-header">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
672 <h3 class="method-name"><a href="#method-destroy">destroy</a></h3>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
673 <dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
674 <dt class="method-signature-label">Signature:</dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
675 <dd class="method-signature">.droppable( "destroy"
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
676
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
677
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
678
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
679
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
680
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
681
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
682
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
683 )</dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
684 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
685 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
686 <div class="method-description">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
687 <p>Remove the droppable functionality completely. This will return the element back to its pre-init state.</p>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
688 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
689 </li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
690
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
691
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
692 <li class="method" id="method-disable">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
693 <div class="method-header">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
694 <h3 class="method-name"><a href="#method-disable">disable</a></h3>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
695 <dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
696 <dt class="method-signature-label">Signature:</dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
697 <dd class="method-signature">.droppable( "disable"
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
698
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
699
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
700
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
701
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
702
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
703
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
704
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
705 )</dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
706 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
707 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
708 <div class="method-description">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
709 <p>Disable the droppable.</p>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
710 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
711 </li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
712
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
713
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
714 <li class="method" id="method-enable">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
715 <div class="method-header">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
716 <h3 class="method-name"><a href="#method-enable">enable</a></h3>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
717 <dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
718 <dt class="method-signature-label">Signature:</dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
719 <dd class="method-signature">.droppable( "enable"
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
720
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
721
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
722
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
723
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
724
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
725
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
726
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
727 )</dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
728 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
729 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
730 <div class="method-description">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
731 <p>Enable the droppable.</p>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
732 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
733 </li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
734
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
735
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
736 <li class="method" id="method-option">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
737 <div class="method-header">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
738 <h3 class="method-name"><a href="#method-option">option</a></h3>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
739 <dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
740 <dt class="method-signature-label">Signature:</dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
741 <dd class="method-signature">.droppable( "option"
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
742
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
743 , optionName
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
744
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
745 , <span class="optional">[</span>value<span class="optional">] </span>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
746
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
747
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
748
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
749 )</dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
750 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
751 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
752 <div class="method-description">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
753 <p>Get or set any droppable option. If no value is specified, will act as a getter.</p>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
754 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
755 </li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
756
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
757
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
758 <li class="method" id="method-option">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
759 <div class="method-header">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
760 <h3 class="method-name"><a href="#method-option">option</a></h3>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
761 <dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
762 <dt class="method-signature-label">Signature:</dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
763 <dd class="method-signature">.droppable( "option"
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
764
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
765 , options
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
766
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
767
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
768
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
769
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
770
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
771 )</dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
772 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
773 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
774 <div class="method-description">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
775 <p>Set multiple droppable options at once by providing an options object.</p>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
776 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
777 </li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
778
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
779
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
780 <li class="method" id="method-widget">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
781 <div class="method-header">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
782 <h3 class="method-name"><a href="#method-widget">widget</a></h3>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
783 <dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
784 <dt class="method-signature-label">Signature:</dt>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
785 <dd class="method-signature">.droppable( "widget"
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
786
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
787
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
788
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
789
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
790
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
791
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
792
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
793 )</dd>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
794 </dl>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
795 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
796 <div class="method-description">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
797 <p>Returns the .ui-droppable element.</p>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
798 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
799 </li>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
800
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
801
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
802 </ul>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
803 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
804 <div id="theming">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
805 <h2 class="top-header">Theming</h2>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
806 <p>The jQuery UI Droppable plugin uses the jQuery UI CSS Framework to style its look and feel, including colors and background textures. We recommend using the ThemeRoller tool to create and download custom themes that are easy to build and maintain.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
807 </p>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
808 <p>If a deeper level of customization is needed, there are widget-specific classes referenced within the jquery.ui.droppable.css stylesheet that can be modified. These classes are highlighed in bold below.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
809 </p>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
810
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
811 <h3>Sample markup with jQuery UI CSS Framework classes</h3>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
812 &lt;div class=&quot;<strong>ui-droppable</strong>&quot;&gt;&lt;/div&gt;
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
813 <p class="theme-note">
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
814 <strong>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
815 Note: This is a sample of markup generated by the droppable plugin, not markup you should use to create a droppable. The only markup needed for that is &lt;div&gt;&lt;/div&gt;.
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
816 </strong>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
817 </p>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
818
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
819 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
820 </div>
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
821
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
822 </p><!--
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
823 Pre-expand include size: 33718 bytes
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
824 Post-expand include size: 53508 bytes
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
825 Template argument size: 26843 bytes
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
826 Maximum: 2097152 bytes
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
827 -->
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
828
b2e4605f20b2 beta version
dwinter
parents:
diff changeset
829 <!-- Saved in parser cache with key jqdocs_docs:pcache:idhash:3769-1!1!0!!en!2 and timestamp 20110315194340 -->