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 See JSFormPage.js for the javascript code
  14
  15
  16 Parameters:
  17
  18 =over 5
  19
  20 =item object_type
  21
  22 The type of object the form is associated with - for example, 'locus' for a locus page, or 'image' for an image page, etc.
  23
  24 =item object_id
  25
  26 The ID of the object to be displayed
  27
  28 =item form_name
  29
  30 The name of the form. Should be unique for the entire page.
  31
  32 =item server_side_script
  33
  34 The url of the server side script that handles the ajax requests
  35
  36 =item form_div_name
  37
  38 The name of the div to be used for displaying the forms.
  39
  40 =item js_object_name
  41
  42 The javascript variable name to be used in the form.
  43
  44 =item page_url
  45
  46 The semi-absolute url of the page that displays the form.
  47
  48 =item alternate_new_button, alternate_ghosted_new_button, alternate_delete_button, alterante_ghosted_delete_button
  49
  50 An alternate link for the 'new' and 'delete' buttons, including their ghosted variants. For example, if the 'new' button is not needed, it and its ghosted variant can be set to the empty string.
  51
  52
  53
  54
  55 =back
  56
  57 =head1 AUTHOR
  58
  59 Lukas Mueller <lam87@cornell.edu>, based on Perl code by Naama Menda.
  60
  61 =cut
  62
  63 </%doc>
  64
  65 <%args>
  66 $object_type
  67 $object_id => undef
  68 $form_name
  69 $server_side_script
  70 $form_div_name
  71 $js_object_name
  72 $page_url => ''
  73 $alternate_new_button => undef
  74 $alternate_ghosted_new_button => undef
  75 $alternate_delete_button => undef
  76 $alternate_ghosted_delete_button => undef
  77 $alternate_ghosted_edit_button => undef
  78 $alternate_edit_button => undef
  79 </%args>
  80
  81 <& /util/import_javascript.mas, classes => ["CXGN.Page.Form.JSFormPage"] &>
  82
  83 <table><tr><td><div id="<% $form_div_name %>_buttons" >[loading edit links...]</div>
  84 </td></tr></table>
  85 <div id="<% $form_div_name %>" >[loading...]</div>
  86
  87 <script language="javascript" type="text/javascript">
  88
  89   var <% $js_object_name %> = new CXGN.Page.Form.JSFormPage( '<% $object_id %>' , '<% $object_type %>', '<% $server_side_script %>', '<% $form_div_name %>', '<% $js_object_name %>','<% $page_url %>');
  90 % if (defined($alternate_new_button)) {
  91      <% $js_object_name %>.setNewButton('<% $alternate_new_button %>');
  92 % }
  93
  94 % if (defined($alternate_ghosted_new_button)) {
  95      <% $js_object_name %>.setGhostedNewButton('<% $alternate_ghosted_new_button %>');
  96 % }
  97
  98 % if (defined($alternate_delete_button)) {
  99      <% $js_object_name %>.setDeleteButton('<% $alternate_delete_button %>');
 100 % }
 101
 102 % if (defined($alternate_ghosted_delete_button)) {
 103      <% $js_object_name %>.setGhostedDeleteButton('<% $alternate_ghosted_delete_button %>');
 104 % }
 105
 106 % if (defined($alternate_edit_button)) {
 107      <% $js_object_name %>.setEditButton('<% $alternate_edit_button %>');
 108 % }
 109
 110 % if (defined($alternate_ghosted_edit_button)) {
 111      <% $js_object_name %>.setGhostedEditButton('<% $alternate_ghosted_edit_button %>');
 112 % }
 113
 114
 115   <% $js_object_name %>.render();
 116
 117 </script>
 118
 119