PhpExt : Form [ class tree ] [ index ] [ all elements ]

Source for file Field.php

Documentation is available at Field.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_BoxComponent
  16.  */
  17. include_once 'PhpExt/BoxComponent.php';
  18.  
  19. /**
  20.  * @see PhpExt_Form_FormPanel
  21.  */
  22. include_once 'PhpExt/Form/FormPanel.php';
  23.  
  24. /**
  25.  * @see PhpExt_Toolbar_IToolbarItem
  26.  */
  27. include_once 'PhpExt/Toolbar/IToolbarItem.php';
  28.  
  29. /**
  30.  * @package PhpExt
  31.  * @subpackage Form
  32.  */
  33. {
  34.     // AutoCreate
  35.     /**
  36.      * A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "20", autocomplete: "off"})
  37.      * @param PhpExt_Config_ConfigObject $value 
  38.      * @return PhpExt_Form_Field 
  39.      */
  40.     public function setAutoCreate(PhpExt_Config_ConfigObject $value{
  41.         $this->setExtConfigProperty("autoCreate"$value);
  42.         return $this;
  43.     }    
  44.     /**
  45.      * A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "20", autocomplete: "off"})
  46.      * @return PhpExt_Config_ConfigObject 
  47.      */
  48.     public function getAutoCreate({
  49.         return $this->getExtConfigProperty("autoCreate");
  50.     }
  51.     
  52.     // ClearCssClass
  53.     /**
  54.      * The CSS class used to provide field clearing (defaults to 'x-form-clear-left')
  55.      * @param string $value 
  56.      * @return PhpExt_Form_Field 
  57.      */
  58.     public function setClearCssClass($value{
  59.         $this->setExtConfigProperty("clearCls"$value);
  60.         return $this;
  61.     }    
  62.     /**
  63.      * The CSS class used to provide field clearing (defaults to 'x-form-clear-left')
  64.      * @return string 
  65.      */
  66.     public function getClearCssClass({
  67.         return $this->getExtConfigProperty("clearCls");
  68.     }
  69.     
  70.     // CssClass
  71.     /**
  72.      * A CSS class to apply to the field's underlying element.
  73.      * @param string $value 
  74.      * @return PhpExt_Form_Field 
  75.      */
  76.     public function setCssClass($value{
  77.         return parent::setCssClass($value);
  78.     }    
  79.     /**
  80.      * A CSS class to apply to the field's underlying element.
  81.      * @return string 
  82.      */
  83.     public function getCssClass({
  84.         return parent::getCssClass();
  85.     }
  86.     
  87.     // Disabled
  88.     /**
  89.      * True to disable the field (defaults to false).
  90.      * @param boolean $value 
  91.      * @return PhpExt_Form_Field 
  92.      */
  93.     public function setDisabled($value{
  94.         $this->setExtConfigProperty("disabled"$value);
  95.         return $this;
  96.     }    
  97.     /**
  98.      * True to disable the field (defaults to false).
  99.      * @return boolean 
  100.      */
  101.     public function getDisabled({
  102.         return $this->getExtConfigProperty("disabled");
  103.     }
  104.     
  105.     // FieldCssClass
  106.     /**
  107.      * The default CSS class for the field (defaults to "x-form-field")
  108.      * @param string $value 
  109.      * @return PhpExt_Form_Field 
  110.      */
  111.     public function setFieldCssClass($value{
  112.         $this->setExtConfigProperty("fieldClass"$value);
  113.         return $this;
  114.     }    
  115.     /**
  116.      * The default CSS class for the field (defaults to "x-form-field")
  117.      * @return string 
  118.      */
  119.     public function getFieldCssClass({
  120.         return $this->getExtConfigProperty("fieldClass");
  121.     }
  122.     
  123.     // FieldLabel
  124.     /**
  125.      * The label text to display next to this field (defaults to '')
  126.      * @param string $value 
  127.      * @return PhpExt_Form_Field 
  128.      */
  129.     public function setFieldLabel($value{
  130.         $this->setExtConfigProperty("fieldLabel"$value);
  131.         return $this;
  132.     }    
  133.     /**
  134.      * The label text to display next to this field (defaults to '')
  135.      * @return string 
  136.      */
  137.     public function getFieldLabel({
  138.         return $this->getExtConfigProperty("fieldLabel");
  139.     }
  140.     
  141.     // FocusCssClass
  142.     /**
  143.      * The CSS class to use when the field receives focus (defaults to "x-form-focus")
  144.      * @param string $value 
  145.      * @return PhpExt_Form_Field 
  146.      */
  147.     public function setFocusCssClass($value{
  148.         $this->setExtConfigProperty("focusClass"$value);
  149.         return $this;
  150.     }    
  151.     /**
  152.      * The CSS class to use when the field receives focus (defaults to "x-form-focus")
  153.      * @return string 
  154.      */
  155.     public function getFocusCssClass({
  156.         return $this->getExtConfigProperty("focusClass");
  157.     }
  158.     
  159.     // HideLabel
  160.     /**
  161.      * True to completely hide the label element (defaults to false)
  162.      * @param boolean $value 
  163.      * @return PhpExt_Form_Field 
  164.      */
  165.     public function setHideLabel($value{
  166.         $this->setExtConfigProperty("hideLabel"$value);
  167.         return $this;
  168.     }    
  169.     /**
  170.      * True to completely hide the label element (defaults to false)
  171.      * @return boolean 
  172.      */
  173.     public function getHideLabel({
  174.         return $this->getExtConfigProperty("hideLabel");
  175.     }
  176.     
  177.     // InputType
  178.     /**
  179.      * The type attribute for input fields -- e.g. radio, text, password (defaults to "text").
  180.      * @param string $value 
  181.      * @return PhpExt_Form_Field 
  182.      */
  183.     public function setInputType($value{
  184.         $this->setExtConfigProperty("inputType"$value);
  185.         return $this;
  186.     }    
  187.     /**
  188.      * The type attribute for input fields -- e.g. radio, text, password (defaults to "text").
  189.      * @return string 
  190.      */
  191.     public function getInputType({
  192.         return $this->getExtConfigProperty("inputType");
  193.     }
  194.     
  195.     // InvalidCssClass
  196.     /**
  197.      * The CSS class to use when marking a field invalid (defaults to "x-form-invalid")
  198.      * @param string $value 
  199.      * @return PhpExt_Form_Field 
  200.      */
  201.     public function setInvalidCssClass($value{
  202.         $this->setExtConfigProperty("invalidClass"$value);
  203.         return $this;
  204.     }    
  205.     /**
  206.      * The CSS class to use when marking a field invalid (defaults to "x-form-invalid")
  207.      * @return string 
  208.      */
  209.     public function getInvalidCssClass({
  210.         return $this->getExtConfigProperty("invalidClass");
  211.     }
  212.     
  213.     // InvalidText
  214.     /**
  215.      * The error text to use when marking a field invalid and no message is provided (defaults to "The value in this field is invalid")
  216.      * @param string $value 
  217.      * @return PhpExt_Form_Field 
  218.      */
  219.     public function setInvalidText($value{
  220.         $this->setExtConfigProperty("invalidText"$value);
  221.         return $this;
  222.     }    
  223.     /**
  224.      * The error text to use when marking a field invalid and no message is provided (defaults to "The value in this field is invalid")
  225.      * @return string 
  226.      */
  227.     public function getInvalidText({
  228.         return $this->getExtConfigProperty("invalidText");
  229.     }
  230.     
  231.     // ItemCssClass
  232.     /**
  233.      * An additional CSS class to apply to this field (defaults to the container's itemCls value if set, or '')
  234.      * @param boolean $value 
  235.      * @return PhpExt_Form_Field 
  236.      */
  237.     public function setItemCssClass($value{
  238.         $this->setExtConfigProperty("itemCls"$value);
  239.         return $this;
  240.     }    
  241.     /**
  242.      * An additional CSS class to apply to this field (defaults to the container's itemCls value if set, or '')
  243.      * @return boolean 
  244.      */
  245.     public function getItemCssClass({
  246.         return $this->getExtConfigProperty("itemCls");
  247.     }
  248.     
  249.     // LabelSeparator
  250.     /**
  251.      * The standard separator to display after the text of each form label (defaults to the value of Ext.layout.FormLayout.labelSeparator, which is a colon ':' by default). To display no separator for this field's label specify empty string ''.
  252.      * @param string $value 
  253.      * @return PhpExt_Form_Field 
  254.      */
  255.     public function setLabelSeparator($value{
  256.         $this->setExtConfigProperty("labelSeparator"$value);
  257.         return $this;
  258.     }    
  259.     /**
  260.      * The standard separator to display after the text of each form label (defaults to the value of Ext.layout.FormLayout.labelSeparator, which is a colon ':' by default). To display no separator for this field's label specify empty string ''.
  261.      * @return string 
  262.      */
  263.     public function getLabelSeparator({
  264.         return $this->getExtConfigProperty("labelSeparator");
  265.     }
  266.     
  267.     // LabelCssStyle
  268.     /**
  269.      * A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if set, or ''). For example: 'font-weight:bold;'.
  270.      * @param string $value 
  271.      * @return PhpExt_Form_Field 
  272.      */
  273.     public function setLabelCssStyle($value{
  274.         $this->setExtConfigProperty("labelStyle"$value);
  275.         return $this;
  276.     }    
  277.     /**
  278.      * A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if set, or ''). For example: 'font-weight:bold;'.
  279.      * @return string 
  280.      */
  281.     public function getLabelCssStyle({
  282.         return $this->getExtConfigProperty("labelStyle");
  283.     }
  284.     
  285.     // MsgFx
  286.     /**
  287.      * Experimental The effect used when displaying a validation message under the field (defaults to 'normal').
  288.      * @param boolean $value 
  289.      * @return PhpExt_Form_Field 
  290.      */
  291.     public function setMsgFx($value{
  292.         $this->setExtConfigProperty("msgFx"$value);
  293.         return $this;
  294.     }    
  295.     /**
  296.      * Experimental The effect used when displaying a validation message under the field (defaults to 'normal').
  297.      * @return boolean 
  298.      */
  299.     public function getMsgFx({
  300.         return $this->getExtConfigProperty("msgFx");
  301.     }
  302.     
  303.     // MsgTarget
  304.     /**
  305.      * The location where error text should display. Should be one of the following values (defaults to 'qtip'):
  306.      * <pre>
  307.      * Value                                           Description
  308.      * --------------------------------------------    ----------------------------------------------------------------------
  309.      * PhpExt_Form_FormPanel::MSG_TARGET_QTIP          Display a quick tip when the user hovers over the field
  310.      * PhpExt_Form_FormPanel::MSG_TARGET_TITLE         Display a default browser title attribute popup
  311.      * PhpExt_Form_FormPanel::MSG_TARGET_UNDER         Add a block div beneath the field containing the error text
  312.      * PhpExt_Form_FormPanel::MSG_TARGET_SIDE          Add an error icon to the right of the field with a popup on hover
  313.      * [element id]                                    Add the error text directly to the innerHTML of the specified element
  314.      * </pre>
  315.      * @uses PhpExt_Form_FormPanel::MSG_TARGET_QTIP
  316.      * @uses PhpExt_Form_FormPanel::MSG_TARGET_TITLE
  317.      * @uses PhpExt_Form_FormPanel::MSG_TARGET_UNDER
  318.      * @uses PhpExt_Form_FormPanel::MSG_TARGET_SIDE
  319.      * @param string $value 
  320.      * @return PhpExt_Form_Field 
  321.      */
  322.     public function setMsgTarget($value{
  323.         $this->setExtConfigProperty("msgTarget"$value);
  324.         return $this;
  325.     }    
  326.     /**
  327.      * The location where error text should display. Should be one of the following values (defaults to 'qtip'):
  328.      * <pre>
  329.      * Value                                           Description
  330.      * --------------------------------------------    ----------------------------------------------------------------------
  331.      * PhpExt_Form_FormPanel::MSG_TARGET_QTIP          Display a quick tip when the user hovers over the field
  332.      * PhpExt_Form_FormPanel::MSG_TARGET_TITLE         Display a default browser title attribute popup
  333.      * PhpExt_Form_FormPanel::MSG_TARGET_UNDER         Add a block div beneath the field containing the error text
  334.      * PhpExt_Form_FormPanel::MSG_TARGET_SIDE          Add an error icon to the right of the field with a popup on hover
  335.      * [element id]                                    Add the error text directly to the innerHTML of the specified element
  336.      * </pre>
  337.      * @uses PhpExt_Form_FormPanel::MSG_TARGET_QTIP
  338.      * @uses PhpExt_Form_FormPanel::MSG_TARGET_TITLE
  339.      * @uses PhpExt_Form_FormPanel::MSG_TARGET_UNDER
  340.      * @uses PhpExt_Form_FormPanel::MSG_TARGET_SIDE
  341.      * @return string 
  342.      */
  343.     public function getMsgTarget({
  344.         return $this->getExtConfigProperty("msgTarget");
  345.     }
  346.     
  347.     // Name
  348.     /**
  349.      * The field's HTML name attribute.
  350.      * @param string $value 
  351.      * @return PhpExt_Form_Field 
  352.      */
  353.     public function setName($value{
  354.         $this->setExtConfigProperty("name"$value);
  355.         return $this;
  356.     }    
  357.     /**
  358.      * The field's HTML name attribute.
  359.      * @return string 
  360.      */
  361.     public function getName({
  362.         return $this->getExtConfigProperty("name");
  363.     }
  364.     
  365.     // ReadOnly
  366.     /**
  367.      * True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.
  368.      * @param boolean $value 
  369.      * @return PhpExt_Form_Field 
  370.      */
  371.     public function setReadOnly($value{
  372.         $this->setExtConfigProperty("readOnly"$value);
  373.         return $this;
  374.     }    
  375.     /**
  376.      * True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.
  377.      * @return boolean 
  378.      */
  379.     public function getReadOnly({
  380.         return $this->getExtConfigProperty("readOnly");
  381.     }
  382.     
  383.     // TabIndex
  384.     /**
  385.      * The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).
  386.      * @param integer $value 
  387.      * @return PhpExt_Form_Field 
  388.      */
  389.     public function setTabIndex($value{
  390.         $this->setExtConfigProperty("tabIndex"$value);
  391.         return $this;
  392.     }    
  393.     /**
  394.      * The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).
  395.      * @return integer 
  396.      */
  397.     public function getTabIndex({
  398.         return $this->getExtConfigProperty("tabIndex");
  399.     }
  400.     
  401.     // ValidateOnBlur
  402.     /**
  403.      * Whether the field should validate when it loses focus (defaults to true).
  404.      * @param boolean $value 
  405.      * @return PhpExt_Form_Field 
  406.      */
  407.     public function setValidateOnBlur($value{
  408.         $this->setExtConfigProperty("validateOnBlur"$value);
  409.         return $this;
  410.     }    
  411.     /**
  412.      * Whether the field should validate when it loses focus (defaults to true).
  413.      * @return boolean 
  414.      */
  415.     public function getValidateOnBlur({
  416.         return $this->getExtConfigProperty("validateOnBlur");
  417.     }
  418.     
  419.     // ValidationDelay
  420.     /**
  421.      * The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)
  422.      * @param integer $value 
  423.      * @return PhpExt_Form_Field 
  424.      */
  425.     public function setValidationDelay($value{
  426.         $this->setExtConfigProperty("validationDelay"$value);
  427.         return $this;
  428.     }    
  429.     /**
  430.      * The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)
  431.      * @return integer 
  432.      */
  433.     public function getValidationDelay({
  434.         return $this->getExtConfigProperty("validationDelay");
  435.     }
  436.     
  437.     // ValidationEvent
  438.     /**
  439.      * The event that should initiate field validation. Set to false to disable automatic validation (defaults to "keyup").
  440.      * @param string|boolean$value 
  441.      * @return PhpExt_Form_Field 
  442.      */
  443.     public function setValidationEvent($value{
  444.         $this->setExtConfigProperty("validationEvent"$value);
  445.         return $this;
  446.     }    
  447.     /**
  448.      * The event that should initiate field validation. Set to false to disable automatic validation (defaults to "keyup").
  449.      * @return string|boolean
  450.      */
  451.     public function getValidationEvent({
  452.         return $this->getExtConfigProperty("validationEvent");
  453.     }
  454.     
  455.     // Value
  456.     /**
  457.      * A value to initialize this field with.
  458.      * @param mixed $value 
  459.      * @return PhpExt_Form_Field 
  460.      */
  461.     public function setValue($value{
  462.         $this->setExtConfigProperty("value"$value);
  463.         return $this;
  464.     }    
  465.     /**
  466.      * A value to initialize this field with.
  467.      * @return mixed 
  468.      */
  469.     public function getValue({
  470.         return $this->getExtConfigProperty("value");
  471.     }
  472.             
  473.     
  474.     public function __construct({
  475.         parent::__construct();
  476.         $this->setExtClassInfo("Ext.form.Field","field");
  477.         
  478.         $validProps array(
  479.             "autoCreate",
  480.             "clearCls",
  481.             "cls",
  482.             "disabled",
  483.             "fieldClass",
  484.             "fieldLabel",
  485.             "focusClass",
  486.             "hideLabel",
  487.             "inputType",
  488.             "invalidClass",
  489.             "invalidText",
  490.             "itemCls",
  491.             "labelSeparator",
  492.             "labelStyle",
  493.             "msgFx",
  494.             "msgTarget",
  495.             "name",
  496.             "readOnly",
  497.             "tabIndex",
  498.             "validateOnBlur",
  499.             "validationDelay",
  500.             "validationEvent",
  501.             "value"
  502.         );
  503.         $this->addValidConfigProperties($validProps);
  504.     }    
  505.         
  506.      
  507.     
  508. }

Documentation generated on Fri, 08 Aug 2008 15:53:25 -0500 by phpDocumentor 1.4.0