kivitendo/SL/Layout/ActionBar/Action.pm @ bf5e6c6a
| e0a3b19e | Sven Schöling | package SL::Layout::ActionBar::Action;
|
||
use strict;
|
||||
use parent qw(Rose::Object);
|
||||
use SL::Presenter;
|
||||
use Rose::Object::MakeMethods::Generic (
|
||||
| 3dc29e42 | Sven Schöling | 'scalar --get_set_init' => [ qw(id params text) ],
|
||
| e0a3b19e | Sven Schöling | );
|
||
# subclassing interface
|
||||
sub render {
|
||||
die 'needs to be implemented';
|
||||
}
|
||||
sub script {
|
||||
| 3dc29e42 | Sven Schöling | sprintf q|$('#%s').data('action', %s);|, $_[0]->id, JSON->new->allow_blessed->convert_blessed->encode($_[0]->params);
|
||
| e0a3b19e | Sven Schöling | }
|
||
| 6ce40ffc | Sven Schöling | # this is mostly so that outside consumer don't need to load subclasses themselves
|
||
| ff424b75 | Moritz Bunkus | sub from_params {
|
||
| e0a3b19e | Sven Schöling | my ($class, $data) = @_;
|
||
| f9c6711c | Moritz Bunkus | require SL::Layout::ActionBar::Submit;
|
||
| e0a3b19e | Sven Schöling | my ($text, %params) = @$data;
|
||
| 36c8af52 | Moritz Bunkus | return if exists($params{only_if}) && !$params{only_if};
|
||
return if exists($params{not_if}) && $params{not_if};
|
||||
| 6ce40ffc | Sven Schöling | return SL::Layout::ActionBar::Submit->new(text => $text, params => \%params);
|
||
| e0a3b19e | Sven Schöling | }
|
||
| 2d587c41 | Moritz Bunkus | sub callable { 0 }
|
||
| e0a3b19e | Sven Schöling | # shortcut for presenter
|
||
sub p {
|
||||
SL::Presenter->get
|
||||
}
|
||||
| 2cac4306 | Sven Schöling | sub init_params {
|
||
+{}
|
||||
}
|
||||
| e0a3b19e | Sven Schöling | # unique id to tie div and javascript together
|
||
sub init_id {
|
||||
| 2cac4306 | Sven Schöling | $_[0]->params->{id} //
|
||
| e0a3b19e | Sven Schöling | $_[0]->p->name_to_id('action[]')
|
||
}
|
||||
1;
|
||||
__END__
|
||||
| 3dc29e42 | Sven Schöling | |||
| cea0e38d | Sven Schöling | =encoding utf-8
|
||
=head1 NAME
|
||||
SL::Layout::ActionBar::Action - base class for action bar actions
|
||||
=head1 DESCRIPTION
|
||||
This base class for actions can be used to implement elements that can be
|
||||
added to L<SL::Layout::ActionBar>.
|
||||
Elements can be interactive or simply used for layout. Most of the actual
|
||||
| 74ddcb2d | Sven Schöling | semantics are handled in the corresponding javascript C<js/kivi.ActionBar.js>, so
|
||
| cea0e38d | Sven Schöling | this is only used to generate the DOM elements and to provide information for
|
||
request time logic decisions.
|
||||
=head1 SYNOPSIS
|
||||
# implement:
|
||||
package SL::Layout::ActionBar::Custom;
|
||||
use parent qw(SL::Layout::ActionBar::Action);
|
||||
# unsugared use
|
||||
SL::Layout::ActionBar::Custom->new(
|
||||
text => t8('Description'),
|
||||
params => {
|
||||
key => $attr,
|
||||
key => $attr,
|
||||
...
|
||||
},
|
||||
);
|
||||
# parse sugared version:
|
||||
SL::Layout::ActionBar::Custom->from_params(
|
||||
t8('Description'),
|
||||
key => $attr,
|
||||
key => $attr,
|
||||
...
|
||||
);
|
||||
=head1 INTERFACE
|
||||
=over 4
|
||||
=item * C<render>
|
||||
Needs to be implemented. Should render only the bare minimum necessary to
|
||||
identify the element at run time.
|
||||
=item * C<script>
|
||||
Will be called during layout rendering. Defaults to dumping the params section
|
||||
into data field of the rendered DOM element.
|
||||
=item * C<from_params>
|
||||
Parse sugared version. Defaults for historic reasons to the implementation of
|
||||
L<SL::Layout::ActionBar::Submit>, all others must implement their own.
|
||||
=item * C<callable>
|
||||
Used to determine whether an instance is callable or only a layout element.
|
||||
=back
|
||||
=head1 METHODS
|
||||
=over 4
|
||||
=item * C<p>
|
||||
Returns the current request presenter.
|
||||
=item * C<id>
|
||||
Will get initialized to either the provided id from the params or to a
|
||||
generated unique id. Should be used to tie the rendered DOM and script
|
||||
together.
|
||||
=back
|
||||
=head1 RECOGNIZED PARAMETERS
|
||||
=over 4
|
||||
=item * C<< submit => [ $selector, \%params ] >>
|
||||
On click, submit the form found with the first parameter. If params is present
|
||||
and a hashref, the key value elements will be added to the form before
|
||||
submitting. Beware that this will destroy the form if the user uses the browser
|
||||
history to jump back to this page, so ony use parametrized submits for post
|
||||
submits that redirect on completion.
|
||||
=item * C<< link => $url >>
|
||||
On click, will load the given url.
|
||||
=item * C<< call => [ $function_name, @args ] >>
|
||||
On click, will call the function name with the argument array. The return will
|
||||
be discarded. It is assumed that the fucntion will trigger an asynchronous
|
||||
action.
|
||||
Contrast with C<checks>.
|
||||
=item * C<< checks => \@function_names >>
|
||||
Before any of C<submit>, C<link>, or C<call> are evaluated all
|
||||
functions in C<check> are called. Only if all of them return a true value the
|
||||
action will be triggered.
|
||||
Checks are expected not to trigger asynchronous actions (contrast with C<call>),
|
||||
but may change the DOM to indicate to the user why they fail.
|
||||
Each must return a boolean value.
|
||||
=item * C<< confirm => t8('Yes/No Question') >>
|
||||
Before any of C<submit>, C<link>, or C<call> are evaluated, the user
|
||||
will be asked to confirm. If checks are present and failed, confirm will not be
|
||||
triggered.
|
||||
=item * C<< only_if => $bool >>
|
||||
Pseudo parameter. If present and false, the element will not be rendered.
|
||||
=item * C<< not_if => $bool >>
|
||||
Pseudo parameter. If present and true, the element will not be rendered.
|
||||
=item * C<< only_once => 1 >>
|
||||
If present, a click will C<disable> the action to prevent multiple activations.
|
||||
=item * C<< accesskey => $text >>
|
||||
| 74ddcb2d | Sven Schöling | Registers an accesskey for this element. While the most common accesskey is
|
||
| cea0e38d | Sven Schöling | 'enter', in theory every other should work as well. Modifier keys can be added
|
||
to the accesskey string with 'ctrl+', 'alt+', or 'shift+'. 'shift+' is not
|
||||
necessary for upper case letters.
|
||||
=item * C<< disabled => t8('tooltip') >>
|
||||
Renders the element disabled, ignores all actions (C<submit>, C<call>, C<link>)
|
||||
and adds the given tooltip hopefully explaining why the element is disabled.
|
||||
| 3dc29e42 | Sven Schöling | |||
| cea0e38d | Sven Schöling | =item * C<< id => $id >>
|
||
| 3dc29e42 | Sven Schöling | |||
| cea0e38d | Sven Schöling | Sets the DOM id of the rendered element. If missing, the element will get a
|
||
random id.
|
||||
| 3dc29e42 | Sven Schöling | |||
| cea0e38d | Sven Schöling | =item * C<< tooltip => t8('tooltip') >>
|
||
| 3dc29e42 | Sven Schöling | |||
| cea0e38d | Sven Schöling | Sets a tooltip for the element.
|
||
| 3dc29e42 | Sven Schöling | |||
| cea0e38d | Sven Schöling | =back
|
||
| 3dc29e42 | Sven Schöling | |||
| cea0e38d | Sven Schöling | =head1 BUGS
|
||
| 3dc29e42 | Sven Schöling | |||
| cea0e38d | Sven Schöling | None yet :)
|
||
| 3dc29e42 | Sven Schöling | |||
| cea0e38d | Sven Schöling | =head1 AUTHOR
|
||
| 3dc29e42 | Sven Schöling | |||
| cea0e38d | Sven Schöling | Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>
|
||
| 3dc29e42 | Sven Schöling | |||
| cea0e38d | Sven Schöling | =cut
|