NAME

DESCRIPTION

Handlers are placed on Jifty::Web::Form::Element objects by calling the name of the javascript event handler, such as "onclick" or "onchange", with a set of arguments.

The format of the arguments passed to "onclick" (or any similar method) is a string, a hash reference, or a reference to an array of multiple hash references. Strings are inserted verbatim.

Hash references can take a number of possible keys. The most important is the mode of the fragment replacement, if any; it is specified by providing at most one of the following keys:

append => PATH

Add the given "PATH" as a new fragment at the end within the element specified by the CSS selector in "element".

prepend => PATH

Add the given "PATH" as a new fragment at the start within the element specified by the CSS selector in "element".

before => PATH

Add the given "PATH" as a new fragment immediately before the element specified by the CSS selector in "element".

after => PATH

Add the given "PATH" as a new fragment immediately after the element specified by the CSS selector in "element".

popout => PATH

Displays the given "PATH" as a new fragment in a lightbox-style popout.

replace_with => PATH

Replaces the region specified by the "region" parameter (which defaults to the current region) with the fragment located at the given "PATH". If "undef" is passed as the "PATH", acts like a "delete".

refresh => REGION

Refreshes the given "REGION", which should be a Jifty::Web::PageRegion object, or the fully qualified name of such.

refresh_self => 1

Refreshes the current region; this is the default action, if a non-empty "args" is supplied, but no other mode is given.

delete => REGION

Removes the given "REGION" from the page, permanently.

The following options are also supported:

toggle => BOOLEAN

If set to true, then the link will possibly toggle the region to empty, if the region's current path is the same as the path the region is trying to be set to.

region => REGION

The region that should be updated. This defaults to the current region.

element => CSS SELECTOR

A css selector specifying where the new region should be placed; used with "append", "prepend", "before", and "after" above. The "get_element" in Jifty::Web::PageRegion method may be useful in specifying elements of parent page regions.

Defaults to the current region.

submit => MONIKER

A Jifty::Action, Jifty::Action moniker, hashref of { action => Jifty::Action::Subclass, arguments => { argument => value, argument2 => value2 }

or an arrayref of them.

These actions are submitted when the event is fired. Any arguments specified will override arguments submitted by form field.

If you explicitly pass "undef", then all actions will be submitted. This can be useful in conjunction with an "onclick" handler, since declaring an "onclick" handler intentionally turns off action submission.

disable => BOOLEAN

If true, disable all form fields associated with the actions in "submit" when this Element is clicked. This serves to give immediate visual indication that the request is being processed, as well as to prevent double-submits.

Defaults to true.

args => HASHREF

Arguments to the region. These will override the arguments to the region that the region was given when it was last rendered.

effect => STRING

The Scriptaculous or jQuery visual effect to use when updating or creating the fragment.

effect_args => HASHREF

A hashref of arguments to pass to the effect when it is created. These can be used to change the duration of the effect, for instance.

remove_effect => STRING

As "effect", but for when the previous version of the region is removed.

remove_effect_args => HASHREF

As "effect_args", but for "remove_effect".

beforeclick => STRING

String contains some Javascript code to be used before a click.

confirm => STRING

Prompt the user with a Javascript confirm dialog with the given text before carrying out the rest of the handlers. If the user cancels, do nothing, otherwise proceed as normal.

TODO: This does not have a non-Javascript fallback method yet.