Changeset 1331
- Timestamp:
- 03/16/08 11:57:14 (4 months ago)
- Files:
-
- mochikit/trunk/doc/html/MochiKit/Visual.html (modified) (7 diffs)
- mochikit/trunk/doc/rst/MochiKit/Visual.rst (modified) (7 diffs)
Legend:
- Unmodified
- Added
- Removed
- Modified
- Copied
- Moved
mochikit/trunk/doc/html/MochiKit/Visual.html
r1330 r1331 267 267 the effect has completed, the <tt class="docutils literal"><span class="pre">element</span></tt> will be hidden with 268 268 <a class="mochiref reference" href="Style.html#fn-hideelement">MochiKit.Style.hideElement</a> and the original element 269 opacity will be restored. The available <tt class="docutils literal"><span class="pre">options</span></tt> are identical 270 to the <a class="mochiref reference" href="#fn-opacity">Opacity</a> effect.</p> 269 opacity will be restored.</p> 271 270 <dl class="docutils"> 272 271 <dt>element:</dt> … … 299 298 <p>Slowly shows an <tt class="docutils literal"><span class="pre">element</span></tt> using the <a class="mochiref reference" href="#fn-opacity">Opacity</a> effect. 300 299 If the <tt class="docutils literal"><span class="pre">element</span></tt> has <tt class="docutils literal"><span class="pre">"display:</span> <span class="pre">none"</span></tt> style it will be changed 301 to <tt class="docutils literal"><span class="pre">"display:</span> <span class="pre">block"</span></tt> with <a class="mochiref reference" href="Style.html#fn-showelement">MochiKit.Style.showElement</a>. 302 The available options are identical to the <a class="mochiref reference" href="#fn-opacity">Opacity</a> effect.</p> 300 to <tt class="docutils literal"><span class="pre">"display:</span> <span class="pre">block"</span></tt> with <a class="mochiref reference" href="Style.html#fn-showelement">MochiKit.Style.showElement</a>.</p> 303 301 <dl class="docutils"> 304 302 <dt>element:</dt> … … 329 327 <a class="mochidef reference" href="#fn-puff">puff(element [, options])</a>:</p> 330 328 <blockquote> 331 <p>Make an elementdouble size, and then make it disappear using the329 <p>Make an <tt class="docutils literal"><span class="pre">element</span></tt> double size, and then make it disappear using the 332 330 <a class="mochiref reference" href="#fn-scale">Scale</a> and <a class="mochiref reference" href="#fn-opacity">Opacity</a> effects. Once the effect 333 331 has completed, the <tt class="docutils literal"><span class="pre">element</span></tt> will be hidden with 334 332 <a class="mochiref reference" href="Style.html#fn-hideelement">MochiKit.Style.hideElement</a> and the original element 335 size, position and opacity will be restored. Only a few options 336 from <a class="mochiref reference" href="#fn-scale">Scale</a> are supported along with the 337 <a class="mochiref reference" href="#fn-defaultoptions">DefaultOptions</a>.</p> 338 <dl class="docutils"> 339 <dt>element:</dt> 340 <dd>An element ID string or a DOM node (see 341 <a class="mochiref reference" href="DOM.html#fn-getelement">MochiKit.DOM.getElement</a>).</dd> 342 <dt>options:</dt> 343 <dd><table border="1" class="first last docutils"> 344 <colgroup> 345 <col width="57%" /> 346 <col width="43%" /> 347 </colgroup> 348 <tbody valign="top"> 349 <tr><td>scaleContent</td> 350 <td><tt class="docutils literal"><span class="pre">true</span></tt></td> 351 </tr> 352 <tr><td>scaleFromCenter</td> 353 <td><tt class="docutils literal"><span class="pre">true</span></tt></td> 354 </tr> 355 </tbody> 356 </table> 357 </dd> 333 size, position and opacity will be restored.</p> 334 <dl class="docutils"> 335 <dt>element:</dt> 336 <dd>An element ID string or a DOM node (see 337 <a class="mochiref reference" href="DOM.html#fn-getelement">MochiKit.DOM.getElement</a>).</dd> 338 <dt>options:</dt> 339 <dd>See <a class="mochiref reference" href="#fn-defaultoptions">DefaultOptions</a>.</dd> 358 340 <dt><em>Availability</em>:</dt> 359 341 <dd>Available in MochiKit 1.4+</dd> … … 364 346 <a class="mochidef reference" href="#fn-blindup">blindUp(element [, options])</a>:</p> 365 347 <blockquote> 366 <p>Blind an element up, changing its vertical size to 0.</p> 367 <dl class="docutils"> 368 <dt>element:</dt> 369 <dd>An element ID string or a DOM node (see 370 <a class="mochiref reference" href="DOM.html#fn-getelement">MochiKit.DOM.getElement</a>).</dd> 348 <p>Blind an <tt class="docutils literal"><span class="pre">element</span></tt> up, changing its vertical size to 0 using the 349 <a class="mochiref reference" href="#fn-scale">Scale</a> effect. Once the effect has completed, the 350 <tt class="docutils literal"><span class="pre">element</span></tt> will be hidden with 351 <a class="mochiref reference" href="Style.html#fn-hideelement">MochiKit.Style.hideElement</a> and the original element 352 size will be restored.</p> 353 <dl class="docutils"> 354 <dt>element:</dt> 355 <dd>An element ID string or a DOM node (see 356 <a class="mochiref reference" href="DOM.html#fn-getelement">MochiKit.DOM.getElement</a>).</dd> 357 <dt>options:</dt> 358 <dd>See <a class="mochiref reference" href="#fn-defaultoptions">DefaultOptions</a>.</dd> 371 359 <dt><em>Availability</em>:</dt> 372 360 <dd>Available in MochiKit 1.4+</dd> … … 377 365 <a class="mochidef reference" href="#fn-blinddown">blindDown(element [, options])</a>:</p> 378 366 <blockquote> 379 <p>Blind an element down, restoring its vertical size.</p> 380 <dl class="docutils"> 381 <dt>element:</dt> 382 <dd>An element ID string or a DOM node (see 383 <a class="mochiref reference" href="DOM.html#fn-getelement">MochiKit.DOM.getElement</a>).</dd> 367 <p>Blind an <tt class="docutils literal"><span class="pre">element</span></tt> down, restoring its vertical size using the 368 <a class="mochiref reference" href="#fn-scale">Scale</a> effect. If the <tt class="docutils literal"><span class="pre">element</span></tt> has <tt class="docutils literal"><span class="pre">"display:</span> <span class="pre">none"</span></tt> 369 style it will be changed to <tt class="docutils literal"><span class="pre">"display:</span> <span class="pre">block"</span></tt> with 370 <a class="mochiref reference" href="Style.html#fn-showelement">MochiKit.Style.showElement</a>.</p> 371 <dl class="docutils"> 372 <dt>element:</dt> 373 <dd>An element ID string or a DOM node (see 374 <a class="mochiref reference" href="DOM.html#fn-getelement">MochiKit.DOM.getElement</a>).</dd> 375 <dt>options:</dt> 376 <dd>See <a class="mochiref reference" href="#fn-defaultoptions">DefaultOptions</a>.</dd> 384 377 <dt><em>Availability</em>:</dt> 385 378 <dd>Available in MochiKit 1.4+</dd> … … 442 435 <a class="mochidef reference" href="#fn-slidedown">slideDown(element [, options])</a>:</p> 443 436 <blockquote> 444 <p>Slide an element down.</p> 445 <dl class="docutils"> 446 <dt>element:</dt> 447 <dd>An element ID string or a DOM node (see 448 <a class="mochiref reference" href="DOM.html#fn-getelement">MochiKit.DOM.getElement</a>).</dd> 437 <p>Slide an <tt class="docutils literal"><span class="pre">element</span></tt> down using the <a class="mochiref reference" href="#fn-scale">Scale</a> effect. 438 The <tt class="docutils literal"><span class="pre">element</span></tt> must have a fixed height and contain a single 439 child. If the <tt class="docutils literal"><span class="pre">element</span></tt> has <tt class="docutils literal"><span class="pre">"display:</span> <span class="pre">none"</span></tt> style it 440 will be changed to <tt class="docutils literal"><span class="pre">"display:</span> <span class="pre">block"</span></tt> with 441 <a class="mochiref reference" href="Style.html#fn-showelement">MochiKit.Style.showElement</a>.</p> 442 <dl class="docutils"> 443 <dt>element:</dt> 444 <dd>An element ID string or a DOM node (see 445 <a class="mochiref reference" href="DOM.html#fn-getelement">MochiKit.DOM.getElement</a>).</dd> 446 <dt>options:</dt> 447 <dd>See <a class="mochiref reference" href="#fn-defaultoptions">DefaultOptions</a>.</dd> 449 448 <dt><em>Availability</em>:</dt> 450 449 <dd>Available in MochiKit 1.4+</dd> … … 455 454 <a class="mochidef reference" href="#fn-slideup">slideUp(element [, options])</a>:</p> 456 455 <blockquote> 457 <p>Slide an element up.</p> 458 <dl class="docutils"> 459 <dt>element:</dt> 460 <dd>An element ID string or a DOM node (see 461 <a class="mochiref reference" href="DOM.html#fn-getelement">MochiKit.DOM.getElement</a>).</dd> 456 <p>Slide an <tt class="docutils literal"><span class="pre">element</span></tt> up using the <a class="mochiref reference" href="#fn-scale">Scale</a> effect. 457 The <tt class="docutils literal"><span class="pre">element</span></tt> must have a fixed height and contain a single 458 child. Once the effect has completed, the <tt class="docutils literal"><span class="pre">element</span></tt> will be 459 hidden with <a class="mochiref reference" href="Style.html#fn-hideelement">MochiKit.Style.hideElement</a> and the 460 original element size will be restored.</p> 461 <dl class="docutils"> 462 <dt>element:</dt> 463 <dd>An element ID string or a DOM node (see 464 <a class="mochiref reference" href="DOM.html#fn-getelement">MochiKit.DOM.getElement</a>).</dd> 465 <dt>options:</dt> 466 <dd>See <a class="mochiref reference" href="#fn-defaultoptions">DefaultOptions</a>.</dd> 462 467 <dt><em>Availability</em>:</dt> 463 468 <dd>Available in MochiKit 1.4+</dd> mochikit/trunk/doc/rst/MochiKit/Visual.rst
r1330 r1331 222 222 the effect has completed, the ``element`` will be hidden with 223 223 :mochiref:`MochiKit.Style.hideElement` and the original element 224 opacity will be restored. The available ``options`` are identical 225 to the :mochiref:`Opacity` effect. 224 opacity will be restored. 226 225 227 226 element: … … 244 243 If the ``element`` has ``"display: none"`` style it will be changed 245 244 to ``"display: block"`` with :mochiref:`MochiKit.Style.showElement`. 246 The available options are identical to the :mochiref:`Opacity` effect.247 245 248 246 element: … … 262 260 :mochidef:`puff(element [, options])`: 263 261 264 Make an elementdouble size, and then make it disappear using the262 Make an ``element`` double size, and then make it disappear using the 265 263 :mochiref:`Scale` and :mochiref:`Opacity` effects. Once the effect 266 264 has completed, the ``element`` will be hidden with 267 265 :mochiref:`MochiKit.Style.hideElement` and the original element 268 size, position and opacity will be restored. Only a few options 269 from :mochiref:`Scale` are supported along with the 270 :mochiref:`DefaultOptions`. 271 272 element: 273 An element ID string or a DOM node (see 274 :mochiref:`MochiKit.DOM.getElement`). 275 276 options: 277 ================ ============ 278 scaleContent ``true`` 279 scaleFromCenter ``true`` 280 ================ ============ 266 size, position and opacity will be restored. 267 268 element: 269 An element ID string or a DOM node (see 270 :mochiref:`MochiKit.DOM.getElement`). 271 272 options: 273 See :mochiref:`DefaultOptions`. 281 274 282 275 *Availability*: … … 286 279 :mochidef:`blindUp(element [, options])`: 287 280 288 Blind an element up, changing its vertical size to 0. 289 290 element: 291 An element ID string or a DOM node (see 292 :mochiref:`MochiKit.DOM.getElement`). 281 Blind an ``element`` up, changing its vertical size to 0 using the 282 :mochiref:`Scale` effect. Once the effect has completed, the 283 ``element`` will be hidden with 284 :mochiref:`MochiKit.Style.hideElement` and the original element 285 size will be restored. 286 287 element: 288 An element ID string or a DOM node (see 289 :mochiref:`MochiKit.DOM.getElement`). 290 291 options: 292 See :mochiref:`DefaultOptions`. 293 293 294 294 *Availability*: … … 298 298 :mochidef:`blindDown(element [, options])`: 299 299 300 Blind an element down, restoring its vertical size. 301 302 element: 303 An element ID string or a DOM node (see 304 :mochiref:`MochiKit.DOM.getElement`). 300 Blind an ``element`` down, restoring its vertical size using the 301 :mochiref:`Scale` effect. If the ``element`` has ``"display: none"`` 302 style it will be changed to ``"display: block"`` with 303 :mochiref:`MochiKit.Style.showElement`. 304 305 element: 306 An element ID string or a DOM node (see 307 :mochiref:`MochiKit.DOM.getElement`). 308 309 options: 310 See :mochiref:`DefaultOptions`. 305 311 306 312 *Availability*: … … 351 357 :mochidef:`slideDown(element [, options])`: 352 358 353 Slide an element down. 354 355 element: 356 An element ID string or a DOM node (see 357 :mochiref:`MochiKit.DOM.getElement`). 359 Slide an ``element`` down using the :mochiref:`Scale` effect. 360 The ``element`` must have a fixed height and contain a single 361 child. If the ``element`` has ``"display: none"`` style it 362 will be changed to ``"display: block"`` with 363 :mochiref:`MochiKit.Style.showElement`. 364 365 element: 366 An element ID string or a DOM node (see 367 :mochiref:`MochiKit.DOM.getElement`). 368 369 options: 370 See :mochiref:`DefaultOptions`. 358 371 359 372 *Availability*: … … 363 376 :mochidef:`slideUp(element [, options])`: 364 377 365 Slide an element up. 366 367 element: 368 An element ID string or a DOM node (see 369 :mochiref:`MochiKit.DOM.getElement`). 378 Slide an ``element`` up using the :mochiref:`Scale` effect. 379 The ``element`` must have a fixed height and contain a single 380 child. Once the effect has completed, the ``element`` will be 381 hidden with :mochiref:`MochiKit.Style.hideElement` and the 382 original element size will be restored. 383 384 element: 385 An element ID string or a DOM node (see 386 :mochiref:`MochiKit.DOM.getElement`). 387 388 options: 389 See :mochiref:`DefaultOptions`. 370 390 371 391 *Availability*:
