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

Source for file TriggerField.php

Documentation is available at TriggerField.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_TextField
  16.  */
  17. include_once 'PhpExt/Form/TextField.php';
  18.  
  19. /**
  20.  * Provides a convenient wrapper for TextFields that adds a clickable trigger button (looks like a combobox by default). The trigger has no default action, so you must assign a function to implement the trigger click handler by overriding onTriggerClick. You can create a TriggerField directly, as it renders exactly like a combobox for which you can provide a custom implementation. For example:
  21.  * <code>
  22.  * var trigger = new Ext.form.TriggerField();
  23.  * trigger.onTriggerClick = myTriggerFn;
  24.  * trigger.applyToMarkup('my-field');
  25.  * </code>
  26.  * However, in general you will most likely want to use TriggerField as the base class for a reusable component. Ext.form.DateField and Ext.form.ComboBox are perfect examples of this.
  27.  * @package PhpExt
  28.  * @subpackage Form
  29.  */
  30. class PhpExt_Form_TriggerField extends PhpExt_Form_TextField 
  31. {
  32.     // AutoCreate
  33.     /**
  34.      * A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "16", autocomplete: "off"})
  35.      * @param PhpExt_Config_Config $value 
  36.      * @return PhpExt_Form_TriggerField 
  37.      */
  38.     public function setAutoCreate(PhpExt_Config_ConfigObject $value) {
  39.         return parent::setAutoCreate($value);
  40.     }    
  41.     /**
  42.      * A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "16", autocomplete: "off"})
  43.      * @return PhpExt_Config_Config 
  44.      */
  45.     public function getAutoCreate() {
  46.         return parent::getAutoCreate();
  47.     }
  48.     
  49.     // HideTrigger
  50.     /**
  51.      * True to hide the trigger element and display only the base text field (defaults to false)
  52.      * @param boolean $value 
  53.      * @return PhpExt_Form_TriggerField 
  54.      */
  55.     public function setHideTrigger($value) {
  56.         $this->setExtConfigProperty("hideTrigger", $value);
  57.         return $this;
  58.     }    
  59.     /**
  60.      * True to hide the trigger element and display only the base text field (defaults to false)
  61.      * @return boolean 
  62.      */
  63.     public function getHideTrigger() {
  64.         return $this->getExtConfigProperty("hideTrigger");
  65.     }
  66.     
  67.     // TriggerCssClass
  68.     /**
  69.      * A CSS class to apply to the trigger
  70.      * @param string $value 
  71.      * @return PhpExt_Form_TriggerField 
  72.      */
  73.     public function setTriggerCssClass($value) {
  74.         $this->setExtConfigProperty("triggerClass", $value);
  75.         return $this;
  76.     }    
  77.     /**
  78.      * A CSS class to apply to the trigger
  79.      * @return string 
  80.      */
  81.     public function getTriggerCssClass() {
  82.         return $this->getExtConfigProperty("triggerClass");
  83.     } 
  84.     
  85.     public function __construct() {
  86.         parent::__construct();
  87.         $this->setExtClassInfo("Ext.form.TriggerField","triggerfield");
  88.         
  89.         $validProps = array(
  90.             "autoCreate",
  91.             "hideTrigger",
  92.             "triggerClass"
  93.         );
  94.         $this->addValidConfigProperties($validProps);
  95.         
  96.     }         
  97.  
  98.     /**
  99.      * Helper function to create a TriggerField.  Useful for quick adding it to a ComponentCollection
  100.      *
  101.      * @param string $name The field's HTML name attribute.
  102.      * @param string $label The label text to display next to this field (defaults to '')
  103.      * @param string $id The unique id of this component (defaults to an auto-assigned id).
  104.      * @return PhpExt_Form_TriggerField 
  105.      */
  106.     public static function createTriggerField($name, $label = null, $id = null) {
  107.         $c = new PhpExt_Form_TriggerField();
  108.         $c->setName($name);
  109.         if ($label !== null)
  110.           $c->setFieldLabel($label);
  111.         if ($id !== null)
  112.           $c->setId($id);
  113.         return $c;
  114.     }
  115. }
Documentation generated on Fri, 08 Aug 2008 16:02:20 -0500 by phpDocumentor 1.4.0