NAME

Reaction::UI::ViewPort::Action::Role::Apply - Integrate an Apply event into the ViewPort

SYNOPSIS

  package MyApp::UI::ViewPort::SomeAction;
  use Reaction::Class;

  use namespace::clean -except => 'meta';

  extends 'Reaction::UI::ViewPort::Object::Mutable';
  with    'Reaction::UI::ViewPort::Action::Role::Apply';

  ...
  1;

DESCRIPTION

This role integrates an "apply" event into the consuming viewport that will call the required "do_apply" role.

REQUIRED METHODS

do_apply

Will be called when an "apply" event comes in.

ATTRIBUTES

apply_label

Defaults to 'apply', returned by "_build_apply_label".

on_apply_callback

CodeRef. Will be called after "apply" if "can_apply" and "do_apply" return true. See "apply" for argument details.

METHODS

can_apply

Returns true by default. Determines if "do_apply" can be called.

apply

Calls a user-supplied "do_apply" and if it is successful runs the "on_apply_callback" passing $self and the result of "do_apply" as args.

INTERNAL METHODS

_build_apply_label

Defaults to "apply".

AUTHORS

See Reaction::Class for authors.

LICENSE

See Reaction::Class for the license.