<?php /** * TTextBox class file. * * @author Qiang Xue <qiang.xue@gmail.com> * @link http://www.pradosoft.com/ * @copyright Copyright © 2005-2008 PradoSoft * @license http://www.pradosoft.com/license/ * @version $Id$ * @package System.Web.UI.WebControls */ /** * TTextBox class * * TTextBox displays a text box on the Web page for user input. * The text displayed in the TTextBox control is determined by the * {@link setText Text} property. You can create a <b>SingleLine</b>, * a <b>MultiLine</b>, or a <b>Password</b> text box by setting * the {@link setTextMode TextMode} property. If the TTextBox control * is a multiline text box, the number of rows it displays is determined * by the {@link setRows Rows} property, and the {@link setWrap Wrap} property * can be used to determine whether to wrap the text in the component. * * To specify the display width of the text box, in characters, set * the {@link setColumns Columns} property. To prevent the text displayed * in the component from being modified, set the {@link setReadOnly ReadOnly} * property to true. If you want to limit the user input to a specified number * of characters, set the {@link setMaxLength MaxLength} property. * To use AutoComplete feature, set the {@link setAutoCompleteType AutoCompleteType} property. * * If {@link setAutoPostBack AutoPostBack} is set true, updating the text box * and then changing the focus out of it will cause postback action. * And if {@link setCausesValidation CausesValidation} is true, validation will * also be processed, which can be further restricted within * a {@link setValidationGroup ValidationGroup}. * * WARNING: Be careful if you want to display the text collected via TTextBox. * Malicious cross-site script may be injected in. You may use {@link getSafeText SafeText} * to prevent this problem. * * NOTE: If you set {@link setWrap Wrap} to false or use {@link setAutoCompleteType AutoCompleteType}, * the generated HTML output for the textbox will not be XHTML-compatible. * Currently, no alternatives are available. * * @author Qiang Xue <qiang.xue@gmail.com> * @version $Id$ * @package System.Web.UI.WebControls * @since 3.0 */ class TTextBox extends TWebControl implements IPostBackDataHandler, IValidatable, IDataRenderer { /** * Default number of rows (for MultiLine text box) */ const DEFAULT_ROWS=4; /** * Default number of columns (for MultiLine text box) */ const DEFAULT_COLUMNS=20; /** * @var mixed safe text parser */ private static $_safeTextParser=null; /** * @var string safe textbox content with javascript stripped off */ private $_safeText; private $_dataChanged=false; private $_isValid=true; /** * @return string tag name of the textbox */ protected function getTagName() { return ($this->getTextMode()==='MultiLine')?'textarea':'input'; } /** * @return boolean whether to render javascript. */ public function getEnableClientScript() { return $this->getViewState('EnableClientScript',true); } /** * @param boolean whether to render javascript. */ public function setEnableClientScript($value) { $this->setViewState('EnableClientScript',TPropertyValue::ensureBoolean($value),true); } /** * Adds attribute name-value pairs to renderer. * This method overrides the parent implementation with additional textbox specific attributes. * @param THtmlWriter the writer used for the rendering purpose */ protected function addAttributesToRender($writer) { $page=$this->getPage(); $page->ensureRenderInForm($this); if(($uid=$this->getUniqueID())!=='') $writer->addAttribute('name',$uid); if(($textMode=$this->getTextMode())===TTextBoxMode::MultiLine) { if(($rows=$this->getRows())<=0) $rows=self::DEFAULT_ROWS; if(($cols=$this->getColumns())<=0) $cols=self::DEFAULT_COLUMNS; $writer->addAttribute('rows',"$rows"); $writer->addAttribute('cols',"$cols"); if(!$this->getWrap()) $writer->addAttribute('wrap','off'); } else { if($textMode===TTextBoxMode::SingleLine) { $writer->addAttribute('type','text'); if(($text=$this->getText())!=='') $writer->addAttribute('value',$text); } else { if($this->getPersistPassword() && ($text=$this->getText())!=='') $writer->addAttribute('value',$text); $writer->addAttribute('type','password'); } if(($act=$this->getAutoCompleteType())!=='None') { if($act==='Disabled') $writer->addAttribute('autocomplete','off'); else if($act==='Search') $writer->addAttribute('vcard_name','search'); else if($act==='HomeCountryRegion') $writer->addAttribute('vcard_name','HomeCountry'); else if($act==='BusinessCountryRegion') $writer->addAttribute('vcard_name','BusinessCountry'); else { if(strpos($act,'Business')===0) $act='Business'.'.'.substr($act,8); else if(strpos($act,'Home')===0) $act='Home'.'.'.substr($act,4); $writer->addAttribute('vcard_name','vCard.'.$act); } } if(($cols=$this->getColumns())>0) $writer->addAttribute('size',"$cols"); if(($maxLength=$this->getMaxLength())>0) $writer->addAttribute('maxlength',"$maxLength"); } if($this->getReadOnly()) $writer->addAttribute('readonly','readonly'); $isEnabled=$this->getEnabled(true); if(!$isEnabled && $this->getEnabled()) // in this case parent will not render 'disabled' $writer->addAttribute('disabled','disabled'); if($isEnabled && $this->getEnableClientScript() && ( $this->getAutoPostBack() || $textMode===TTextBoxMode::SingleLine) && $page->getClientSupportsJavaScript()) { $this->renderClientControlScript($writer); } parent::addAttributesToRender($writer); } /** * Renders the javascript for textbox. */ protected function renderClientControlScript($writer) { $writer->addAttribute('id',$this->getClientID()); $cs = $this->getPage()->getClientScript(); $cs->registerPostBackControl($this->getClientClassName(),$this->getPostBackOptions()); } /** * Gets the name of the javascript class responsible for performing postback for this control. * This method overrides the parent implementation. * @return string the javascript class name */ protected function getClientClassName() { return 'Prado.WebUI.TTextBox'; } /** * Gets the post back options for this textbox. * @return array */ protected function getPostBackOptions() { $options['ID'] = $this->getClientID(); $options['EventTarget'] = $this->getUniqueID(); $options['AutoPostBack'] = $this->getAutoPostBack(); $options['CausesValidation'] = $this->getCausesValidation(); $options['ValidationGroup'] = $this->getValidationGroup(); $options['TextMode'] = $this->getTextMode(); return $options; } /** * Loads user input data. * This method is primarly used by framework developers. * @param string the key that can be used to retrieve data from the input data collection * @param array the input data collection * @return boolean whether the data of the component has been changed */ public function loadPostData($key,$values) { $value=$values[$key]; if($this->getAutoTrim()) $value=trim($value); if(!$this->getReadOnly() && $this->getText()!==$value) { $this->setText($value); return $this->_dataChanged=true; } else return false; } /** * Returns a value indicating whether postback has caused the control data change. * This method is required by the IPostBackDataHandler interface. * @return boolean whether postback has caused the control data change. False if the page is not in postback mode. */ public function getDataChanged() { return $this->_dataChanged; } /** * Returns the value to be validated. * This methid is required by IValidatable interface. * @return mixed the value of the property to be validated. */ public function getValidationPropertyValue() { return $this->getText(); } /** * Returns true if this control validated successfully. * Defaults to true. * @return bool wether this control validated successfully. */ public function getIsValid() { return $this->_isValid; } /** * @param bool wether this control is valid. */ public function setIsValid($value) { $this->_isValid=TPropertyValue::ensureBoolean($value); } /** * Raises <b>OnTextChanged</b> event. * This method is invoked when the value of the {@link getText Text} * property changes on postback. * If you override this method, be sure to call the parent implementation to ensure * the invocation of the attached event handlers. * @param TEventParameter event parameter to be passed to the event handlers */ public function onTextChanged($param) { $this->raiseEvent('OnTextChanged',$this,$param); } /** * Raises postdata changed event. * This method is required by {@link IPostBackDataHandler} interface. * It is invoked by the framework when {@link getText Text} property * is changed on postback. * This method is primarly used by framework developers. */ public function raisePostDataChangedEvent() { if($this->getAutoPostBack() && $this->getCausesValidation()) $this->getPage()->validate($this->getValidationGroup()); $this->onTextChanged(null); } /** * Renders the body content of the textbox when it is in MultiLine text mode. * @param THtmlWriter the writer for rendering */ public function renderContents($writer) { if($this->getTextMode()==='MultiLine') $writer->write(THttpUtility::htmlEncode($this->getText())); } /** * Renders an additional line-break after the opening tag when it * is in MultiLine text mode. * @param THtmlWriter the writer used for the rendering purpose^M */ public function renderBeginTag($writer) { parent::renderBeginTag($writer); if($this->getTextMode()==='MultiLine') $writer->write("\n"); } /** * @return TTextBoxAutoCompleteType the AutoComplete type of the textbox */ public function getAutoCompleteType() { return $this->getViewState('AutoCompleteType',TTextBoxAutoCompleteType::None); } /** * @param TTextBoxAutoCompleteType the AutoComplete type of the textbox, default value is TTextBoxAutoCompleteType::None. * @throws TInvalidDataValueException if the input parameter is not a valid AutoComplete type */ public function setAutoCompleteType($value) { $this->setViewState('AutoCompleteType',TPropertyValue::ensureEnum($value,'TTextBoxAutoCompleteType'),TTextBoxAutoCompleteType::None); } /** * @return boolean a value indicating whether an automatic postback to the server * will occur whenever the user modifies the text in the TTextBox control and * then tabs out of the component. Defaults to false. */ public function getAutoPostBack() { return $this->getViewState('AutoPostBack',false); } /** * Sets the value indicating if postback automatically. * An automatic postback to the server will occur whenever the user * modifies the text in the TTextBox control and then tabs out of the component. * @param boolean the value indicating if postback automatically */ public function setAutoPostBack($value) { $this->setViewState('AutoPostBack',TPropertyValue::ensureBoolean($value),false); } /** * @return boolean a value indicating whether the input text should be trimmed spaces. Defaults to false. */ public function getAutoTrim() { return $this->getViewState('AutoTrim',false); } /** * Sets the value indicating if the input text should be trimmed spaces * @param boolean the value indicating if the input text should be trimmed spaces */ public function setAutoTrim($value) { $this->setViewState('AutoTrim',TPropertyValue::ensureBoolean($value),false); } /** * @return boolean whether postback event trigger by this text box will cause input validation, default is true. */ public function getCausesValidation() { return $this->getViewState('CausesValidation',true); } /** * @param boolean whether postback event trigger by this text box will cause input validation. */ public function setCausesValidation($value) { $this->setViewState('CausesValidation',TPropertyValue::ensureBoolean($value),true); } /** * @return integer the display width of the text box in characters, default is 0 meaning not set. */ public function getColumns() { return $this->getViewState('Columns',0); } /** * Sets the display width of the text box in characters. * @param integer the display width, set it 0 to clear the setting */ public function setColumns($value) { $this->setViewState('Columns',TPropertyValue::ensureInteger($value),0); } /** * @return integer the maximum number of characters allowed in the text box, default is 0 meaning not set. */ public function getMaxLength() { return $this->getViewState('MaxLength',0); } /** * Sets the maximum number of characters allowed in the text box. * @param integer the maximum length, set it 0 to clear the setting */ public function setMaxLength($value) { $this->setViewState('MaxLength',TPropertyValue::ensureInteger($value),0); } /** * @return boolean whether the textbox is read only, default is false. */ public function getReadOnly() { return $this->getViewState('ReadOnly',false); } /** * @param boolean whether the textbox is read only */ public function setReadOnly($value) { $this->setViewState('ReadOnly',TPropertyValue::ensureBoolean($value),false); } /** * @return integer the number of rows displayed in a multiline text box, default is 4 */ public function getRows() { return $this->getViewState('Rows',self::DEFAULT_ROWS); } /** * Sets the number of rows displayed in a multiline text box. * @param integer the number of rows */ public function setRows($value) { $this->setViewState('Rows',TPropertyValue::ensureInteger($value),self::DEFAULT_ROWS); } /** * @return boolean whether password should be displayed in the textbox during postback. Defaults to false. This property only applies when TextMode='Password'. */ public function getPersistPassword() { return $this->getViewState('PersistPassword',false); } /** * @param boolean whether password should be displayed in the textbox during postback. This property only applies when TextMode='Password'. */ public function setPersistPassword($value) { $this->setViewState('PersistPassword',TPropertyValue::ensureBoolean($value),false); } /** * @return string the text content of the TTextBox control. */ public function getText() { return $this->getViewState('Text',''); } /** * Sets the text content of the TTextBox control. * @param string the text content */ public function setText($value) { $this->setViewState('Text',$value,''); $this->_safeText = null; } /** * Returns the text content of the TTextBox control. * This method is required by {@link IDataRenderer}. * It is the same as {@link getText()}. * @return string the text content of the TTextBox control. * @see getText * @since 3.1.0 */ public function getData() { return $this->getText(); } /** * Sets the text content of the TTextBox control. * This method is required by {@link IDataRenderer}. * It is the same as {@link setText()}. * @param string the text content of the TTextBox control. * @see setText * @since 3.1.0 */ public function setData($value) { $this->setText($value); } /** * @return string safe text content with javascript stripped off */ public function getSafeText() { if($this->_safeText===null) $this->_safeText=$this->getSafeTextParser()->parse($this->getText()); return $this->_safeText; } /** * @return mixed safe text parser */ protected function getSafeTextParser() { if(!self::$_safeTextParser) self::$_safeTextParser=Prado::createComponent('System.3rdParty.SafeHtml.TSafeHtmlParser'); return self::$_safeTextParser; } /** * @return TTextBoxMode the behavior mode of the TTextBox component. Defaults to TTextBoxMode::SingleLine. */ public function getTextMode() { return $this->getViewState('TextMode',TTextBoxMode::SingleLine); } /** * Sets the behavior mode of the TTextBox component. * @param TTextBoxMode the text mode * @throws TInvalidDataValueException if the input value is not a valid text mode. */ public function setTextMode($value) { $this->setViewState('TextMode',TPropertyValue::ensureEnum($value,'TTextBoxMode'),TTextBoxMode::SingleLine); } /** * @return string the group of validators which the text box causes validation upon postback */ public function getValidationGroup() { return $this->getViewState('ValidationGroup',''); } /** * @param string the group of validators which the text box causes validation upon postback */ public function setValidationGroup($value) { $this->setViewState('ValidationGroup',$value,''); } /** * @return boolean whether the text content wraps within a multiline text box. Defaults to true. */ public function getWrap() { return $this->getViewState('Wrap',true); } /** * Sets the value indicating whether the text content wraps within a multiline text box. * @param boolean whether the text content wraps within a multiline text box. */ public function setWrap($value) { $this->setViewState('Wrap',TPropertyValue::ensureBoolean($value),true); } } /** * TTextBoxMode class. * TTextBoxMode defines the enumerable type for the possible mode * that a {@link TTextBox} control could be at. * * The following enumerable values are defined: * - SingleLine: the textbox will be a regular single line input * - MultiLine: the textbox will be a textarea allowing multiple line input * - Password: the textbox will hide user input like a password input box * * @author Qiang Xue <qiang.xue@gmail.com> * @version $Id$ * @package System.Web.UI.WebControls * @since 3.0.4 */ class TTextBoxMode extends TEnumerable { const SingleLine='SingleLine'; const MultiLine='MultiLine'; const Password='Password'; } /** * TTextBoxAutoCompleteType class. * TTextBoxAutoCompleteType defines the possible AutoComplete type that is supported * by a {@link TTextBox} control. * * @author Qiang Xue <qiang.xue@gmail.com> * @version $Id$ * @package System.Web.UI.WebControls * @since 3.0.4 */ class TTextBoxAutoCompleteType extends TEnumerable { const BusinessCity='BusinessCity'; const BusinessCountryRegion='BusinessCountryRegion'; const BusinessFax='BusinessFax'; const BusinessPhone='BusinessPhone'; const BusinessState='BusinessState'; const BusinessStreetAddress='BusinessStreetAddress'; const BusinessUrl='BusinessUrl'; const BusinessZipCode='BusinessZipCode'; const Cellular='Cellular'; const Company='Company'; const Department='Department'; const Disabled='Disabled'; const DisplayName='DisplayName'; const Email='Email'; const FirstName='FirstName'; const Gender='Gender'; const HomeCity='HomeCity'; const HomeCountryRegion='HomeCountryRegion'; const HomeFax='HomeFax'; const Homepage='Homepage'; const HomePhone='HomePhone'; const HomeState='HomeState'; const HomeStreetAddress='HomeStreetAddress'; const HomeZipCode='HomeZipCode'; const JobTitle='JobTitle'; const LastName='LastName'; const MiddleName='MiddleName'; const None='None'; const Notes='Notes'; const Office='Office'; const Pager='Pager'; const Search='Search'; }