L.date_tag: kalenderpicker nicht anzeigen, wenn das Feld readonly ist.
[kivitendo-erp.git] / SL / Template / Plugin / L.pm
index f776af8..8d5b9f6 100644 (file)
@@ -4,6 +4,7 @@ use base qw( Template::Plugin );
 use Template::Plugin;
 use List::MoreUtils qw(apply);
 use List::Util qw(max);
+use Scalar::Util qw(blessed);
 
 use strict;
 
@@ -12,15 +13,26 @@ use strict;
   # Do not use these id's to store information across requests.
 my $_id_sequence = int rand 1e7;
 sub _tag_id {
-  return $_id_sequence = ($_id_sequence + 1) % 1e7;
+  return "id_" . ( $_id_sequence = ($_id_sequence + 1) % 1e7 );
 }
 }
 
+my %_valueless_attributes = map { $_ => 1 } qw(
+  checked compact declare defer disabled ismap multiple noresize noshade nowrap
+  readonly selected
+);
+
 sub _H {
   my $string = shift;
   return $::locale->quote_special_chars('HTML', $string);
 }
 
+sub _J {
+  my $string =  "" . shift;
+  $string    =~ s/\"/\\\"/g;
+  return $string;
+}
+
 sub _hashify {
   return (@_ && (ref($_[0]) eq 'HASH')) ? %{ $_[0] } : @_;
 }
@@ -49,26 +61,25 @@ sub name_to_id {
 }
 
 sub attributes {
-  my $self    = shift;
-  my %options = _hashify(@_);
+  my ($self, @slurp)    = @_;
+  my %options = _hashify(@slurp);
 
   my @result = ();
   while (my ($name, $value) = each %options) {
     next unless $name;
+    next if $_valueless_attributes{$name} && !$value;
     $value = '' if !defined($value);
-    push @result, _H($name) . '="' . _H($value) . '"';
+    push @result, $_valueless_attributes{$name} ? _H($name) : _H($name) . '="' . _H($value) . '"';
   }
 
   return @result ? ' ' . join(' ', @result) : '';
 }
 
 sub html_tag {
-  my $self       = shift;
-  my $tag        = shift;
-  my $content    = shift;
-  my $attributes = $self->attributes(@_);
+  my ($self, $tag, $content, @slurp) = @_;
+  my $attributes = $self->attributes(@slurp);
 
-  return "<${tag}${attributes}/>" unless defined($content);
+  return "<${tag}${attributes}>" unless defined($content);
   return "<${tag}${attributes}>${content}</${tag}>";
 }
 
@@ -89,19 +100,21 @@ sub textarea_tag {
   my %attributes      = _hashify(@slurp);
 
   $attributes{id}   ||= $self->name_to_id($name);
+  $attributes{rows}  *= 1; # required by standard
+  $attributes{cols}  *= 1; # required by standard
   $content            = $content ? _H($content) : '';
 
   return $self->html_tag('textarea', $content, %attributes, name => $name);
 }
 
 sub checkbox_tag {
-  my $self             = shift;
-  my $name             = shift;
-  my %attributes       = _hashify(@_);
+  my ($self, $name, @slurp) = @_;
+  my %attributes       = _hashify(@slurp);
 
   $attributes{id}    ||= $self->name_to_id($name);
   $attributes{value}   = 1 unless defined $attributes{value};
   my $label            = delete $attributes{label};
+  my $checkall         = delete $attributes{checkall};
 
   if ($attributes{checked}) {
     $attributes{checked} = 'checked';
@@ -111,6 +124,7 @@ sub checkbox_tag {
 
   my $code  = $self->html_tag('input', undef,  %attributes, name => $name, type => 'checkbox');
   $code    .= $self->html_tag('label', $label, for => $attributes{id}) if $label;
+  $code    .= $self->javascript(qq|\$('#$attributes{id}').checkall('$checkall');|) if $checkall;
 
   return $code;
 }
@@ -187,7 +201,10 @@ sub button_tag {
   my ($self, $onclick, $value, @slurp) = @_;
   my %attributes = _hashify(@slurp);
 
-  return $self->input_tag(undef, $value, %attributes, type => 'button', onclick => $onclick);
+  $attributes{id}   ||= $self->name_to_id($attributes{name}) if $attributes{name};
+  $attributes{type} ||= 'button';
+
+  return $self->html_tag('input', undef, %attributes, value => $value, onclick => $onclick);
 }
 
 sub options_for_select {
@@ -203,7 +220,7 @@ sub options_for_select {
 
   my $value_title_sub = $options{value_title_sub};
 
-  my %selected        = map { ( $_ => 1 ) } @{ ref($options{default}) eq 'ARRAY' ? $options{default} : $options{default} ? [ $options{default} ] : [] };
+  my %selected        = map { ( $_ => 1 ) } @{ ref($options{default}) eq 'ARRAY' ? $options{default} : defined($options{default}) ? [ $options{default} ] : [] };
 
   my $access = sub {
     my ($element, $index, $key, $sub) = @_;
@@ -218,7 +235,7 @@ sub options_for_select {
   my @elements = ();
   push @elements, [ undef, $options{empty_title} || '' ] if $options{with_empty};
   push @elements, map [
-    $value_title_sub ? $value_title_sub->($_) : (
+    $value_title_sub ? @{ $value_title_sub->($_) } : (
       $access->($_, 0, $value_key, $value_sub),
       $access->($_, 1, $title_key, $title_sub),
     )
@@ -227,7 +244,7 @@ sub options_for_select {
   my $code = '';
   foreach my $result (@elements) {
     my %attributes = ( value => $result->[0] );
-    $attributes{selected} = 'selected' if $selected{ $result->[0] || '' };
+    $attributes{selected} = 'selected' if $selected{ defined($result->[0]) ? $result->[0] : '' };
 
     $code .= $self->html_tag('option', _H($result->[1]), %attributes);
   }
@@ -265,24 +282,65 @@ sub date_tag {
     s/y+/\%Y/gi;
   } $::myconfig{"dateformat"};
 
-  $params{cal_align} ||= 'BR';
+  my $cal_align = delete $params{cal_align} || 'BR';
+  my $onchange  = delete $params{onchange};
+  my $str_value = blessed $value ? $value->to_lxoffice : $value;
 
-  $self->input_tag($name, $value,
+  $self->input_tag($name, $str_value,
     id     => $name_e,
     size   => 11,
     title  => _H($::myconfig{dateformat}),
     onBlur => 'check_right_date_format(this)',
+    ($onchange ? (
+    onChange => $onchange,
+    ) : ()),
     %params,
-  ) . ((!$params{no_cal}) ?
+  ) . ((!$params{no_cal} && !$params{readonly}) ?
   $self->html_tag('img', undef,
     src    => 'image/calendar.png',
+    alt    => $::locale->text('Calendar'),
     id     => "trigger$seq",
     title  => _H($::myconfig{dateformat}),
     %params,
   ) .
   $self->javascript(
-    "Calendar.setup({ inputField: '$name_e', ifFormat: '$datefmt', align: '$params{cal_align}', button: 'trigger$seq' });"
+    "Calendar.setup({ inputField: '$name_e', ifFormat: '$datefmt', align: '$cal_align', button: 'trigger$seq' });"
   ) : '');
+}
+
+sub customer_picker {
+  my ($self, $name, $value, %params) = @_;
+  my $name_e    = _H($name);
+
+  $self->hidden_tag($name, (ref $value && $value->can('id')) ? $value->id : '') .
+  $self->input_tag("$name_e\_name", (ref $value && $value->can('name')) ? $value->name : '', %params) .
+  $self->javascript(<<JS);
+function autocomplete_customer (selector, column) {
+  \$(function(){ \$(selector).autocomplete({
+    source: function(req, rsp) {
+      \$.ajax({
+        url: 'controller.pl?action=Customer/ajax_autocomplete',
+        dataType: "json",
+        data: {
+          column: column,
+          term: req.term,
+          current: function() { \$('#$name_e').val() },
+          obsolete: 0,
+        },
+        success: function (data){ rsp(data) }
+      });
+    },
+    limit: 20,
+    delay: 50,
+    select: function(event, ui) {
+      \$('#$name_e').val(ui.item.id);
+      \$('#$name_e\_name').val(ui.item.name);
+    },
+  })});
+}
+autocomplete_customer('#$name_e\_name');
+JS
+}
 
 sub javascript_tag {
   my $self = shift;
@@ -301,7 +359,7 @@ sub javascript_tag {
 sub tabbed {
   my ($self, $tabs, @slurp) = @_;
   my %params   = _hashify(@slurp);
-  my $id       = 'tab_' . _tag_id();
+  my $id       = $params{id} || 'tab_' . _tag_id();
 
   $params{selected} *= 1;
 
@@ -315,7 +373,7 @@ sub tabbed {
     next if $tab eq '';
 
     my $selected = $params{selected} == $i;
-    my $tab_id = _tag_id();
+    my $tab_id   = "__tab_id_$i";
     push @header, $self->li_tag(
       $self->link('', $tab->{name}, rel => $tab_id),
         ($selected ? (class => 'selected') : ())
@@ -371,6 +429,102 @@ sub areainput_tag {
     : $self->input_tag($name, $value, %attributes);
 }
 
+sub multiselect2side {
+  my ($self, $id, @slurp) = @_;
+  my %params              = _hashify(@slurp);
+
+  $params{labelsx}        = "\"" . _J($params{labelsx} || $::locale->text('Available')) . "\"";
+  $params{labeldx}        = "\"" . _J($params{labeldx} || $::locale->text('Selected'))  . "\"";
+  $params{moveOptions}    = 'false';
+
+  my $vars                = join(', ', map { "${_}: " . $params{$_} } keys %params);
+  my $code                = <<EOCODE;
+<script type="text/javascript">
+  \$().ready(function() {
+    \$('#${id}').multiselect2side({ ${vars} });
+  });
+</script>
+EOCODE
+
+  return $code;
+}
+
+sub sortable_element {
+  my ($self, $selector, @slurp) = @_;
+  my %params                    = _hashify(@slurp);
+
+  my %attributes = ( distance => 5,
+                     helper   => <<'JAVASCRIPT' );
+    function(event, ui) {
+      ui.children().each(function() {
+        $(this).width($(this).width());
+      });
+      return ui;
+    }
+JAVASCRIPT
+
+  my $stop_event = '';
+
+  if ($params{url} && $params{with}) {
+    my $as      = $params{as} || $params{with};
+    my $filter  = ".filter(function(idx) { return this.substr(0, " . length($params{with}) . ") == '$params{with}'; })";
+    $filter    .= ".map(function(idx, str) { return str.replace('$params{with}_', ''); })";
+
+    $stop_event = <<JAVASCRIPT;
+        \$.post('$params{url}', { '${as}[]': \$(\$('${selector}').sortable('toArray'))${filter}.toArray() });
+JAVASCRIPT
+  }
+
+  if (!$params{dont_recolor}) {
+    $stop_event .= <<JAVASCRIPT;
+        \$('${selector}>*:odd').removeClass('listrow1').removeClass('listrow0').addClass('listrow0');
+        \$('${selector}>*:even').removeClass('listrow1').removeClass('listrow0').addClass('listrow1');
+JAVASCRIPT
+  }
+
+  if ($stop_event) {
+    $attributes{stop} = <<JAVASCRIPT;
+      function(event, ui) {
+        ${stop_event}
+        return ui;
+      }
+JAVASCRIPT
+  }
+
+  $params{handle}     = '.dragdrop' unless exists $params{handle};
+  $attributes{handle} = "'$params{handle}'" if $params{handle};
+
+  my $attr_str = join(', ', map { "${_}: $attributes{$_}" } keys %attributes);
+
+  my $code = <<JAVASCRIPT;
+<script type="text/javascript">
+  \$(function() {
+    \$( "${selector}" ).sortable({ ${attr_str} })
+  });
+</script>
+JAVASCRIPT
+
+  return $code;
+}
+
+sub online_help_tag {
+  my ($self, $tag, @slurp) = @_;
+  my %params               = _hashify(@slurp);
+  my $cc                   = $::myconfig{countrycode};
+  my $file                 = "doc/online/$cc/$tag.html";
+  my $text                 = $params{text} || $::locale->text('Help');
+
+  die 'malformed help tag' unless $tag =~ /^[a-zA-Z0-9_]+$/;
+  return unless -f $file;
+  return $self->html_tag('a', $text, href => $file, class => 'jqModal')
+}
+
+sub dump {
+  my $self = shift;
+  require Data::Dumper;
+  return '<pre>' . Data::Dumper::Dumper(@_) . '</pre>';
+}
+
 1;
 
 __END__
@@ -477,6 +631,10 @@ If C<%attributes> contains a key C<label> then a HTML 'label' tag is
 created with said C<label>. No attribute named C<label> is created in
 that case.
 
+If C<%attributes> contains a key C<checkall> then the value is taken as a
+JQuery selector and clicking this checkbox will also toggle all checkboxes
+matching the selector.
+
 =item C<date_tag $name, $value, cal_align =E<gt> $align_code, %attributes>
 
 Creates a date input field, with an attached javascript that will open a
@@ -539,6 +697,108 @@ include C<min_rows> for rendering a minimum of rows if a textarea is displayed.
 You can force input by setting rows to 1, and you can force textarea by setting
 rows to anything >1.
 
+=item C<multiselect2side $id, %params>
+
+Creates a JavaScript snippet calling the jQuery function
+C<multiselect2side> on the select control with the ID C<$id>. The
+select itself is not created. C<%params> can contain the following
+entries:
+
+=over 2
+
+=item C<labelsx>
+
+The label of the list of available options. Defaults to the
+translation of 'Available'.
+
+=item C<labeldx>
+
+The label of the list of selected options. Defaults to the
+translation of 'Selected'.
+
+=back
+
+=item C<sortable_element $selector, %params>
+
+Makes the children of the DOM element C<$selector> (a jQuery selector)
+sortable with the I<jQuery UI Selectable> library. The children can be
+dragged & dropped around. After dropping an element an URL can be
+postet to with the element IDs of the sorted children.
+
+If this is used then the JavaScript file C<js/jquery-ui.js> must be
+included manually as well as it isn't loaded via C<$::form-gt;header>.
+
+C<%params> can contain the following entries:
+
+=over 2
+
+=item C<url>
+
+The URL to POST an AJAX request to after a dragged element has been
+dropped. The AJAX request's return value is ignored. If given then
+C<$params{with}> must be given as well.
+
+=item C<with>
+
+A string that is interpreted as the prefix of the children's ID. Upon
+POSTing the result each child whose ID starts with C<$params{with}> is
+considered. The prefix and the following "_" is removed from the
+ID. The remaining parts of the IDs of those children are posted as a
+single array parameter. The array parameter's name is either
+C<$params{as}> or, missing that, C<$params{with}>.
+
+=item C<as>
+
+Sets the POST parameter name for AJAX request after dropping an
+element (see C<$params{with}>).
+
+=item C<handle>
+
+An optional jQuery selector specifying which part of the child element
+is dragable. If the parameter is not given then it defaults to
+C<.dragdrop> matching DOM elements with the class C<dragdrop>.  If the
+parameter is set and empty then the whole child element is dragable,
+and clicks through to underlying elements like inputs or links might
+not work.
+
+=item C<dont_recolor>
+
+If trueish then the children will not be recolored. The default is to
+recolor the children by setting the class C<listrow0> on odd and
+C<listrow1> on even entries.
+
+=back
+
+Example:
+
+  <script type="text/javascript" src="js/jquery-ui.js"></script>
+
+  <table id="thing_list">
+    <thead>
+      <tr><td>This</td><td>That</td></tr>
+    </thead>
+    <tbody>
+      <tr id="thingy_2"><td>stuff</td><td>more stuff</td></tr>
+      <tr id="thingy_15"><td>stuff</td><td>more stuff</td></tr>
+      <tr id="thingy_6"><td>stuff</td><td>more stuff</td></tr>
+    </tbody>
+  <table>
+
+  [% L.sortable_element('#thing_list tbody',
+                        url          => 'controller.pl?action=SystemThings/reorder',
+                        with         => 'thingy',
+                        as           => 'thing_ids',
+                        recolor_rows => 1) %]
+
+After dropping e.g. the third element at the top of the list a POST
+request would be made to the C<reorder> action of the C<SystemThings>
+controller with a single parameter called C<thing_ids> -- an array
+containing the values C<[ 6, 2, 15 ]>.
+
+=item C<dump REF>
+
+Dumps the Argument using L<Data::Dumper> into a E<lt>preE<gt> block.
+
 =back
 
 =head2 CONVERSION FUNCTIONS