event refactor, landing on HEAD!

[freeside.git] / httemplate / elements / checkboxes-table-name.html

diff --git a/httemplate/elements/checkboxes-table-name.html b/httemplate/elements/checkboxes-table-name.html
index 0a92e45..1638b9c 100644 (file)
--- a/httemplate/elements/checkboxes-table-name.html
+++ b/httemplate/elements/checkboxes-table-name.html
@@ -1,56 +1,54 @@
+<%doc>
+
+Example:
+
+  include( '/elements/checkboxes-table-name.html',
+
+    ###
+    # required
+    ###
+    'link_table'      => 'table_name',
+   
+    'name_col' => 'name_column',
+    #or
+    'name_callback' => sub { },
+   
+    'names_list' => [ 'value',
+                      'other value',
+                      [ 'complex value' => { 'desc' => "Add'l description",
+                                             'note' => '&nbsp;*',
+                                           }
+                      ],
+                    ],
+   
+    ###
+    # recommended (required?)
+    ###
+    'source_obj'   => $obj,
+    #or?
+    #'source_table' => 'table_name',
+    #'sourcenum'    => '4', #current value of primary key in source_table
+    #                       # (none is okay, just pass it if you have it)
+
+    ###
+    # optional
+    ###
+    'num_col' => 'col_name' #if column name is different in link_table than
+                            #source_table
+    'link_static' => { 'column' => 'value' },
+
+  )
+
+</%doc>
+
+<TABLE CELLSPACING=0 CELLPADDING=0>
+
+% foreach my $item ( @{ $opt{'names_list'} } ) {
 %
-%
-%  ##
-%  # required
-%  ##
-%  # 'link_table'      => 'table_name',
-%  #
-%  # 'name_col' => 'name_column',
-%  # #or
-%  # 'name_callback' => sub { },
-%  #
-%  # 'names_list' => [ 'value', 'other value' ],
-%  #
-%  ##
-%  # recommended (required?)
-%  ##
-%  # 'source_obj'   => $obj,
-%  # #or?
-%  # #'source_table' => 'table_name',
-%  # #'sourcenum'    => '4', #current value of primary key in source_table
-%  # #                       # (none is okay, just pass it if you have it)
-%  ##
-%  # optional
-%  ##
-%  # 'num_col' => 'col_name' #if column name is different in link_table than
-%  #                         #source_table
-%  # 'link_static' => { 'column' => 'value' },
-%
-%  my( %opt ) = @_;
-%
-%  my( $source_pkey, $sourcenum, $source_obj );
-%  if ( $opt{'source_obj'} ) {
-%
-%    $source_obj = $opt{'source_obj'};
-%    #$source_table = $source_obj->dbdef_table->table;
-%    $source_pkey = $source_obj->dbdef_table->primary_key;
-%    $sourcenum = $source_obj->$source_pkey();
-%
-%  } else {
-%
-%    #$source_obj?
-%    $source_pkey = $opt{'source_table'}
-%                     ? dbdef->table($opt{'source_table'})->primary_key
-%                     : '';
-%    $sourcenum = $opt{'sourcenum'};
-%  }
-%
-%  $source_pkey = $opt{'num_col'} || $source_pkey;
-%
-%  my $link_static = $opt{'link_static'} || {};
-%
-%
-% foreach my $name ( @{ $opt{'names_list'} } ) {
+%     my $name = ref($item) ? $item->[0] : $item;
+%     ( my $display = $name ) =~ s/ /&nbsp;/g;
+%     $display .= $item->[1]{note} if ref($item) && $item->[1]{note};
+%     my $desc = ref($item) && $item->[1]{desc} ? $item->[1]{desc} : '';
 %
 %     my $checked;
 %     if ( $cgi->param('error') ) {
@@ -71,15 +69,45 @@
 %                    : ''
 %
 %     }
-%
-%
 
+  <TR>
+    <TD VALIGN="top">
+      <INPUT TYPE="checkbox" NAME="<% $opt{'link_table'}. ".$name" %>" <% $checked %> VALUE="ON">
+    </TD>
+    <TD><% $display %>
+%     if ( $desc ) {
+        <BR><FONT SIZE="-2"><% $desc %></FONT>
+%     }
+    </TD>
+  </TR>
+
+% } 
 
-  <INPUT TYPE="checkbox" NAME="<% $opt{'link_table'}. ".$name" %>" <% $checked %> VALUE="ON">
+</TABLE>
 
-  <% $name %>
+<%init>
 
-  <BR>
-% } 
+my( %opt ) = @_;
+
+my( $source_pkey, $sourcenum, $source_obj );
+if ( $opt{'source_obj'} ) {
+
+  $source_obj = $opt{'source_obj'};
+  #$source_table = $source_obj->dbdef_table->table;
+  $source_pkey = $source_obj->dbdef_table->primary_key;
+  $sourcenum = $source_obj->$source_pkey();
+
+} else {
+
+  #$source_obj?
+  $source_pkey = $opt{'source_table'}
+                   ? dbdef->table($opt{'source_table'})->primary_key
+                   : '';
+  $sourcenum = $opt{'sourcenum'};
+}
+
+$source_pkey = $opt{'num_col'} || $source_pkey;
 
+my $link_static = $opt{'link_static'} || {};
 
+</%init>