NAME

Jifty::Web::Form::Element - Some item that can be rendered in a form

DESCRIPTION

Describes any HTML element that might live in a form, and thus might have javascript on it.

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

The format of the arguments passed to onclick (or any similar method) is a hash reference, with the following possible keys:

submit (optional)

An action (or moniker of an action) to be submitted when the event is fired.

region (optional)

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

args (optional)

Arguments to the region. These will override the default arguments to the region.

fragment (optional)

The fragment that should go into the region. The default is whatever fragment the region was originally rendered with.

handlers

Currently, the only supported event handlers are onclick.

accessors

Any descendant of Jifty::Web::Form::Element should be able to accept any of the event handlers (above) as one of the keys to its new parameter hash.

javascript

Returns the javsscript necessary to make the events happen.

class

Sets the CSS class that the element will display as

key_binding

Sets the key binding associated with this elements

id

Subclasses must override this to provide each element with a unique id.

label

Sets the label of the element. This will be used for the key binding legend, at very least.

render_key_binding

Adds the key binding for this input, if one exists.