The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Jifty::Web::Form::Clickable - Some item that can be clicked on -- either a button or a link.

DESCRIPTION

accessors

Clickable adds url, escape_label, continuation, call, returns, submit, and preserve_state to the list of accessors and mutators, in addition to those offered by "accessors" in Jifty::Web::Form::Element.

new PARAMHASH

Creates a new Jifty::Web::Form::Clickable object. Depending on the requirements, it may render as a link or as a button. Possible parameters in the PARAMHASH are:

url

Sets the page that the user will end up on after they click the button. Defaults to the current page.

label

The text on the clickable object.

escape_label

If set to true, HTML escapes the content of the label before displaying it. This is only relevant for objects that are rendered as HTML links. The default is true.

continuation

The current continuation for the link. Defaults to the current continuation now, if there is one. This may be either a Jifty::Continuation object, or the id of such.

call

The continuation to call when the link is clicked. This will happen after actions have run, if any. Like continuation, this may be a Jifty::Continuation object or the id of such.

returns

Passing this parameter implies the creation of a continuation when the link is clicked. It takes an anonymous hash of return location to where the return value is pulled from. See Jifty::Request::Mapper for details.

submit

A list of actions to run when the object is clicked. This may be an array refrence of a single element; each element may either be a moniker of a Jifty::Action. An undefined value submits all actions in the form, an empty list reference (the default) submits none.

preserve_state

A boolean; whether state variables are preserved across the link. Defaults to true if there are any AJAX actions on the link, false otherwise.

Anything from Jifty::Web::Form::Element

url

Sets the page that the user will end up on after they click the button. Defaults to the current page.

label

The text on the clickable object.

escape_label

If set to true, HTML escapes the content of the label before displaying it. This is only relevant for objects that are rendered as HTML links. The default is true.

continuation

The current continuation for the link. Defaults to the current continuation now, if there is one. This may be either a Jifty::Continuation object, or the id of such.

call

The continuation to call when the link is clicked. This will happen after actions have run, if any. Like continuation, this may be a Jifty::Continuation object or the id of such.

returns

Passing this parameter implies the creation of a continuation when the link is clicked. It takes an anonymous hash of return location to where the return value is pulled from. See Jifty::Request::Mapper for details.

submit

A list of actions to run when the object is clicked. This may be an array refrence of a single element; each element may either be a moniker of a Jifty::Action. An undefined value submits all actions in the form, an empty list reference (the default) submits none.

preserve_state

A boolean; whether state variables are preserved across the link. Defaults to true if there are any AJAX actions on the link, false otherwise.

parameter KEY VALUE

Sets the given HTTP paramter named KEY to the given VALUE.

state_variable KEY VALUE

Sets the state variable named KEY to VALUE.

region_fragment NAME PATH

Sets the path of the fragment named NAME to be PATH.

region_argument NAME ARG VALUE

Sets the value of the ARG argument on the fragment named NAME to VALUE.

parameters

Returns the generic list of parameters attached to the link as a hash. Use of this is discouraged in favor or "post_parameters" and "get_parameters".

post_parameters

The hash of parameters as they would be needed on a POST request.

get_parameters

The hash of parameters as they would be needed on a GET request.

complete_url

Returns the complete GET URL, as it would appear on a link.

Returns the clickable as a Jifty::Web::Form::Link, if possible. Use of this method is discouraged in favor of "generate", which can better determine if a link or a button is more appropriate.

as_button

Returns the clickable as a Jifty::Web::Form::Field::InlineButton, if possible. Use of this method is discouraged in favor of "generate", which can better determine if a link or a button is more appropriate.

generate

Returns a Jifty::Web::Form::Field::InlineButton or Jifty::Web::Form::Link, whichever is more appropriate given the paramters.