forms
[ class tree: forms ] [ index: forms ] [ all elements ]
Packages:
core
communication
databases
data_structures
filesystem
forms
GilliGan
html
Services_JSON

Source for file SubmitCancelButton.class.php

Documentation is available at SubmitCancelButton.class.php

  1. <?php
  2. /**
  3.  * For including this file you have to define the constant "CLASSPATH".
  4.  * Because every include in the framework depends on the CLASSPATH definition.
  5.  * The CLASSPATH means the relative path to the folder that contains the
  6.  * framework GilliGan.
  7.  *
  8.  * @package    forms
  9.  * @subpackage items
  10.  */
  11.  
  12. if( !defined( "CLASSPATH" ) )
  13. {
  14.   echo "<h3>You have to define the constant CLASSPATH!</h3>\n";
  15.   echo "Example: define( 'CLASSPATH', '../path/to/classes/' );\n";
  16.   exit();
  17. }
  18.  
  19. if ( defined( "LANG" ) )
  20.    /**
  21.     * Including language specific messages.
  22.     */
  23.    include CLASSPATH."/forms/items/SubmitCancelButton/".LANG.".inc.php";
  24. else
  25. {
  26.    echo "<h3>You have to define the constant LANG!</h3>\n";
  27.    echo "Example for german: define( 'LANG', 'de' );\n";
  28.    exit();
  29. }
  30.  
  31. /**
  32.  *
  33.  */
  34. require_once CLASSPATH."forms/items/HTMLButton.class.php";
  35. /**
  36.  *
  37.  */
  38. require_once CLASSPATH."forms/items/HTMLSubmitButton.class.php";
  39.  
  40. /**
  41.  * A class to create a reset and a buton to submit forms.
  42.  *
  43.  * @package    forms
  44.  * @subpackage items
  45.  * @version    0.1.21
  46.  * @author     Daniel Plücken <daniel@debakel.net>
  47.  * @license    http://www.gnu.org/copyleft/lesser.html
  48.  *              GNU Lesser General Public License
  49.  * @copyright  Copyright (C) 2006 Daniel Pluecken <daniel@debakel.net>
  50.  *
  51.  *  This library is free software; you can redistribute it and/or
  52.  *  modify it under the terms of the GNU Lesser General Public
  53.  *  License as published by the Free Software Foundation; either
  54.  *  version 2.1 of the License.
  55.  *
  56.  *  This library is distributed in the hope that it will be useful,
  57.  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  58.  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  59.  *  GNU Lesser General Public License for more details.
  60.  *
  61.  *  You should have received a copy of the GNU Lesser General
  62.  *  Public License along with this library; if not, write to the
  63.  *  Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  64.  *  Boston, MA 02111-1307 USA
  65.  */
  66. class SubmitCancelButton extends ABSTHTMLFormItem
  67. {
  68.    /**
  69.     * @var object 
  70.     *  access private
  71.     */
  72.    var $cncbt;
  73.    /**
  74.     * @var object 
  75.     *  access private
  76.     */
  77.    var $sbtbt;
  78.  
  79.  
  80.  
  81.    /**
  82.     * Constructor
  83.     *
  84.     * @version 1.1
  85.     * @since   0.1.0
  86.     * @author  Daniel Plücken <daniel@debakel.net>
  87.     * @access  public
  88.     * @param   string  $labelSbtBt  Label for the submit button.
  89.     * @param   string  $labelCncBt  Label for the cancel button.
  90.     */
  91.    function SubmitCancelButton()
  92.    {
  93.       $param = func_get_args();
  94.  
  95.       $labelSbtBt = empty( $param[0] )
  96.                     ? STANDARD_LABEL_SUBMIT_BT
  97.                     : $param[0];
  98.       $labelCncBt = empty( $param[1] )
  99.                     ? STANDARD_LABEL_CANCEL_BT
  100.                     : $param[1];
  101.  
  102.       $this->sbtbt =& new HTMLSubmitButton( "formsent", $labelSbtBt );
  103.       $this->cncbt =& new HTMLButton( "cancel", $labelCncBt );
  104.    }
  105.  
  106.  
  107.  
  108.   /**
  109.    * Sets the label of the reset button.
  110.    *
  111.    * @version 1.0
  112.    * @since   0.1.0
  113.    * @author  Daniel Plücken <daniel@debakel.net>
  114.    * @access  public
  115.    * @param   string  $string  The text how the reset button should be labled.
  116.    */
  117.    function setLabelOfCancelButton( $string )
  118.    {
  119.      if( get_class( $this->cncbt ) == "htmlresetbutton" )
  120.        $this->cncbt->setValue( $string );
  121.    }
  122.  
  123.  
  124.  
  125.    /**
  126.    * Sets the label of the submit button.
  127.    *
  128.    * @version 1.0
  129.    * @since   0.1.0
  130.    * @author  Daniel Plücken <daniel@debakel.net>
  131.    * @access  public
  132.    * @param   string  $string  The text how the submit button should be labled.
  133.    */
  134.    function setLabelOfSubmitButton( $string )
  135.    {
  136.      if( get_class( $this->sbtbt ) == "htmlsubmitbutton" )
  137.        $this->sbtbt->setValue( $string );
  138.    }
  139.  
  140.  
  141.  
  142.    /**
  143.     * Sets the "parentform"-attribute of both buttons.
  144.     *
  145.     * @version 1.0
  146.     * @since   0.1.0
  147.     * @author  Daniel Plücken <daniel@debakel.net>
  148.     * @access  public
  149.     * @param   object $formobj This object's parent object.
  150.     */
  151.    function setParentForm( &$formobj )
  152.    {
  153.       $this->cncbt->parentform =& $formobj;
  154.       $this->sbtbt->parentform =& $formobj;
  155.    }
  156.  
  157.  
  158.  
  159.    /**
  160.     * Sets the mouseUp-function of the cancel button.
  161.     *
  162.     * @version 1.0
  163.     * @since   0.1.0
  164.     * @author  Daniel Plücken <daniel@debakel.net>
  165.     * @access  public
  166.     * @param   string $js_string Javascript of what to do on cancel.
  167.     */
  168.    function setCancelOrder( $js_string )
  169.    { $this->cncbt->setOnMouseUp( $js_string ); }
  170.  
  171.  
  172.  
  173.    /**
  174.     * Blind method cause other objects will invoke it.
  175.     *
  176.     * @version 1.0
  177.     * @since   0.1.0
  178.     * @author  Daniel Plücken <daniel@debakel.net>
  179.     * @access  public
  180.     * @return  string 
  181.     */
  182.    function getName()
  183.    { return ""; }
  184.  
  185.  
  186.  
  187.    /**
  188.     * Returns the name of the cancel button.
  189.     *
  190.     * @version 1.0
  191.     * @since   0.1.0
  192.     * @author  Daniel Plücken <daniel@debakel.net>
  193.     * @access  public
  194.     * @return  string 
  195.     */
  196.    function getNameOfCancelButton()
  197.    { return $this->cncbt->getName(); }
  198.  
  199.  
  200.  
  201.    /**
  202.     * Returns the label of the cancel button.
  203.     *
  204.     * @version 1.0
  205.     * @since   0.1.0
  206.     * @author  Daniel Plücken <daniel@debakel.net>
  207.     * @access  public
  208.     * @return  string 
  209.     */
  210.    function getLabelOfCancelButton()
  211.    {
  212.      if( get_class( $this->cncbt ) == "htmlbutton" )
  213.        return $this->cncbt ->getValue();
  214.      else
  215.        return false;
  216.    }
  217.  
  218.  
  219.  
  220.    /**
  221.     * Returns the name of the submit button.
  222.     *
  223.     * @version 1.0
  224.     * @since   0.1.0
  225.     * @author  Daniel Plücken <daniel@debakel.net>
  226.     * @access  public
  227.     * @return  string 
  228.     */
  229.    function getNameOfSubmitButton()
  230.    { return $this->sbtbt->getName(); }
  231.  
  232.  
  233.  
  234.    /**
  235.     * Returns the label of the submit button.
  236.     *
  237.     * @version 1.0
  238.     * @since   0.1.0
  239.     * @author  Daniel Plücken <daniel@debakel.net>
  240.     * @access  public
  241.     * @return  string 
  242.     */
  243.    function getLabelOfSubmitButton()
  244.    {
  245.      if( get_class( $this->sbtbt ) == "htmlsubmitbutton" )
  246.        return $this->sbtbt->getValue();
  247.      else
  248.        return false;
  249.    }
  250.  
  251.  
  252.  
  253.    /**
  254.     * Blind method cause other objects will invoke it.
  255.     *
  256.     * @version 1.0
  257.     * @since   0.1.0
  258.     * @author  Daniel Plücken <daniel@debakel.net>
  259.     * @access  public
  260.     * @return  boolean 
  261.     */
  262.    function getCheckOrder( $formName )
  263.    { return false; }
  264.  
  265.  
  266.  
  267.    /**
  268.     * Blind method cause other objects will invoke it.
  269.     *
  270.     * @version 1.0
  271.     * @since   0.1.0
  272.     * @author  Daniel Plücken <daniel@debakel.net>
  273.     * @access  public
  274.     * @return  boolean 
  275.     */
  276.    function getValidationOrder( $formName )
  277.    { return false; }
  278.  
  279.  
  280.  
  281.    /**
  282.    * Generates the sourcecode to build this object and returns it.
  283.    *
  284.    * @version 1.0
  285.    * @since   0.1.0
  286.    * @author  Daniel Plücken <daniel@debakel.net>
  287.    * @access  public
  288.    * @return  string 
  289.    */
  290.    function getPHPSource()
  291.    {
  292.       $outputstr = "\x24input[] = new ResetSubmitButton(\n"
  293.                   ."                                   \""
  294.                   .$this->getLabelOfCancelButton()."\",\n"
  295.                   ."                                   \""
  296.                   .$this->getLabelOfSubmitButton()."\"\n"
  297.                   ."                                );\n";
  298.  
  299.       return $outputstr;
  300.    }
  301.  
  302.  
  303.  
  304.    /**
  305.     * Returns a generated string based on the attributes of this HTML-Object.
  306.     *
  307.     * @version 1.1
  308.     * @since   0.1.0
  309.     * @author  Daniel Plücken <daniel@debakel.net>
  310.     * @access  public
  311.     * @param   boolean $swap_position 
  312.     * @return  string 
  313.     */
  314.    function get( $swap_position = false )
  315.    {
  316.      if ( $swap_position )
  317.         return $this->sbtbt->get()
  318.               .$this->cncbt->get();
  319.      else
  320.         return $this->cncbt->get()
  321.               .$this->sbtbt->get();
  322.    }
  323. } // End of class SubmitCancelButton
  324. ?>
Documentation generated on Thu, 05 Jun 2008 19:15:12 +0200 by phpDocumentor 1.4.1