use base qw( Template::Plugin );
use Template::Plugin;
+use Data::Dumper;
use List::MoreUtils qw(apply);
use List::Util qw(max);
use Scalar::Util qw(blessed);
+use SL::Presenter;
+use SL::Presenter::ALL;
+use SL::Presenter::Simple;
+use SL::Util qw(_hashify);
+
use strict;
{ # This will give you an id for identifying html tags and such.
}
}
-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;
+ my $string = shift;
+ $string =~ s/(\"|\'|\\)/\\$1/g;
return $string;
}
-sub _hashify {
- return (@_ && (ref($_[0]) eq 'HASH')) ? %{ $_[0] } : @_;
-}
-
sub new {
my ($class, $context, @args) = @_;
return $_[0]->{CONTEXT};
}
-sub name_to_id {
- my $self = shift;
- my $name = shift;
+sub _call_presenter {
+ my ($method, $self, @args) = @_;
- $name =~ s/[^\w_]/_/g;
- $name =~ s/_+/_/g;
+ my $presenter = $::request->presenter;
- return $name;
-}
+ splice @args, -1, 1, %{ $args[-1] } if @args && (ref($args[-1]) eq 'HASH');
-sub attributes {
- 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, $_valueless_attributes{$name} ? _H($name) : _H($name) . '="' . _H($value) . '"';
+ if (my $sub = SL::Presenter::Simple->can($method)) {
+ return $sub->(@args);
}
- return @result ? ' ' . join(' ', @result) : '';
-}
-
-sub html_tag {
- my ($self, $tag, $content, @slurp) = @_;
- my $attributes = $self->attributes(@slurp);
-
- return "<${tag}${attributes}>" unless defined($content);
- return "<${tag}${attributes}>${content}</${tag}>";
-}
-
-sub select_tag {
- my $self = shift;
- my $name = shift;
- my $options_str = shift;
- my %attributes = _hashify(@_);
-
- $attributes{id} ||= $self->name_to_id($name);
- $options_str = $self->options_for_select($options_str) if ref $options_str;
-
- return $self->html_tag('select', $options_str, %attributes, name => $name);
-}
-
-sub textarea_tag {
- my ($self, $name, $content, @slurp) = @_;
- 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, $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';
- } else {
- delete $attributes{checked};
- }
-
- 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;
-}
-
-sub radio_button_tag {
- my $self = shift;
- my $name = shift;
- my %attributes = _hashify(@_);
-
- $attributes{value} = 1 unless defined $attributes{value};
- $attributes{id} ||= $self->name_to_id($name . "_" . $attributes{value});
- my $label = delete $attributes{label};
-
- if ($attributes{checked}) {
- $attributes{checked} = 'checked';
- } else {
- delete $attributes{checked};
+ if ($presenter->can($method)) {
+ return $presenter->$method(@args);
}
- my $code = $self->html_tag('input', undef, %attributes, name => $name, type => 'radio');
- $code .= $self->html_tag('label', $label, for => $attributes{id}) if $label;
-
- return $code;
-}
-
-sub input_tag {
- my ($self, $name, $value, @slurp) = @_;
- my %attributes = _hashify(@slurp);
-
- $attributes{id} ||= $self->name_to_id($name);
- $attributes{type} ||= 'text';
-
- return $self->html_tag('input', undef, %attributes, name => $name, value => $value);
-}
-
-sub hidden_tag {
- return shift->input_tag(@_, type => 'hidden');
-}
-
-sub div_tag {
- my ($self, $content, @slurp) = @_;
- return $self->html_tag('div', $content, @slurp);
+ $::lxdebug->message(LXDebug::WARN(), "SL::Presenter has no method named '$method'!");
+ return;
+}
+
+sub name_to_id { return _call_presenter('name_to_id', @_); }
+sub html_tag { return _call_presenter('html_tag', @_); }
+sub hidden_tag { return _call_presenter('hidden_tag', @_); }
+sub select_tag { return _call_presenter('select_tag', @_); }
+sub checkbox_tag { return _call_presenter('checkbox_tag', @_); }
+sub input_tag { return _call_presenter('input_tag', @_); }
+sub javascript { return _call_presenter('javascript', @_); }
+sub truncate { return _call_presenter('truncate', @_); }
+sub simple_format { return _call_presenter('simple_format', @_); }
+sub button_tag { return _call_presenter('button_tag', @_); }
+sub submit_tag { return _call_presenter('submit_tag', @_); }
+sub ajax_submit_tag { return _call_presenter('ajax_submit_tag', @_); }
+sub link { return _call_presenter('link_tag', @_); }
+sub input_number_tag { return _call_presenter('input_number_tag', @_); }
+sub textarea_tag { return _call_presenter('textarea_tag', @_); }
+sub date_tag { return _call_presenter('date_tag', @_); }
+sub div_tag { return _call_presenter('div_tag', @_); }
+sub radio_button_tag { return _call_presenter('radio_button_tag', @_); }
+sub img_tag { return _call_presenter('img_tag', @_); }
+sub restricted_html { return _call_presenter('restricted_html', @_); }
+sub stripped_html { return _call_presenter('stripped_html', @_); }
+
+sub _set_id_attribute {
+ my ($attributes, $name, $unique) = @_;
+ SL::Presenter::Tag::_set_id_attribute($attributes, $name, $unique);
}
sub ul_tag {
return $self->html_tag('li', $content, @slurp);
}
-sub link {
- my ($self, $href, $content, @slurp) = @_;
- my %params = _hashify(@slurp);
-
- $href ||= '#';
-
- return $self->html_tag('a', $content, %params, href => $href);
-}
-
-sub submit_tag {
- my ($self, $name, $value, @slurp) = @_;
- my %attributes = _hashify(@slurp);
-
- $attributes{onclick} = "if (confirm('" . delete($attributes{confirm}) . "')) return true; else return false;" if $attributes{confirm};
-
- return $self->input_tag($name, $value, %attributes, type => 'submit', class => 'submit');
-}
-
-sub button_tag {
- my ($self, $onclick, $value, @slurp) = @_;
- my %attributes = _hashify(@slurp);
-
- $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 {
- my $self = shift;
- my $collection = shift;
- my %options = _hashify(@_);
-
- my $value_key = $options{value} || 'id';
- my $title_key = $options{title} || $value_key;
-
- my $value_sub = $options{value_sub};
- my $title_sub = $options{title_sub};
-
- my $value_title_sub = $options{value_title_sub};
-
- my %selected = map { ( $_ => 1 ) } @{ ref($options{default}) eq 'ARRAY' ? $options{default} : defined($options{default}) ? [ $options{default} ] : [] };
-
- my $access = sub {
- my ($element, $index, $key, $sub) = @_;
- my $ref = ref $element;
- return $sub ? $sub->($element)
- : !$ref ? $element
- : $ref eq 'ARRAY' ? $element->[$index]
- : $ref eq 'HASH' ? $element->{$key}
- : $element->$key;
- };
-
- my @elements = ();
- push @elements, [ undef, $options{empty_title} || '' ] if $options{with_empty};
- push @elements, map [
- $value_title_sub ? @{ $value_title_sub->($_) } : (
- $access->($_, 0, $value_key, $value_sub),
- $access->($_, 1, $title_key, $title_sub),
- )
- ], @{ $collection } if $collection && ref $collection eq 'ARRAY';
-
- my $code = '';
- foreach my $result (@elements) {
- my %attributes = ( value => $result->[0] );
- $attributes{selected} = 'selected' if $selected{ defined($result->[0]) ? $result->[0] : '' };
-
- $code .= $self->html_tag('option', _H($result->[1]), %attributes);
- }
-
- return $code;
-}
-
sub yes_no_tag {
- my ($self, $name, $value) = splice @_, 0, 3;
- my %attributes = _hashify(@_);
-
- my $options = $self->options_for_select([ [ 1, $::locale->text('Yes') ], [ 0, $::locale->text('No') ] ], default => $value ? 1 : 0);
- return $self->select_tag($name, $options, %attributes);
-}
+ my ($self, $name, $value, %attributes) = _hashify(3, @_);
-sub javascript {
- my ($self, $data) = @_;
- return $self->html_tag('script', $data, type => 'text/javascript');
+ return $self->select_tag($name, [ [ 1 => $::locale->text('Yes') ], [ 0 => $::locale->text('No') ] ], default => $value ? 1 : 0, %attributes);
}
sub stylesheet_tag {
return $code;
}
-sub date_tag {
- my ($self, $name, $value, @slurp) = @_;
- my %params = _hashify(@slurp);
- my $name_e = _H($name);
- my $seq = _tag_id();
- my $datefmt = apply {
- s/d+/\%d/gi;
- s/m+/\%m/gi;
- s/y+/\%Y/gi;
- } $::myconfig{"dateformat"};
-
- 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, $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{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: '$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
-}
# simple version with select_tag
sub vendor_selector {
- my ($self, $name, $value, %params) = @_;
+ my ($self, $name, $value, %params) = _hashify(3, @_);
my $actual_vendor_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"}) ? $::form->{"$name"}->id : $::form->{"$name"}) :
(ref $value && $value->can('id')) ? $value->id : '';
- my $options_str = $self->options_for_select(SL::DB::Manager::Vendor->get_all(),
- default => $actual_vendor_id,
- title_sub => sub { $_[0]->vendornumber . " : " . $_[0]->name },
- 'with_empty' => 1);
- return $self->select_tag($name, $options_str, %params);
+ return $self->select_tag($name, SL::DB::Manager::Vendor->get_all(),
+ default => $actual_vendor_id,
+ title_sub => sub { $_[0]->vendornumber . " : " . $_[0]->name },
+ 'with_empty' => 1,
+ %params);
}
# simple version with select_tag
sub part_selector {
- my ($self, $name, $value, %params) = @_;
+ my ($self, $name, $value, %params) = _hashify(3, @_);
my $actual_part_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"})? $::form->{"$name"}->id : $::form->{"$name"}) :
(ref $value && $value->can('id')) ? $value->id : '';
- my $options_str = $self->options_for_select(SL::DB::Manager::Part->get_all(),
- default => $actual_part_id,
- title_sub => sub { $_[0]->partnumber . " : " . $_[0]->description },
- 'with_empty' => 1);
- return $self->select_tag($name, $options_str, %params);
+ return $self->select_tag($name, SL::DB::Manager::Part->get_all(),
+ default => $actual_part_id,
+ title_sub => sub { $_[0]->partnumber . " : " . $_[0]->description },
+ with_empty => 1,
+ %params);
}
}
sub tabbed {
- my ($self, $tabs, @slurp) = @_;
- my %params = _hashify(@slurp);
+ my ($self, $tabs, %params) = _hashify(2, @_);
my $id = $params{id} || 'tab_' . _tag_id();
$params{selected} *= 1;
next if $tab eq '';
- my $selected = $params{selected} == $i;
- my $tab_id = "__tab_id_$i";
- push @header, $self->li_tag(
- $self->link('', $tab->{name}, rel => $tab_id),
- ($selected ? (class => 'selected') : ())
- );
- push @blocks, $self->div_tag($tab->{data},
- id => $tab_id, class => 'tabcontent');
+ my $tab_id = "__tab_id_$i";
+ push @header, $self->li_tag($self->link('#' . $tab_id, $tab->{name}));
+ push @blocks, $self->div_tag($tab->{data}, id => $tab_id);
}
return '' unless @header;
- return $self->ul_tag(
- join('', @header), id => $id, class => 'shadetabs'
- ) .
- $self->div_tag(
- join('', @blocks), class => 'tabcontentstyle'
- ) .
- $self->javascript(
- qq|var $id = new ddtabcontent("$id");$id.setpersist(true);| .
- qq|$id.setselectedClassTarget("link");$id.init();|
- );
+
+ my $ul = $self->ul_tag(join('', @header), id => $id);
+ return $self->div_tag(join('', $ul, @blocks), class => 'tabwidget');
}
sub tab {
- my ($self, $name, $src, @slurp) = @_;
- my %params = _hashify(@slurp);
+ my ($self, $name, $src, %params) = _hashify(3, @_);
$params{method} ||= 'process';
}
sub areainput_tag {
- my ($self, $name, $value, @slurp) = @_;
- my %attributes = _hashify(@slurp);
+ my ($self, $name, $value, %attributes) = _hashify(3, @_);
- my ($rows, $cols);
- my $min = delete $attributes{min_rows} || 1;
+ my $cols = delete $attributes{cols} || delete $attributes{size};
+ my $minrows = delete $attributes{min_rows} || 1;
+ my $maxrows = delete $attributes{max_rows};
+ my $rows = $::form->numtextrows($value, $cols, $maxrows, $minrows);
- if (exists $attributes{cols}) {
- $cols = delete $attributes{cols};
- $rows = $::form->numtextrows($value, $cols);
- } else {
- $rows = delete $attributes{rows} || 1;
- }
+ $attributes{id} ||= _tag_id();
+ my $id = $attributes{id};
- return $rows > 1
- ? $self->textarea_tag($name, $value, %attributes, rows => max($rows, $min), ($cols ? (cols => $cols) : ()))
- : $self->input_tag($name, $value, %attributes, ($cols ? (size => $cols) : ()));
+ return $self->textarea_tag($name, $value, %attributes, rows => $rows, cols => $cols) if $rows > 1;
+
+ return '<span>'
+ . $self->input_tag($name, $value, %attributes, size => $cols)
+ . "<img src=\"image/edit-entry.png\" onclick=\"kivi.switch_areainput_to_textarea('${id}')\" style=\"margin-left: 2px;\">"
+ . '</span>';
}
sub multiselect2side {
- my ($self, $id, @slurp) = @_;
- my %params = _hashify(@slurp);
+ my ($self, $id, %params) = _hashify(2, @_);
$params{labelsx} = "\"" . _J($params{labelsx} || $::locale->text('Available')) . "\"";
$params{labeldx} = "\"" . _J($params{labeldx} || $::locale->text('Selected')) . "\"";
}
sub sortable_element {
- my ($self, $selector, @slurp) = @_;
- my %params = _hashify(@slurp);
+ my ($self, $selector, %params) = _hashify(2, @_);
my %attributes = ( distance => 5,
helper => <<'JAVASCRIPT' );
my $filter = ".filter(function(idx) { return this.substr(0, " . length($params{with}) . ") == '$params{with}'; })";
$filter .= ".map(function(idx, str) { return str.replace('$params{with}_', ''); })";
+ my $params_js = $params{params} ? qq| + ($params{params})| : '';
+ my $ajax_return = '';
+ if ($params{ajax_return}) {
+ $ajax_return = 'kivi.eval_json_result';
+ }
+
$stop_event = <<JAVASCRIPT;
- \$.post('$params{url}', { '${as}[]': \$(\$('${selector}').sortable('toArray'))${filter}.toArray() });
+ \$.post('$params{url}'${params_js}, { '${as}[]': \$(\$('${selector}').sortable('toArray'))${filter}.toArray() }, $ajax_return);
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>';
}
-sub truncate {
- my ($self, $text, @slurp) = @_;
- my %params = _hashify(@slurp);
-
- $params{at} ||= 50;
- $params{at} = 3 if 3 > $params{at};
- $params{at} -= 3;
-
- return $text if length($text) < $params{at};
- return substr($text, 0, $params{at}) . '...';
-}
-
sub sortable_table_header {
- my ($self, $by, @slurp) = @_;
- my %params = _hashify(@slurp);
+ my ($self, $by, %params) = _hashify(2, @_);
my $controller = $self->{CONTEXT}->stash->get('SELF');
- my $sort_spec = $controller->get_sort_spec;
+ my $models = $params{models} || $self->{CONTEXT}->stash->get('MODELS');
+ my $sort_spec = $models->get_sort_spec;
my $by_spec = $sort_spec->{$by};
- my %current_sort_params = $controller->get_current_sort_params;
+ my %current_sort_params = $models->get_current_sort_params;
my ($image, $new_dir) = ('', $current_sort_params{dir});
- my $title = delete($params{title}) || $by_spec->{title};
+ my $title = delete($params{title}) || $::locale->text($by_spec->{title});
- if ($current_sort_params{by} eq $by) {
- my $current_dir = $current_sort_params{dir} ? 'up' : 'down';
+ if ($current_sort_params{sort_by} eq $by) {
+ my $current_dir = $current_sort_params{sort_dir} ? 'up' : 'down';
$image = '<img border="0" src="image/' . $current_dir . '.png">';
- $new_dir = 1 - ($current_sort_params{dir} || 0);
+ $new_dir = 1 - ($current_sort_params{sort_dir} || 0);
}
- $params{ $sort_spec->{FORM_PARAMS}->[0] } = $by;
- $params{ $sort_spec->{FORM_PARAMS}->[1] } = ($new_dir ? '1' : '0');
+ $params{ $models->sorted->form_params->[0] } = $by;
+ $params{ $models->sorted->form_params->[1] } = ($new_dir ? '1' : '0');
+
+ return '<a href="' . $models->get_callback(%params) . '">' . _H($title) . $image . '</a>';
+}
+
+sub paginate_controls {
+ my ($self, %params) = _hashify(1, @_);
+
+ my $controller = $self->{CONTEXT}->stash->get('SELF');
+ my $models = $params{models} || $self->{CONTEXT}->stash->get('MODELS');
+ my $pager = $models->paginated;
+# my $paginate_spec = $controller->get_paginate_spec;
+
+ my %paginate_params = $models->get_paginate_args;
+
+ my %template_params = (
+ pages => \%paginate_params,
+ url_maker => sub {
+ my %url_params = _hashify(0, @_);
+ $url_params{ $pager->form_params->[0] } = delete $url_params{page};
+ $url_params{ $pager->form_params->[1] } = delete $url_params{per_page} if exists $url_params{per_page};
+
+ return $models->get_callback(%url_params);
+ },
+ %params,
+ );
- return '<a href="' . $controller->get_callback(%params) . '">' . _H($title) . $image . '</a>';
+ return SL::Presenter->get->render('common/paginate', %template_params);
}
1;
[% USE L %]
- [% L.select_tag('direction', [ [ 'left', 'To the left' ], [ 'right', 'To the right' ] ]) %]
+ [% L.select_tag('direction', [ [ 'left', 'To the left' ], [ 'right', 'To the right', 1 ] ]) %]
- [% L.select_tag('direction', L.options_for_select([ { direction => 'left', display => 'To the left' },
- { direction => 'right', display => 'To the right' } ],
- value => 'direction', title => 'display', default => 'right')) %]
+ [% L.select_tag('direction', [ { direction => 'left', display => 'To the left' },
+ { direction => 'right', display => 'To the right' } ],
+ value_key => 'direction', title_key => 'display', default => 'right')) %]
+
+ [% L.select_tag('direction', [ { direction => 'left', display => 'To the left' },
+ { direction => 'right', display => 'To the right', selected => 1 } ],
+ value_key => 'direction', title_key => 'display')) %]
=head1 DESCRIPTION
A module modeled a bit after Rails' ActionView helpers. Several small
functions that create HTML tags from various kinds of data sources.
+The C<id> attribute is usually calculated automatically. This can be
+overridden by either specifying an C<id> attribute or by setting
+C<no_id> to trueish.
+
=head1 FUNCTIONS
=head2 LOW-LEVEL FUNCTIONS
-=over 4
-
-=item C<name_to_id $name>
-
-Converts a name to a HTML id by replacing various characters.
+The following items are just forwarded to L<SL::Presenter::Tag>:
-=item C<attributes %items>
-
-Creates a string from all elements in C<%items> suitable for usage as
-HTML tag attributes. Keys and values are HTML escaped even though keys
-must not contain non-ASCII characters for browsers to accept them.
+=over 2
-=item C<html_tag $tag_name, $content_string, %attributes>
+=item * C<name_to_id $name>
-Creates an opening and closing HTML tag for C<$tag_name> and puts
-C<$content_string> between the two. If C<$content_string> is undefined
-or empty then only a E<lt>tag/E<gt> tag will be created. Attributes
-are key/value pairs added to the opening tag.
+=item * C<stringify_attributes %items>
-C<$content_string> is not HTML escaped.
+=item * C<html_tag $tag_name, $content_string, %attributes>
=back
=head2 HIGH-LEVEL FUNCTIONS
-=over 4
+The following functions are just forwarded to L<SL::Presenter::Tag>:
-=item C<select_tag $name, $options_string, %attributes>
+=over 2
-Creates a HTML 'select' tag named C<$name> with the contents
-C<$options_string> and with arbitrary HTML attributes from
-C<%attributes>. The tag's C<id> defaults to C<name_to_id($name)>.
+=item * C<input_tag $name, $value, %attributes>
-The C<$options_string> is usually created by the
-L</options_for_select> function. If C<$options_string> is an array
-reference then it will be passed to L</options_for_select>
-automatically.
+=item * C<hidden_tag $name, $value, %attributes>
-=item C<yes_no_tag $name, $value, %attributes>
-
-Creates a HTML 'select' tag with the two entries C<yes> and C<no> by
-calling L<select_tag> and L<options_for_select>. C<$value> determines
-which entry is selected. The C<%attributes> are passed through to
-L<select_tag>.
+=item * C<checkbox_tag $name, %attributes>
-=item C<input_tag $name, $value, %attributes>
+=item * C<select_tag $name, \@collection, %attributes>
-Creates a HTML 'input type=text' tag named C<$name> with the value
-C<$value> and with arbitrary HTML attributes from C<%attributes>. The
-tag's C<id> defaults to C<name_to_id($name)>.
+=item * C<link $href, $content, %attributes>
-=item C<hidden_tag $name, $value, %attributes>
+=back
-Creates a HTML 'input type=hidden' tag named C<$name> with the value
-C<$value> and with arbitrary HTML attributes from C<%attributes>. The
-tag's C<id> defaults to C<name_to_id($name)>.
+Available high-level functions implemented in this module:
-=item C<submit_tag $name, $value, %attributes>
+=over 4
-Creates a HTML 'input type=submit class=submit' tag named C<$name> with the
-value C<$value> and with arbitrary HTML attributes from C<%attributes>. The
-tag's C<id> defaults to C<name_to_id($name)>.
+=item C<yes_no_tag $name, $value, %attributes>
-If C<$attributes{confirm}> is set then a JavaScript popup dialog will
-be added via the C<onclick> handler asking the question given with
-C<$attributes{confirm}>. If request is only submitted if the user
-clicks the dialog's ok/yes button.
+Creates a HTML 'select' tag with the two entries C<yes> and C<no> by
+calling L<select_tag>. C<$value> determines
+which entry is selected. The C<%attributes> are passed through to
+L<select_tag>.
=item C<textarea_tag $name, $value, %attributes>
C<$value> and with arbitrary HTML attributes from C<%attributes>. The
tag's C<id> defaults to C<name_to_id($name)>.
-=item C<checkbox_tag $name, %attributes>
-
-Creates a HTML 'input type=checkbox' tag named C<$name> with arbitrary
-HTML attributes from C<%attributes>. The tag's C<id> defaults to
-C<name_to_id($name)>. The tag's C<value> defaults to C<1>.
-
-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>
+=item C<date_tag $name, $value, %attributes>
Creates a date input field, with an attached javascript that will open a
-calendar on click. The javascript ist by default anchoered at the bottom right
-sight. This can be overridden with C<cal_align>, see Calendar documentation for
-the details, usually you'll want a two letter abbreviation of the alignment.
-Right + Bottom becomes C<BL>.
-
-=item C<radio_button_tag $name, %attributes>
-
-Creates a HTML 'input type=radio' tag named C<$name> with arbitrary
-HTML attributes from C<%attributes>. The tag's C<value> defaults to
-C<1>. The tag's C<id> defaults to C<name_to_id($name . "_" . $value)>.
-
-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.
+calendar on click.
=item C<javascript_tag $file1, $file2, $file3...>
with '.css' if it isn't already and prefixed with 'css/' if it doesn't
contain a slash.
-=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
-calendar on click. The javascript ist by default anchoered at the bottom right
-sight. This can be overridden with C<cal_align>, see Calendar documentation for
-the details, usually you'll want a two letter abbreviation of the alignment.
-Right + Bottom becomes C<BL>.
-
=item C<tabbed \@tab, %attributes>
Will create a tabbed area. The tabs should be created with the helper function
L.tab(LxERP.t8('Custom Variables'), 'part/_cvar_tab.html', if => SELF.display_cvar_tab),
]) %]
-An optional attribute is C<selected>, which accepts the ordinal of a tab which
-should be selected by default.
-
=item C<areainput_tag $name, $content, %PARAMS>
Creates a generic input tag or textarea tag, depending on content size. The
=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
+dropped. The AJAX request's return value is ignored by default. If given then
C<$params{with}> must be given as well.
+=item C<ajax_return>
+
+If trueish then the AJAX request's return is accepted.
+
=item C<with>
A string that is interpreted as the prefix of the children's ID. Upon
recolor the children by setting the class C<listrow0> on odd and
C<listrow1> on even entries.
+=item C<params>
+
+An optional JavaScript string that is evaluated before sending the
+POST request. The result must be a string that is appended to the URL.
+
=back
Example:
See the documentation of L<SL::Controller::Helper::Sorted> for an
overview and further usage instructions.
-=back
-
-=head2 CONVERSION FUNCTIONS
-
-=over 4
-
-=item C<options_for_select \@collection, %options>
-
-Creates a string suitable for a HTML 'select' tag consisting of one
-'E<lt>optionE<gt>' tag for each element in C<\@collection>. The value
-to use and the title to display are extracted from the elements in
-C<\@collection>. Each element can be one of four things:
+=item C<paginate_controls>
-=over 12
+Create a set of links used to paginate a list view.
-=item 1. An array reference with at least two elements. The first element is
-the value, the second element is its title.
-
-=item 2. A scalar. The scalar is both the value and the title.
-
-=item 3. A hash reference. In this case C<%options> must contain
-I<value> and I<title> keys that name the keys in the element to use
-for the value and title respectively.
-
-=item 4. A blessed reference. In this case C<%options> must contain
-I<value> and I<title> keys that name functions called on the blessed
-reference whose return values are used as the value and title
-respectively.
+See the documentation of L<SL::Controller::Helper::Paginated> for an
+overview and further usage instructions.
=back
-For cases 3 and 4 C<$options{value}> defaults to C<id> and
-C<$options{title}> defaults to C<$options{value}>.
-
-In addition to pure keys/method you can also provide coderefs as I<value_sub>
-and/or I<title_sub>. If present, these take precedence over keys or methods,
-and are called with the element as first argument. It must return the value or
-title.
-
-Lastly a joint coderef I<value_title_sub> may be provided, which in turn takes
-precedence over each individual sub. It will only be called once for each
-element and must return a list of value and title.
-
-If the option C<with_empty> is set then an empty element (value
-C<undef>) will be used as the first element. The title to display for
-this element can be set with the option C<empty_title> and defaults to
-an empty string.
+=head2 CONVERSION FUNCTIONS
-The option C<default> can be either a scalar or an array reference
-containing the values of the options which should be set to be
-selected.
+=over 4
=item C<tab, description, target, %PARAMS>
L.tab('Awesome tab wih much info', '_much_info.html', if => SELF.wants_all)
-=item C<truncate $text, %params>
+=item C<truncate $text, [%params]>
+
+See L<SL::Presenter::Text/truncate>.
-Returns the C<$text> truncated after a certain number of
-characters.
+=item C<simple_format $text>
-The number of characters to truncate at is determined by the parameter
-C<at> which defaults to 50. If the text is longer than C<$params{at}>
-then it will be truncated and postfixed with '...'. Otherwise it will
-be returned unmodified.
+See L<SL::Presenter::Text/simple_format>.
=back
projects / kivitendo-erp.git / blobdiff