PhpExt : Form [ class tree ] [ index ] [ all elements ]
PhpExt
Packages:
PhpExt
PhpExtUx
Services_JSON

Source for file NumberField.php

Documentation is available at NumberField.php

  1. <?php
  2. /**
  3.  * PHP-Ext Library
  4.  * http://php-ext.googlecode.com
  5.  * @author Sergei Walter <sergeiw[at]gmail[dot]com>
  6.  * @copyright 2008 Sergei Walter
  7.  * @license http://www.gnu.org/licenses/lgpl.html
  8.  * @link http://php-ext.googlecode.com
  9.  * 
  10.  *  Reference for Ext JS: http://extjs.com
  11.  * 
  12.  */
  13.  
  14. /**
  15.  * @see PhpExt_Form_TextField
  16.  */
  17. include_once 'PhpExt/Form/TextField.php';
  18.  
  19. /**
  20.  * Numeric text field that provides automatic keystroke filtering and numeric validation.
  21.  * 
  22.  * @package PhpExt
  23.  * @subpackage Form
  24.  */
  25. class PhpExt_Form_NumberField extends PhpExt_Form_TextField 
  26. {    
  27.     // AllowDecimals
  28.     /**
  29.      * False to disallow decimal values (defaults to true)
  30.      * @param boolean $value 
  31.      * @return PhpExt_Form_NumberField 
  32.      */
  33.     public function setAllowDecimals($value) {
  34.         $this->setExtConfigProperty("allowDecimals", $value);
  35.         return $this;
  36.     }    
  37.     /**
  38.      * False to disallow decimal values (defaults to true)
  39.      * @return boolean 
  40.      */
  41.     public function getAllowDecimals() {
  42.         return $this->getExtConfigProperty("allowDecimals");
  43.     }
  44.     
  45.     // AllowNegative
  46.     /**
  47.      * False to prevent entering a negative sign (defaults to true)
  48.      * @param boolean $value 
  49.      * @return PhpExt_Form_NumberField 
  50.      */
  51.     public function setAllowNegative($value) {
  52.         $this->setExtConfigProperty("allowNegative", $value);
  53.         return $this;
  54.     }    
  55.     /**
  56.      * False to prevent entering a negative sign (defaults to true)
  57.      * @return boolean 
  58.      */
  59.     public function getAllowNegative() {
  60.         return $this->getExtConfigProperty("allowNegative");
  61.     }
  62.     
  63.     // BaseChars
  64.     /**
  65.      * The base set of characters to evaluate as valid numbers (defaults to '0123456789').
  66.      * @param string $value 
  67.      * @return PhpExt_Form_NumberField 
  68.      */
  69.     public function setBaseChars($value) {
  70.         $this->setExtConfigProperty("baseChars", $value);
  71.         return $this;
  72.     }    
  73.     /**
  74.      * The base set of characters to evaluate as valid numbers (defaults to '0123456789').
  75.      * @return string 
  76.      */
  77.     public function getBaseChars() {
  78.         return $this->getExtConfigProperty("baseChars");
  79.     }
  80.     
  81.     // DecimalPrecision
  82.     /**
  83.      * The maximum precision to display after the decimal separator (defaults to 2)
  84.      * @param integer $value 
  85.      * @return PhpExt_Form_NumberField 
  86.      */
  87.     public function setDecimalPrecision($value) {
  88.         $this->setExtConfigProperty("decimalPrecision", $value);
  89.         return $this;
  90.     }    
  91.     /**
  92.      * The maximum precision to display after the decimal separator (defaults to 2)
  93.      * @return integer 
  94.      */
  95.     public function getDecimalPrecision() {
  96.         return $this->getExtConfigProperty("decimalPrecision");
  97.     }
  98.     
  99.     // DecimalSeparator
  100.     /**
  101.      * Character(s) to allow as the decimal separator (defaults to '.')
  102.      * @param string $value 
  103.      * @return PhpExt_Form_NumberField 
  104.      */
  105.     public function setDecimalSeparator($value) {
  106.         $this->setExtConfigProperty("decimalSeparator", $value);
  107.         return $this;
  108.     }    
  109.     /**
  110.      * Character(s) to allow as the decimal separator (defaults to '.')
  111.      * @return string 
  112.      */
  113.     public function getDecimalSeparator() {
  114.         return $this->getExtConfigProperty("decimalSeparator");
  115.     }
  116.     
  117.     // FieldCssClass
  118.     /**
  119.      * The default CSS class for the field (defaults to "x-form-field x-form-num-field")
  120.      * @param string $value 
  121.      * @return PhpExt_Form_NumberField 
  122.      */
  123.     public function setFieldCssClass($value) {
  124.         $this->setExtConfigProperty("fieldClass", $value);
  125.         return $this;
  126.     }    
  127.     /**
  128.      * The default CSS class for the field (defaults to "x-form-field x-form-num-field")
  129.      * @return string 
  130.      */
  131.     public function getFieldCssClass() {
  132.         return $this->getExtConfigProperty("fieldClass");
  133.     }
  134.     
  135.     // MaxText
  136.     /**
  137.      * Error text to display if the maximum value validation fails (defaults to "The maximum value for this field is {maxValue}")
  138.      * @param string $value 
  139.      * @return PhpExt_Form_NumberField 
  140.      */
  141.     public function setMaxText($value) {
  142.         $this->setExtConfigProperty("maxText", $value);
  143.         return $this;
  144.     }    
  145.     /**
  146.      * Error text to display if the maximum value validation fails (defaults to "The maximum value for this field is {maxValue}")
  147.      * @return string 
  148.      */
  149.     public function getMaxText() {
  150.         return $this->getExtConfigProperty("maxText");
  151.     }
  152.     
  153.     // MaxValue
  154.     /**
  155.      * The maximum allowed value (defaults to Number.MAX_VALUE)
  156.      * @param integer|float$value 
  157.      * @return PhpExt_Form_NumberField 
  158.      */
  159.     public function setMaxValue($value) {
  160.         $this->setExtConfigProperty("maxValue", $value);
  161.         return $this;
  162.     }    
  163.     /**
  164.      * The maximum allowed value (defaults to Number.MAX_VALUE)
  165.      * @return integer|float
  166.      */
  167.     public function getMaxValue() {
  168.         return $this->getExtConfigProperty("maxValue");
  169.     }
  170.     
  171.     // MinText
  172.     /**
  173.      * Error text to display if the minimum value validation fails (defaults to "The minimum value for this field is {minValue}")
  174.      * @param string $value 
  175.      * @return PhpExt_Form_NumberField 
  176.      */
  177.     public function setMinText($value) {
  178.         $this->setExtConfigProperty("minText", $value);
  179.         return $this;
  180.     }    
  181.     /**
  182.      * Error text to display if the minimum value validation fails (defaults to "The minimum value for this field is {minValue}")
  183.      * @return string 
  184.      */
  185.     public function getMinText() {
  186.         return $this->getExtConfigProperty("minText");
  187.     }
  188.     
  189.     // MinValue
  190.     /**
  191.      * The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)
  192.      * @param integer|float$value 
  193.      * @return PhpExt_Form_NumberField 
  194.      */
  195.     public function setMinValue($value) {
  196.         $this->setExtConfigProperty("minValue", $value);
  197.         return $this;
  198.     }    
  199.     /**
  200.      * The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)
  201.      * @return integer|float
  202.      */
  203.     public function getMinValue() {
  204.         return $this->getExtConfigProperty("minValue");
  205.     }
  206.     
  207.     // NanText
  208.     /**
  209.      * Error text to display if the value is not a valid number. For example, this can happen if a valid character like '.' or '-' is left in the field with no number (defaults to "{value} is not a valid number")
  210.      * @param string $value 
  211.      * @return PhpExt_Form_NumberField 
  212.      */
  213.     public function setNanText($value) {
  214.         $this->setExtConfigProperty("nanText", $value);
  215.         return $this;
  216.     }    
  217.     /**
  218.      * Error text to display if the value is not a valid number. For example, this can happen if a valid character like '.' or '-' is left in the field with no number (defaults to "{value} is not a valid number")
  219.      * @return string 
  220.      */
  221.     public function getNanText() {
  222.         return $this->getExtConfigProperty("nanText");
  223.     }
  224.     
  225.     public function __construct() {
  226.         parent::__construct();
  227.         $this->setExtClassInfo("Ext.form.NumberField","numberfield");
  228.         
  229.         $validProps = array(
  230.             "allowDecimals",
  231.             "allowNegative",
  232.             "baseChars",
  233.             "decimalPrecision",
  234.             "decimalSeparator",
  235.             "fieldClass",
  236.             "maxText",
  237.             "maxValue",
  238.             "minText",
  239.             "minValue",
  240.             "nanText"
  241.         );
  242.         $this->addValidConfigProperties($validProps);
  243.     }     
  244.     
  245.     /**
  246.      * Helper function to create an NumberField.  Useful for quick adding it to a ComponentCollection
  247.      *
  248.      * @param string $name The field's HTML name attribute.
  249.      * @param string $label The label text to display next to this field (defaults to '')
  250.      * @param string $id The unique id of this component (defaults to an auto-assigned id).
  251.      * @return PhpExt_Form_NumberField 
  252.      */
  253.     public static function createNumberField($name, $label = null, $id = null) {
  254.         $c = new PhpExt_Form_NumberField();
  255.         $c->setName($name);
  256.         if ($label !== null)
  257.           $c->setFieldLabel($label);
  258.         if ($id !== null)
  259.           $c->setId($id);
  260.         return $c;
  261.     }
  262.  
  263.     
  264. }
Documentation generated on Fri, 08 Aug 2008 15:57:14 -0500 by phpDocumentor 1.4.0