RT#21463: Option to show disabled package definitions [does not work on IE]
[freeside.git] / httemplate / elements / select-table.html
index c0cd7a5..7945bb4 100644 (file)
@@ -8,7 +8,7 @@ Example:
     # required
     ##
     'table'          => 'table_name',
-    'name_col'       => 'name_column',
+    'name_col'       => 'name_column', #or method if you pass an order_by
    
     #strongly recommended (you want your forms to be "sticky" on errors, right?)
     'curr_value'     => 'current_value',
@@ -28,6 +28,7 @@ Example:
     'agent_null_right' => '', #right to see un-agented entries
     #or
     'records'        => \@records, #instead of search params
+    'presorted'      => 0, #set true to disable sorting the records on name_col
 
     #instead of the primary key... only for special cases
     'value_col'      => 'columnname',
@@ -37,6 +38,7 @@ Example:
     'post_options'   => [ 'value' => 'option' ], #after normal options
     'empty_label'    => '', #better specify it though, the default might change
     'multiple'       => 0, # bool
+    'all_selected'   => 0, # useful with multiple
     'disable_empty'  => 0, # bool (implied by multiple)
     'label_showkey'  => 0, # bool
     'label_callback' => sub { my $record = shift; return "label"; },
@@ -49,9 +51,12 @@ Example:
                             #<SELECT> element
     'onchange'       => '', #javascript code
 
-    #params (well, a param) controlling the <OPTION>s
+    #params controlling the <OPTION>s
     'extra_option_attributes' => [ 'field' ], #field or method in $table objects
                                               #(are prefixed w/data- per HTML5)
+    'hidden_sub' => sub { my $rec = shift; $rec->disabled; }, #sets option hidden att if true
+                                                              #won't hide selected options
+                                                              #hidden att not supported IE < 11
 
     #special return options
     'js_only'      => 0, #set true to return only the JS portions (i.e. nothing)
@@ -69,14 +74,16 @@ Example:
         NAME = "<% $opt{'element_name'} || $opt{'field'} || $key %>"
         ID   = "<% $opt{'id'} || $key %>"
         <% $onchange %>
+        <% $size %>
         <% $opt{'element_etc'} %>
 >
 
 % while ( @pre_options ) { 
 %   my $pre_opt   = shift(@pre_options);
 %   my $pre_label = shift(@pre_options);
-%   my $selected =    ( ref($value) && $value->{$pre_opt} )
-%                  || ( $value eq $pre_opt );
+%   my $selected = $opt{'all_selected'}
+%                   || ( ref($value) && $value->{$pre_opt} )
+%                   || ( $value eq $pre_opt );
     <OPTION VALUE="<% $pre_opt %>"
             <% $selected ? 'SELECTED' : '' %>
     ><% $pre_label %>
@@ -86,10 +93,12 @@ Example:
     <OPTION VALUE=""><% $opt{'empty_label'} || 'all' %>
 % }
 
-% foreach my $record ( sort {    $a->$name_col() cmp $b->$name_col()
-%                             || $a->$key()      <=> $b->$key()
-%                           }
-%                           @records
+% foreach my $record ( 
+% # we have the order_by parameter for this
+% #sort {    $a->$name_col() cmp $b->$name_col()
+% #                           || $a->$key()      <=> $b->$key()
+% #                         }
+%                          @records
 %                    )
 % {
 %   my $recvalue = $record->$key();
@@ -102,8 +111,10 @@ Example:
 %     $selected =    ( ref($value) && $value->{$recvalue} )
 %                 || ( $value && $value eq $recvalue ); #not == because of value_col
 %   }
+%   $opt{'hidden_sub'} ||= sub { 0 };
     <OPTION VALUE="<% $recvalue %>"
             <% $selected ? ' SELECTED' : '' %>
+            <% (&{$opt{'hidden_sub'}}($record) && !$selected) ? ' hidden' : '' %>
 %           foreach my $att ( @{ $opt{'extra_option_attributes'} } ) {
               data-<% $att %>="<% $record->$att() |h %>"
 %           }
@@ -111,6 +122,7 @@ Example:
      <% $opt{'label_callback'}
           ? &{ $opt{'label_callback'} }( $record )
           : $record->$name_col()
+        |h
      %>
 % } 
 
@@ -171,6 +183,8 @@ if ( $opt{'agent_virt'} ) {
 my @records = ();
 if ( $opt{'records'} ) {
   @records = @{ $opt{'records'} };
+  @records = sort { $a->get($name_col) cmp $b->get($name_col) } @records
+    unless $opt{'presorted'};
 } else {
   @records = qsearch( {
     'table'     => $opt{'table'},
@@ -209,4 +223,6 @@ unless (    !ref($value) && $value < 1 # !$value #ignore negatives too
 my @pre_options  = $opt{pre_options}  ? @{ $opt{pre_options} } : ();
 my @post_options = $opt{post_options} ? @{ $opt{post_options} } : ();
 
+my $size = $opt{'size'} ? 'SIZE=' . $opt{'size'} : '';
+
 </%init>