mason/page/form.mas

   1
   2
   3 <%doc>
   4
   5 =head1 NAME
   6
   7 /page/form.mas - a component for displaying static and editable forms for user input
   8
   9 =head1 DESCRIPTION
  10
  11 The form component is based on an ajax implementation and requires some backend scripts to be implemented for a given form.
  12
  13 Parameters:
  14
  15 =over 5
  16
  17 =item object_type
  18
  19 The type of object the form is associated with - for example, 'locus' for a locus page, or 'image' for an image page, etc.
  20
  21 =item object_id
  22
  23 The ID of the object to be displayed
  24
  25 =item form_name
  26
  27 The name of the form. Should be unique for the entire page.
  28
  29 =item server_side_script
  30
  31 The url of the server side script that handles the ajax requests
  32
  33 =item form_div_name
  34
  35 The name of the div to be used for displaying the forms.
  36
  37 =item js_object_name
  38
  39 The javascript variable name to be used in the form.
  40
  41 =item page_url
  42
  43 The semi-absolute url of the page that displays the form.
  44
  45 =item alternate_new_button
  46
  47 An alternate link for the 'new' button of the form.
  48
  49
  50 =back
  51
  52 =head1 AUTHOR
  53
  54 Lukas Mueller <lam87@cornell.edu>, based on Perl code by Naama Menda.
  55
  56 =cut
  57
  58 </%doc>
  59
  60 <%args>
  61 $object_type
  62 $object_id => undef
  63 $form_name
  64 $server_side_script
  65 $form_div_name
  66 $js_object_name
  67 $page_url
  68 $alternate_new_button => undef
  69 </%args>
  70
  71 <& /util/import_javascript.mas, classes => ["CXGN.Page.Form.JSFormPage", "MochiKit.Logging"] &>
  72
  73
  74
  75 <table><tr><td><div id="<% $form_div_name %>_buttons" >[loading edit links...]</div>
  76 </td></tr></table>
  77 <table><tr><td><div id="<% $form_div_name %>" >[loading...]</div>
  78 </td></tr></table>
  79 <script language="javascript" type="text/javascript">
  80
  81   var <% $js_object_name %> = new CXGN.Page.Form.JSFormPage( '<% $object_id %>' , '<% $object_type %>', '<% $server_side_script %>', '<% $form_div_name %>', '<% $js_object_name %>','<% $page_url %>');
  82 % if (defined($alternate_new_button)) {
  83      <% $js_object_name %>.setNewButton('<% $alternate_new_button %>');
  84 % }
  85   <% $js_object_name %>.render();
  86
  87 </script>
  88
  89