lib/MECON/HTML/QuickForm/Renderer/Tabla.php

   1 <?php /* vim: set binary expandtab tabstop=4 shiftwidth=4 textwidth=80:
   2 -------------------------------------------------------------------------------
   3                              Ministerio de Economía
   4                                     meconlib
   5 -------------------------------------------------------------------------------
   6 This file is part of meconlib.
   7
   8 meconlib is free software; you can redistribute it and/or modify it under
   9 the terms of the GNU General Public License as published by the Free
  10 Software Foundation; either version 2 of the License, or (at your option)
  11 any later version.
  12
  13 meconlib is distributed in the hope that it will be useful, but WITHOUT
  14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License; if not,
  18 write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  19 Boston, MA  02111-1307  USA
  20 -------------------------------------------------------------------------------
  21 Creado: jue jul 17 15:36:26 ART 2003
  22 Autor:  Leandro Lucarella <llucar@mecon.gov.ar>
  23 -------------------------------------------------------------------------------
  24 $Id$
  25 -----------------------------------------------------------------------------*/
  26
  27 require_once 'HTML/QuickForm/Renderer.php';
  28 require_once 'MECON/HTML/Tabla.php';
  29
  30 /**
  31  * QuickForm renderer que usa Tabla como backend.
  32  * Basado en el QuickForm Renderer basico.
  33  *
  34  * @access public
  35  */
  36 class MECON_HTML_QuickForm_Renderer_Tabla extends HTML_QuickForm_Renderer {
  37
  38    /**
  39     * Tabla usada para dibujar el formulario.
  40     * @var      object Tabla
  41     * @access   private
  42     */
  43     var $_tabla;
  44
  45    /**
  46     * HTML con los scripts para poner antes del formulario (tipicamente
  47     * un javascript).
  48     * @var      string
  49     * @access   private
  50     */
  51     var $_script = '';
  52
  53    /**
  54     * HTML para agregar antes de la tabla (tipicamente un javascript).
  55     * @var      string
  56     * @access   private
  57     */
  58     var $_prepend = '';
  59
  60    /**
  61     * HTML para agregar despues de la tabla.
  62     * @var      string
  63     * @access   private
  64     */
  65     var $_append = '';
  66
  67    /**
  68     * True if we are inside a group
  69     * @var      bool
  70     * @access   private
  71     */
  72     var $_inGroup = false;
  73
  74    /**
  75     * Group error related message.
  76     * @var      string
  77     * @access   private
  78     */
  79     var $_groupError = '';
  80
  81    /**
  82     * Array with HTML generated for group elements
  83     * @var      array
  84     * @access   private
  85     */
  86     var $_groupElements = array();
  87
  88    /**
  89     * Constructor.
  90     *
  91     * @param  mixed $style Estilo de la tabla.
  92     *
  93     * @access public
  94     */
  95     function MECON_HTML_QuickForm_Renderer_Tabla($style = array())
  96     {
  97         $this->HTML_QuickForm_Renderer();
  98         $this->_tabla =& new Tabla($style);
  99     } // end constructor
 100
 101    /**
 102     * returns the HTML generated for the form
 103     *
 104     * @access public
 105     * @return string
 106     */
 107     function toHtml()
 108     {
 109         return  $this->_script . $this->_prepend .
 110                 $this->_tabla->toHtml() .
 111                 $this->_append;
 112     } // end func toHtml
 113
 114    /**
 115     * Called when visiting a form, before processing any form elements
 116     *
 117     * @param    object      An HTML_QuickForm object being visited
 118     * @access   public
 119     * @return   void
 120     */
 121     function startForm(&$form)
 122     {
 123         # FIXME - deberia sacarlo del QuickForm
 124         #$this->_prepend = $form->getFormStart();
 125         $attrs = $form->getAttributesString();
 126         $this->_prepend = "\n<FORM$attrs>\n";
 127     } // end func startForm
 128
 129    /**
 130     * Called when visiting a form, after processing all form elements
 131     * Adds required note, form attributes, validation javascript and form content.
 132     *
 133     * @param    object      An HTML_QuickForm object being visited
 134     * @access   public
 135     * @return   void
 136     */
 137     function finishForm(&$form)
 138     {
 139         // add a required note, if one is needed
 140         if (!empty($form->_required) && !$form->_freezeAll) {
 141             $id = $this->_tabla->addRow(
 142                 array($form->getRequiredNote()),
 143                 array('colspan' => 2, 'align' => 'center', 'cabecera' => true)
 144             );
 145             //$this->_tabla->updateCellAttributes($id, array('colspan' => 2));
 146         }
 147         // add form attributes and content
 148         //$this->_html = str_replace('{content}', $this->_html, $html);
 149         // add a validation script
 150         $this->_script = strval($form->getValidationScript());
 151         # FIXME - deberia sacarlo del QuickForm
 152         #$this->_append = $form->getFormEnd();
 153         $this->_append = "\n</FORM>\n";
 154     } // end func finishForm
 155
 156    /**
 157     * Called when visiting a header element
 158     *
 159     * @param    object     An HTML_QuickForm_header element being visited
 160     * @access   public
 161     * @return   void
 162     */
 163     function renderHeader(&$header)
 164     {
 165         $name = $header->getName();
 166         $this->_tabla->addRow(
 167             array($header->toHtml()),
 168             array('colspan' => 2, $name => true, 'align' => 'center')
 169         );
 170     } // end func renderHeader
 171
 172    /**
 173     * Renders an element Html
 174     * Called when visiting an element
 175     *
 176     * @param object     An HTML_QuickForm_element object being visited
 177     * @param bool       Whether an element is required
 178     * @param string     An error message associated with an element
 179     * @access public
 180     * @return void
 181     */
 182     function renderElement(&$element, $required, $error)
 183     {
 184         if (!$this->_inGroup) {
 185             $id = $this->_tabla->addRow(
 186                 array(
 187                     $element->getLabel() . ($required ? '<FONT color="red">*</FONT>' : ''),
 188                     $element->toHtml() . ($error ? "<BR><FONT color=\"red\">$error</FONT>" : ''),
 189                 )
 190             );
 191             $this->_tabla->updateCellAttributes($id, 0, array('titulo' => true, 'align' => 'left'));
 192             $this->_tabla->updateCellAttributes($id, 1, array('align' => 'left'));
 193         } else {
 194             $this->_groupElements[] = ($element->getLabel() ? ($element->getLabel().'&nbsp;') : '') . $element->toHtml();
 195         }
 196     } // end func renderElement
 197
 198    /**
 199     * Renders an hidden element
 200     * Called when visiting a hidden element
 201     *
 202     * @param object     An HTML_QuickForm_hidden object being visited
 203     * @access public
 204     * @return void
 205     */
 206     function renderHidden(&$element)
 207     {
 208         $this->_prepend .= "\n\t". $element->toHtml();
 209     } // end func renderHidden
 210
 211    /**
 212     * Called when visiting a raw HTML/text pseudo-element
 213     *
 214     * @param  object     An HTML_QuickForm_html element being visited
 215     * @access public
 216     * @return void
 217     */
 218     function renderHtml(&$data)
 219     {
 220         $this->_tabla->addRow(
 221             array($header->toHtml()),
 222             array('colspan' => 2)
 223         );
 224     } // end func renderHtml
 225
 226    /**
 227     * Called when visiting a group, before processing any group elements
 228     *
 229     * @param object     An HTML_QuickForm_group object being visited
 230     * @param bool       Whether a group is required
 231     * @param string     An error message associated with a group
 232     * @access public
 233     * @return void
 234     */
 235     function startGroup(&$group, $required, $error)
 236     {
 237         $this->_groupElements = array();
 238         $this->_groupError    = $error;
 239         $this->_inGroup       = true;
 240     } // end func startGroup
 241
 242    /**
 243     * Called when visiting a group, after processing all group elements
 244     *
 245     * @param    object      An HTML_QuickForm_group object being visited
 246     * @access   public
 247     * @return   void
 248     */
 249     function finishGroup(&$group)
 250     {
 251         $name = $group->getName();
 252         $sep = $group->_separator;
 253         if (strtolower($name) == 'botones') {
 254             $id = $this->_tabla->addRow(
 255                 array(join('', $this->_groupElements))
 256             );
 257             $this->_tabla->updateCellAttributes($id, 0, array('valign' => 'middle', 'align' => 'center', 'colspan' => 2));
 258         } else {
 259             $id = $this->_tabla->addRow(
 260                 array($group->getLabel(), join($sep, $this->_groupElements)),
 261                 array('valign' => 'middle', 'align' => 'left')
 262             );
 263             $this->_tabla->updateCellAttributes($id, 0, array('titulo' => true, 'align' => 'left'));
 264         }
 265         $this->_inGroup = false;
 266     } // end func finishGroup
 267
 268 } // end class HTML_QuickForm_Renderer_Default
 269
 270 ?>