[ Index ]

PHP Cross Reference of Akelos Framework

title

Body

[close]

/AkActionView/helpers/ -> scriptaculous_helper.php (summary)

[Source view] [Print]

(no description)

Author: Bermi Ferrer
Copyright: Copyright (c) 2002-2006, Akelos Media, S.L. http://www.akelos.org
License: GNU Lesser General Public License
File Size: 206 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 1 file
 AkActionView/helpers/javascript_helper.php

Defines 1 class

ScriptaculousHelper:: (5 methods):
  visual_effect()
  sortable_element()
  draggable_element()
  draggable_element_js()
  drop_receiving_element()


Class: ScriptaculousHelper  - X-Ref

Provides a set of helpers for calling Scriptaculous JavaScript
functions, including those which create Ajax controls and visual effects.

To be able to use these helpers, you must include the Prototype
JavaScript framework and the Scriptaculous JavaScript library in your
pages. See the documentation for ActionView::Helpers::JavaScriptHelper
for more information on including the necessary JavaScript.

The Scriptaculous helpers' behavior can be tweaked with various options.
See the documentation at http://script.aculo.us for more information on
using these helpers in your application.
visual_effect($name, $element_id = false, $js_options = array()   X-Ref
Returns a JavaScript snippet to be used on the Ajax callbacks for
starting visual effects.

Example:
<?= $prototype_helper->link_to_remote(
'Reload',
'update' => 'posts',
'url' => array('action' => 'reload'),
'complete' => $scriptaculous_helper->visual_effect('highlight', 'posts', array('duration' => 0.5))) ?>

If no element_id is given, it assumes "element" which should be a local
variable in the generated JavaScript execution context. This can be
used for example with drop_receiving_element:

<?= $scriptaculous_helper->drop_receiving_element (..., array('loading' => $scriptaculous_helper->visual_effect('fade'))) ?>

This would fade the element that was dropped on the drop receiving
element.

For toggling visual effects, you can use 'toggle_appear', 'toggle_slide', and
'toggle_blind' which will alternate between appear/fade, slidedown/slideup, and
blinddown/blindup respectively.

You can change the behaviour with various options, see
http://script.aculo.us for more documentation.

sortable_element($element_id, $options = array()   X-Ref
Makes the element with the DOM ID specified by +element_id+ sortable
by drag-and-drop and make an Ajax call whenever the sort order has
changed. By default, the action called gets the serialized sortable
element as parameters.

Example:
<?= $scriptaculous_helper->sortable_element('my_list', 'url' => array('action' => 'order')) ?>

In the example, the action gets a "my_list" array parameter
containing the values of the ids of elements the sortable consists
of, in the current order.

You can change the behaviour with various options, see
http://script.aculo.us for more documentation.

draggable_element($element_id, $options = array()   X-Ref
Makes the element with the DOM ID specified by +element_id+ draggable.

Example:
<?= $scriptaculous_helper->draggable_element("my_image", 'revert' => true)

You can change the behaviour with various options, see
http://script.aculo.us for more documentation.

draggable_element_js($element_id, $options = array()   X-Ref
No description

drop_receiving_element($element_id, $options = array()   X-Ref
Makes the element with the DOM ID specified by +element_id+ receive
dropped draggable elements (created by draggable_element).
and make an AJAX call  By default, the action called gets the DOM ID
of the element as parameter.

Example:
<?= $scriptaculous_helper->drop_receiving_element("my_cart", array('url' =>
array('controller' => "cart", 'action' => "add" ))) ?>

You can change the behaviour with various options, see
http://script.aculo.us for more documentation.


Generated: Mon Oct 27 12:43:49 2008 Cross-referenced by PHPXref 0.6