Auftrags-Controller: PriceSources: Umstellung auf discount_from_source.

[mfinanz.git] / SL / ClientJS.pm

diff --git a/SL/ClientJS.pm b/SL/ClientJS.pm
index 1218e4cc55a51d3ce8a4a1c1f819696ee016dc50..335bf8163107cdfcf383cd7c7e19a9de039d36cd 100644 (file)
--- a/SL/ClientJS.pm
+++ b/SL/ClientJS.pm
@@ -9,13 +9,11 @@ use SL::JSON ();
 
 use Rose::Object::MakeMethods::Generic
 (
 
 use Rose::Object::MakeMethods::Generic
 (

+  scalar                  => [ qw(controller) ],

   'scalar --get_set_init' => [ qw(_actions _flash _error) ],
 );
 
 my %supported_methods = (
   'scalar --get_set_init' => [ qw(_actions _flash _error) ],
 );
 
 my %supported_methods = (

-  # ## Non-jQuery methods ##
-  flash        => 2,            # display_flash(<TARGET>, <ARGS>)
-

   # ## jQuery basics ##
 
   # Basic effects
   # ## jQuery basics ##
 
   # Basic effects


@@ -68,7 +66,21 @@ my %supported_methods = (
   removeData   => 2,
 
   # Form Events
   removeData   => 2,
 
   # Form Events

-  focus        => 1,
+  focus        => 1, # kivi.set_focus(<TARGET>)
+
+  # Generic Event Handling ## pattern: $(<TARGET>).<FUNCTION>(<ARG1>, kivi.get_function_by_name(<ARG2>))
+  on           => 3,
+  off          => 3,
+  one          => 3,
+
+  # ## jQuery UI dialog plugin ## pattern: $(<TARGET>).dialog('<FUNCTION>')
+
+  # Opening and closing and closing a popup
+  'dialog:open'          => 1, # kivi.popup_dialog(<TARGET>)
+  'dialog:close'         => 1,
+
+  # ## jQuery Form plugin ##
+  'ajaxForm'             => 1, # pattern: $(<TARGET>).ajaxForm({ success: eval_json_result })

 
   # ## jstree plugin ## pattern: $.jstree._reference($(<TARGET>)).<FUNCTION>(<ARGS>)
 
 
   # ## jstree plugin ## pattern: $.jstree._reference($(<TARGET>)).<FUNCTION>(<ARGS>)
 


@@ -95,8 +107,23 @@ my %supported_methods = (
   'jstree:select_node'   => 2,  # $.jstree._reference($(<TARGET>)).<FUNCTION>(<ARGS>, true)
   'jstree:deselect_node' => 2,
   'jstree:deselect_all'  => 1,
   'jstree:select_node'   => 2,  # $.jstree._reference($(<TARGET>)).<FUNCTION>(<ARGS>, true)
   'jstree:deselect_node' => 2,
   'jstree:deselect_all'  => 1,

+
+  # ## ckeditor stuff ##
+  'focus_ckeditor'       => 1,  # kivi.focus_ckeditor_when_ready(<TARGET>)
+
+  # ## other stuff ##
+  redirect_to            => 1,  # window.location.href = <TARGET>
+
+  flash                  => 2,  # kivi.display_flash(<TARGET>, <ARGS>)
+  reinit_widgets         => 0,  # kivi.reinit_widgets()
+  run                    => -1, # kivi.run(<TARGET>, <ARGS>)
+  run_once_for           => 3,  # kivi.run_once_for(<TARGET>, <ARGS>)
+
+  scroll_into_view       => 1,  # $(<TARGET>)[0].scrollIntoView()

 );
 
 );
 

+my %trim_target_for = map { ($_ => 1) } qw(insertAfter insertBefore appendTo prependTo);
+

 sub AUTOLOAD {
   our $AUTOLOAD;
 
 sub AUTOLOAD {
   our $AUTOLOAD;
 


@@ -114,15 +141,26 @@ sub action {
   $method      =  (delete($self->{_prefix}) || '') . $method;
   my $num_args =  $supported_methods{$method};
 
   $method      =  (delete($self->{_prefix}) || '') . $method;
   my $num_args =  $supported_methods{$method};
 

-  croak "Unsupported jQuery action: $method"                                                    unless defined $num_args;
-  croak "Parameter count mismatch for $method(actual: " . scalar(@args) . " wanted: $num_args)" if     scalar(@args) != $num_args;
+  croak "Unsupported jQuery action: $method" unless defined $num_args;
+
+  if ($num_args > 0) {
+    croak "Parameter count mismatch for $method(actual: " . scalar(@args) . " wanted: $num_args)"          if scalar(@args) != $num_args;
+  } else {
+    $num_args *= -1;
+    croak "Parameter count mismatch for $method(actual: " . scalar(@args) . " wanted at least: $num_args)" if scalar(@args) < $num_args;
+    $num_args  = scalar @args;
+  }

 
 

-  if ($num_args) {
-    # Force flattening from SL::Presenter::EscapedText: "" . $...
-    $args[0] =  "" . $args[0];
-    $args[0] =~ s/^\s+//;
+  foreach my $idx (0..$num_args - 1) {
+    # Force flattening from SL::Presenter::EscapedText.
+    $args[$idx] = "" . $args[$idx] if ref($args[$idx]) eq 'SL::Presenter::EscapedText';

   }
 
   }
 

+  # Trim leading whitespaces for certain jQuery functions that operate
+  # on HTML code: $("<p>test</p>").appendTo('#some-id'). jQuery croaks
+  # on leading whitespaces, e.g. on $(" <p>test</p>").
+  $args[0] =~ s{^\s+}{} if $trim_target_for{$method};
+

   push @{ $self->_actions }, [ $method, @args ];
 
   return $self;
   push @{ $self->_actions }, [ $method, @args ];
 
   return $self;


@@ -160,6 +198,8 @@ sub to_array {
 
 sub render {
   my ($self, $controller) = @_;
 
 sub render {
   my ($self, $controller) = @_;

+  $controller ||= $self->controller;
+  $self->reinit_widgets if $::request->presenter->need_reinit_widgets;

   return $controller->render(\$self->to_json, { type => 'json' });
 }
 
   return $controller->render(\$self->to_json, { type => 'json' });
 }
 


@@ -169,6 +209,18 @@ sub jstree {
   return $self;
 }
 
   return $self;
 }
 

+sub dialog {
+  my ($self) = @_;
+  $self->{_prefix} = 'dialog:';
+  return $self;
+}
+
+sub ckeditor {
+  my ($self) = @_;
+  $self->{_prefix} = 'ckeditor:';
+  return $self;
+}
+

 sub flash {
   my ($self, $type, @messages) = @_;
 
 sub flash {
   my ($self, $type, @messages) = @_;
 


@@ -209,12 +261,12 @@ with jQuery
 First some JavaScript code:
 
   // In the client generate an AJAX request whose 'success' handler
 First some JavaScript code:
 
   // In the client generate an AJAX request whose 'success' handler

-  // calls "eval_json_response(data)":
+  // calls "eval_json_result(data)":

   var data = {
     action: "SomeController/the_action",
     id:     $('#some_input_field').val()
   };
   var data = {
     action: "SomeController/the_action",
     id:     $('#some_input_field').val()
   };

-  $.post("controller.pl", data, eval_json_response);
+  $.post("controller.pl", data, eval_json_result);

 
 Now some Perl code:
 
 
 Now some Perl code:
 


@@ -228,7 +280,7 @@ Now some Perl code:
     my ($self) = @_;
 
     # Create a new client-side JS object and do stuff with it!
     my ($self) = @_;
 
     # Create a new client-side JS object and do stuff with it!

-    my $js = SL::ClientJS->new;
+    my $js = SL::ClientJS->new(controller => $self);

 
     # Show some element on the page:
     $js->show('#usually_hidden');
 
     # Show some element on the page:
     $js->show('#usually_hidden');


@@ -246,12 +298,15 @@ Now some Perl code:
     $js->jstree->rename_node('#tb-' . $text_block->id, $text_block->title)
        ->jstree->select_node('#tb-' . $text_block->id);
 
     $js->jstree->rename_node('#tb-' . $text_block->id, $text_block->title)
        ->jstree->select_node('#tb-' . $text_block->id);
 

+    # Close a popup opened by kivi.popup_dialog():
+    $js->dialog->close('#jqueryui_popup_dialog');
+

     # Finally render the JSON response:
     $self->render($js);
 
     # Rendering can also be chained, e.g.
     $js->html('#selector', $html)
     # Finally render the JSON response:
     $self->render($js);
 
     # Rendering can also be chained, e.g.
     $js->html('#selector', $html)

-       ->render($self);
+       ->render;

   }
 
 =head1 OVERVIEW
   }
 
 =head1 OVERVIEW


@@ -270,7 +325,7 @@ There are three things that need to be done for this to work:
 
 =item 1. The "client_js.js" has to be loaded before the AJAX request is started.
 
 
 =item 1. The "client_js.js" has to be loaded before the AJAX request is started.
 

-=item 2. The client code needs to call C<eval_json_response()> with the result returned from the server.
+=item 2. The client code needs to call C<kivi.eval_json_result()> with the result returned from the server.

 
 =item 3. The server must use this module.
 
 
 =item 3. The server must use this module.
 


@@ -301,13 +356,24 @@ are the function parameters.
 Returns the actions gathered so far as a JSON string ready to be sent
 to the client.
 
 Returns the actions gathered so far as a JSON string ready to be sent
 to the client.
 

-=item C<render $controller>
+=item C<render [$controller]>

 
 Renders C<$self> via the controller. Useful for chaining. Equivalent
 to the following:
 
   $controller->render(\$self->to_json, { type => 'json' });
 
 
 Renders C<$self> via the controller. Useful for chaining. Equivalent
 to the following:
 
   $controller->render(\$self->to_json, { type => 'json' });
 

+The controller instance to use can be set during object creation (see
+synopsis) or as an argument to C<render>.
+
+=item C<dialog>
+
+Tells C<$self> that the next action is to be called on a jQuery UI
+dialog instance, e.g. one opened by C<kivi.popup_dialog()>. For
+example:
+
+  $js->dialog->close('#jqueryui_popup_dialog');
+

 =item C<jstree>
 
 Tells C<$self> that the next action is to be called on a jstree
 =item C<jstree>
 
 Tells C<$self> that the next action is to be called on a jstree


@@ -389,8 +455,8 @@ But it is easier to integrate into a method call chain, e.g.:
 Display a C<$message> in the flash of type C<$type>. Multiple calls of
 C<flash> on the same C<$self> will be merged by type.
 
 Display a C<$message> in the flash of type C<$type>. Multiple calls of
 C<flash> on the same C<$self> will be merged by type.
 

-On the client side the flash of this type will be cleared before the
-message is shown.
+On the client side the flashes of all types will be cleared after each
+successful ClientJS call that did not end with C<$js-E<gt>error(...)>.

 
 =item C<error $message>
 
 
 =item C<error $message>
 


@@ -401,6 +467,34 @@ client will then show the message in the 'error' flash.
 The messages of multiple calls of C<error> on the same C<$self> will
 be merged.
 
 The messages of multiple calls of C<error> on the same C<$self> will
 be merged.
 

+=item C<redirect_to $url>
+
+Redirects the browser window to the new URL by setting the JavaScript
+property C<window.location.href>. Note that
+L<SL::Controller::Base/redirect_to> is AJAX aware and uses this
+function if the current request is an AJAX request as determined by
+L<SL::Request/is_ajax>.
+
+=back
+
+=head2 KIVITENDO FUNCTIONS
+
+The following functions from the C<kivi> namespace are supported:
+
+=over 4
+
+=item Displaying stuff
+
+C<flash> (don't call directly, use L</flash> instead)
+
+=item Running functions
+
+C<run>, C<run_once_for>
+
+=item Widgets
+
+C<reinit_widgets>
+

 =back
 
 =head2 JQUERY FUNCTIONS
 =back
 
 =head2 JQUERY FUNCTIONS


@@ -437,6 +531,10 @@ C<replaceAll>, C<replaceWith>
 
 C<attr>, C<prop>, C<removeAttr>, C<removeProp>, C<val>
 
 
 C<attr>, C<prop>, C<removeAttr>, C<removeProp>, C<val>
 

+=item Class attributes
+
+C<addClass>, C<removeClass>, C<toggleClass>
+

 =item Data storage
 
 C<data>, C<removeData>
 =item Data storage
 
 C<data>, C<removeData>


@@ -445,15 +543,56 @@ C<data>, C<removeData>
 
 C<focus>
 
 
 C<focus>
 

+=item Generic Event Handlers
+
+C<on>, C<off>, C<one>
+
+These attach/detach event listeners to specific selectors. The first
+argument is the selector, the second the name of the events and the
+third argument is the name of the handler function. That function must
+already exist when the handler is added.
+

 =back
 
 =back
 

-=head2 JSTREE JQUERY PLUGIN
+=head2 JQUERY POPUP DIALOG PLUGIN
+
+Supported functions of the C<popup dialog> plugin to jQuery. They are
+invoked by first calling C<dialog> in the ClientJS instance and then
+the function itself:

 
 

-The following functions of the C<jstree> plugin to jQuery are
+  $js->dialog->close(...);
+
+=over 4
+
+=item Closing and removing the popup
+
+C<close>
+
+=back
+
+=head2 AJAXFORM JQUERY PLUGIN
+
+The following functions of the C<ajaxForm> plugin to jQuery are

 supported:
 
 =over 4
 
 supported:
 
 =over 4
 

+=item All functions by the generic accessor function:
+
+C<ajaxForm>
+
+=back
+
+=head2 JSTREE JQUERY PLUGIN
+
+Supported functions of the C<jstree> plugin to jQuery. They are
+invoked by first calling C<jstree> in the ClientJS instance and then
+the function itself:
+
+  $js->jstree->open_node(...);
+
+=over 4
+

 =item Operations on the whole tree
 
 C<lock>, C<unlock>
 =item Operations on the whole tree
 
 C<lock>, C<unlock>


@@ -484,7 +623,10 @@ C<js/client_js.js> accordingly. The steps are:
 
 =item 1. Add lines in this file to the C<%supported_methods> hash. The
 key is the function name and the value is the number of expected
 
 =item 1. Add lines in this file to the C<%supported_methods> hash. The
 key is the function name and the value is the number of expected

-parameters.
+parameters. The value can be negative to indicate that the function
+takes at least the absolute of this value as parameters and optionally
+more. In such a case the C<E<lt>ARGSE<gt>> format expands to an actual
+array (and the individual elements if the value is positive>.

 
 =item 2. Run C<scripts/generate_client_js_actions.pl>. It will
 generate C<js/client_js.js> automatically.
 
 =item 2. Run C<scripts/generate_client_js_actions.pl>. It will
 generate C<js/client_js.js> automatically.