Class TTextBox

Description

Implements interfaces:

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 Text property. You can create a SingleLine, a MultiLine, or a Password text box by setting the TextMode property. If the TTextBox control is a multiline text box, the number of rows it displays is determined by the Rows property, and the 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 Columns property. To prevent the text displayed in the component from being modified, set the ReadOnly property to true. If you want to limit the user input to a specified number of characters, set the MaxLength property. To use AutoComplete feature, set the AutoCompleteType property.

If AutoPostBack is set true, updating the text box and then changing the focus out of it will cause postback action. And if CausesValidation is true, validation will also be processed, which can be further restricted within a 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 SafeText to prevent this problem.

NOTE: If you set Wrap to false or use 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: TTextBox.php 3137 2012-05-10 21:09:10Z ctrlaltca $
  • since: 3.0

Located in /Web/UI/WebControls/TTextBox.php (line 51)

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --TWebControl
            |
            --TTextBox
Direct descendents
Class Description
TActiveTextBox TActiveTextBox class.
TColorPicker TColorPicker class.
TDatePicker TDatePicker class.
THtmlArea THtmlArea class
Class Constant Summary
Method Summary
boolean getAutoPostBack ()
boolean getAutoTrim ()
boolean getCausesValidation ()
string getClientClassName ()
integer getColumns ()
string getData ()
boolean getDataChanged ()
bool getIsValid ()
integer getMaxLength ()
boolean getPersistPassword ()
boolean getReadOnly ()
integer getRows ()
string getSafeText ()
string getTagName ()
string getText ()
string getValidationGroup ()
boolean getWrap ()
boolean loadPostData (string $key, array $values)
void renderBeginTag (THtmlWriter $writer)
void renderClientControlScript ( $writer)
void renderContents (THtmlWriter $writer)
void setAutoPostBack (boolean $value)
void setAutoTrim (boolean $value)
void setCausesValidation (boolean $value)
void setColumns (integer $value)
void setData (string $value)
void setEnableClientScript (boolean $value)
void setIsValid (bool $value)
void setMaxLength (integer $value)
void setPersistPassword (boolean $value)
void setReadOnly (boolean $value)
void setRows (integer $value)
void setText (string $value)
void setTextMode (TTextBoxMode $value)
void setValidationGroup (string $value)
void setWrap (boolean $value)
Variables

Inherited Variables

Inherited from TWebControl

TWebControl::$_decorator
Methods
addAttributesToRender (line 101)

Adds attribute name-value pairs to renderer.

This method overrides the parent implementation with additional textbox specific attributes.

  • access: protected
void addAttributesToRender (THtmlWriter $writer)
  • THtmlWriter $writer: the writer used for the rendering purpose

Redefinition of:
TWebControl::addAttributesToRender()
Adds attribute name-value pairs to renderer.

Redefined in descendants as:
getAutoCompleteType (line 318)
  • return: the AutoComplete type of the textbox
  • access: public
TTextBoxAutoCompleteType getAutoCompleteType ()
getAutoPostBack (line 337)
  • return: 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.
  • access: public
boolean getAutoPostBack ()

Redefined in descendants as:
getAutoTrim (line 356)
  • return: a value indicating whether the input text should be trimmed spaces. Defaults to false.
  • access: public
boolean getAutoTrim ()
getCausesValidation (line 373)
  • return: whether postback event trigger by this text box will cause input validation, default is true.
  • access: public
boolean getCausesValidation ()
getClientClassName (line 188)

Gets the name of the javascript class responsible for performing postback for this control.

This method overrides the parent implementation.

  • return: the javascript class name
  • access: protected
string getClientClassName ()

Redefined in descendants as:
getColumns (line 389)
  • return: the display width of the text box in characters, default is 0 meaning not set.
  • access: public
integer getColumns ()
getData (line 495)

Returns the text content of the TTextBox control.

This method is required by IDataRenderer. It is the same as getText().

  • return: the text content of the TTextBox control.
  • see: TTextBox::getText()
  • since: 3.1.0
  • access: public
string getData ()

Redefined in descendants as:
getDataChanged (line 234)

Returns a value indicating whether postback has caused the control data change.

This method is required by the IPostBackDataHandler interface.

  • return: whether postback has caused the control data change. False if the page is not in postback mode.
  • access: public
boolean getDataChanged ()
getEnableClientScript (line 83)
  • return: whether to render javascript.
  • access: public
boolean getEnableClientScript ()
getIsValid (line 254)

Returns true if this control validated successfully.

Defaults to true.

  • return: wether this control validated successfully.
  • access: public
bool getIsValid ()
getMaxLength (line 406)
  • return: the maximum number of characters allowed in the text box, default is 0 meaning not set.
  • access: public
integer getMaxLength ()
getPersistPassword (line 456)
  • return: whether password should be displayed in the textbox during postback. Defaults to false. This property only applies when TextMode='Password'.
  • access: public
boolean getPersistPassword ()
getPostBackOptions (line 197)

Gets the post back options for this textbox.

  • access: protected
array getPostBackOptions ()

Redefined in descendants as:
getReadOnly (line 423)
  • return: whether the textbox is read only, default is false.
  • access: public
boolean getReadOnly ()
getRows (line 439)
  • return: the number of rows displayed in a multiline text box, default is 4
  • access: public
integer getRows ()
getSafeText (line 516)
  • return: safe text content with javascript stripped off
  • access: public
string getSafeText ()
getSafeTextParser (line 526)
  • return: safe text parser
  • access: protected
mixed getSafeTextParser ()
getTagName (line 75)
  • return: tag name of the textbox
  • access: protected
string getTagName ()

Redefinition of:
TWebControl::getTagName()
Returns the tag name used for this control.

Redefined in descendants as:
getText (line 472)
  • return: the text content of the TTextBox control.
  • access: public
string getText ()
getTextMode (line 536)
  • return: the behavior mode of the TTextBox component. Defaults to TTextBoxMode::SingleLine.
  • access: public
TTextBoxMode getTextMode ()

Redefined in descendants as:
getValidationGroup (line 554)
  • return: the group of validators which the text box causes validation upon postback
  • access: public
string getValidationGroup ()
getValidationPropertyValue (line 244)

Returns the value to be validated.

This methid is required by IValidatable interface.

  • return: the value of the property to be validated.
  • access: public
mixed getValidationPropertyValue ()

Redefined in descendants as:
getWrap (line 570)
  • return: whether the text content wraps within a multiline text box. Defaults to true.
  • access: public
boolean getWrap ()
loadPostData (line 215)

Loads user input data.

This method is primarly used by framework developers.

  • return: whether the data of the component has been changed
  • access: public
boolean loadPostData (string $key, array $values)
  • string $key: the key that can be used to retrieve data from the input data collection
  • array $values: the input data collection

Redefined in descendants as:
  • TDatePicker::loadPostData() : Loads user input data. Override parent implementation, when InputMode is DropDownList call getDateFromPostData to get date data.
onTextChanged (line 274)

Raises OnTextChanged event.

This method is invoked when the value of the 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.

  • access: public
void onTextChanged (TEventParameter $param)
  • TEventParameter $param: event parameter to be passed to the event handlers
raisePostDataChangedEvent (line 286)

Raises postdata changed event.

This method is required by IPostBackDataHandler interface. It is invoked by the framework when Text property is changed on postback. This method is primarly used by framework developers.

  • access: public
void raisePostDataChangedEvent ()
renderBeginTag (line 308)

Renders an additional line-break after the opening tag when it is in MultiLine text mode.

  • access: public
void renderBeginTag (THtmlWriter $writer)
  • THtmlWriter $writer: the writer used for the rendering purpose^M

Redefinition of:
TWebControl::renderBeginTag()
Renders the openning tag for the control (including attributes)
renderClientControlScript (line 176)

Renders the javascript for textbox.

  • access: protected
void renderClientControlScript ( $writer)
  • $writer

Redefined in descendants as:
renderContents (line 297)

Renders the body content of the textbox when it is in MultiLine text mode.

  • access: public
void renderContents (THtmlWriter $writer)

Redefinition of:
TWebControl::renderContents()
Renders the body content enclosed between the control tag.

Redefined in descendants as:
setAutoCompleteType (line 327)
  • throws: TInvalidDataValueException if the input parameter is not a valid AutoComplete type
  • access: public
void setAutoCompleteType (TTextBoxAutoCompleteType $value)
  • TTextBoxAutoCompleteType $value: the AutoComplete type of the textbox, default value is TTextBoxAutoCompleteType::None.
setAutoPostBack (line 348)

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.

  • access: public
void setAutoPostBack (boolean $value)
  • boolean $value: the value indicating if postback automatically

Redefined in descendants as:
setAutoTrim (line 365)

Sets the value indicating if the input text should be trimmed spaces

  • access: public
void setAutoTrim (boolean $value)
  • boolean $value: the value indicating if the input text should be trimmed spaces
setCausesValidation (line 381)
  • access: public
void setCausesValidation (boolean $value)
  • boolean $value: whether postback event trigger by this text box will cause input validation.
setColumns (line 398)

Sets the display width of the text box in characters.

  • access: public
void setColumns (integer $value)
  • integer $value: the display width, set it 0 to clear the setting
setData (line 508)

Sets the text content of the TTextBox control.

This method is required by IDataRenderer. It is the same as setText().

void setData (string $value)
  • string $value: the text content of the TTextBox control.

Redefined in descendants as:
setEnableClientScript (line 91)
  • access: public
void setEnableClientScript (boolean $value)
  • boolean $value: whether to render javascript.
setIsValid (line 261)
  • access: public
void setIsValid (bool $value)
  • bool $value: wether this control is valid.
setMaxLength (line 415)

Sets the maximum number of characters allowed in the text box.

  • access: public
void setMaxLength (integer $value)
  • integer $value: the maximum length, set it 0 to clear the setting
setPersistPassword (line 464)
  • access: public
void setPersistPassword (boolean $value)
  • boolean $value: whether password should be displayed in the textbox during postback. This property only applies when TextMode='Password'.
setReadOnly (line 431)
  • access: public
void setReadOnly (boolean $value)
  • boolean $value: whether the textbox is read only

Redefined in descendants as:
setRows (line 448)

Sets the number of rows displayed in a multiline text box.

  • access: public
void setRows (integer $value)
  • integer $value: the number of rows
setText (line 481)

Sets the text content of the TTextBox control.

  • access: public
void setText (string $value)
  • string $value: the text content

Redefined in descendants as:
setTextMode (line 546)

Sets the behavior mode of the TTextBox component.

  • throws: TInvalidDataValueException if the input value is not a valid text mode.
  • access: public
void setTextMode (TTextBoxMode $value)

Redefined in descendants as:
setValidationGroup (line 562)
  • access: public
void setValidationGroup (string $value)
  • string $value: the group of validators which the text box causes validation upon postback
setWrap (line 579)

Sets the value indicating whether the text content wraps within a multiline text box.

  • access: public
void setWrap (boolean $value)
  • boolean $value: whether the text content wraps within a multiline text box.

Inherited Methods

Inherited From TWebControl

TWebControl::addAttributesToRender()
TWebControl::clearStyle()
TWebControl::copyBaseAttributes()
TWebControl::createStyle()
TWebControl::getAccessKey()
TWebControl::getBackColor()
TWebControl::getBorderColor()
TWebControl::getBorderStyle()
TWebControl::getBorderWidth()
TWebControl::getCssClass()
TWebControl::getDecorator()
TWebControl::getDisplay()
TWebControl::getEnsureId()
TWebControl::getFont()
TWebControl::getForeColor()
TWebControl::getHasStyle()
TWebControl::getHeight()
TWebControl::getStyle()
TWebControl::getTabIndex()
TWebControl::getTagName()
TWebControl::getToolTip()
TWebControl::getWidth()
TWebControl::onPreRender()
TWebControl::render()
TWebControl::renderBeginTag()
TWebControl::renderContents()
TWebControl::renderEndTag()
TWebControl::setAccessKey()
TWebControl::setBackColor()
TWebControl::setBorderColor()
TWebControl::setBorderStyle()
TWebControl::setBorderWidth()
TWebControl::setCssClass()
TWebControl::setDisplay()
TWebControl::setEnsureId()
TWebControl::setForeColor()
TWebControl::setHeight()
TWebControl::setStyle()
TWebControl::setTabIndex()
TWebControl::setToolTip()
TWebControl::setWidth()

Inherited From TControl

TControl::__construct()
TControl::addedControl()
TControl::addParsedObject()
TControl::addToPostDataLoader()
TControl::applyStyleSheetSkin()
TControl::autoBindProperty()
TControl::autoDataBindProperties()
TControl::bindProperty()
TControl::broadcastEvent()
TControl::bubbleEvent()
TControl::clearChildState()
TControl::clearControlState()
TControl::clearNamingContainer()
TControl::clearViewState()
TControl::convertUniqueIdToClientId()
TControl::createChildControls()
TControl::createControlCollection()
TControl::dataBind()
TControl::dataBindChildren()
TControl::dataBindProperties()
TControl::ensureChildControls()
TControl::findControl()
TControl::findControlsByID()
TControl::findControlsByType()
TControl::focus()
TControl::getAdapter()
TControl::getAllowChildControls()
TControl::getAttribute()
TControl::getAttributes()
TControl::getChildControlsCreated()
TControl::getClientID()
TControl::getControls()
TControl::getControlStage()
TControl::getControlState()
TControl::getCustomData()
TControl::getEnabled()
TControl::getEnableTheming()
TControl::getEnableViewState()
TControl::getHasAdapter()
TControl::getHasAttributes()
TControl::getHasChildInitialized()
TControl::getHasControls()
TControl::getHasInitialized()
TControl::getHasLoaded()
TControl::getHasLoadedPostData()
TControl::getHasPreRendered()
TControl::getID()
TControl::getIsSkinApplied()
TControl::getNamingContainer()
TControl::getPage()
TControl::getParent()
TControl::getRegisteredObject()
TControl::getSkinID()
TControl::getSourceTemplateControl()
TControl::getTemplateControl()
TControl::getUniqueID()
TControl::getViewState()
TControl::getVisible()
TControl::hasAttribute()
TControl::initRecursive()
TControl::isDescendentOf()
TControl::isObjectRegistered()
TControl::loadRecursive()
TControl::loadState()
TControl::loadStateRecursive()
TControl::onDataBinding()
TControl::onInit()
TControl::onLoad()
TControl::onPreRender()
TControl::onUnload()
TControl::preRenderRecursive()
TControl::raiseBubbleEvent()
TControl::registerObject()
TControl::removeAttribute()
TControl::removedControl()
TControl::render()
TControl::renderChildren()
TControl::renderControl()
TControl::saveState()
TControl::saveStateRecursive()
TControl::setAdapter()
TControl::setAttribute()
TControl::setChildControlsCreated()
TControl::setControlStage()
TControl::setControlState()
TControl::setCustomData()
TControl::setEnabled()
TControl::setEnableTheming()
TControl::setEnableViewState()
TControl::setID()
TControl::setPage()
TControl::setSkinID()
TControl::setTemplateControl()
TControl::setViewState()
TControl::setVisible()
TControl::trackViewState()
TControl::traverseChildControls()
TControl::unbindProperty()
TControl::unloadRecursive()
TControl::unregisterObject()
TControl::__get()

Inherited From TApplicationComponent

TApplicationComponent::getApplication()
TApplicationComponent::getRequest()
TApplicationComponent::getResponse()
TApplicationComponent::getService()
TApplicationComponent::getSession()
TApplicationComponent::getUser()
TApplicationComponent::publishAsset()
TApplicationComponent::publishFilePath()

Inherited From TComponent

TComponent::addParsedObject()
TComponent::attachEventHandler()
TComponent::canGetProperty()
TComponent::canSetProperty()
TComponent::createdOnTemplate()
TComponent::detachEventHandler()
TComponent::evaluateExpression()
TComponent::evaluateStatements()
TComponent::getEventHandlers()
TComponent::getSubProperty()
TComponent::hasEvent()
TComponent::hasEventHandler()
TComponent::hasProperty()
TComponent::raiseEvent()
TComponent::setSubProperty()
TComponent::__call()
TComponent::__get()
TComponent::__set()
TComponent::__sleep()
TComponent::__wakeup()
Class Constants

Documentation generated on Mon, 25 Jun 2012 14:39:28 +0200 by phpDocumentor 1.4.3