Class \Prado\Web\UI\WebControls\TTextBox

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 \Prado\Web\UI\WebControls\setText property. You can create a SingleLine, a MultiLine, or a Password text box by setting the \Prado\Web\UI\WebControls\setTextMode property. If the TTextBox control is a multiline text box, the number of rows it displays is determined by the \Prado\Web\UI\WebControls\setRows property, and the \Prado\Web\UI\WebControls\setWrap property can be used to determine whether to wrap the text in the component. Additional \Prado\Web\UI\WebControls\setTextMode types enable the use of new input types added with html5, eg. Color, Date, Email.

To specify the display width of the text box, in characters, set the \Prado\Web\UI\WebControls\setColumns property. To prevent the text displayed in the component from being modified, set the \Prado\Web\UI\WebControls\setReadOnly property to true. If you want to limit the user input to a specified number of characters, set the \Prado\Web\UI\WebControls\setMaxLength property. To use AutoComplete feature, set the \Prado\Web\UI\WebControls\setAutoCompleteType property.

If \Prado\Web\UI\WebControls\setAutoPostBack is set true, updating the text box and then changing the focus out of it will cause postback action. And if \Prado\Web\UI\WebControls\setCausesValidation is true, validation will also be processed, which can be further restricted within a \Prado\Web\UI\WebControls\setValidationGroup.

WARNING: Be careful if you want to display the text collected via TTextBox. Malicious cross-site script may be injected in. You may use \Prado\Web\UI\WebControls\getSafeText to prevent this problem.

NOTE: If you set \Prado\Web\UI\WebControls\setWrap to false or use \Prado\Web\UI\WebControls\setAutoCompleteType, the generated HTML output for the textbox will not be XHTML-compatible. Currently, no alternatives are available.

Class hierarchy

\Prado\Web\UI\WebControls\TTextBox implements IPostBackDataHandler, IValidatable, IDataRenderer

\Prado\Web\UI\WebControls\TWebControl implements IStyleable

\Prado\Web\UI\TControl implements IRenderable, IBindable

\Prado\TApplicationComponent

\Prado\TComponent

Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0

Methods summary
`public`	`getAutoCompleteType() : TTextBoxAutoCompleteType`
`public`	`getAutoPostBack() : bool`
`public`	`getAutoTrim() : bool`
`public`	`getCausesValidation() : bool`
`public`	`getColumns() : int`
`public`	`getConfig() : HTMLPurifier_Config`
`public`	`getData() : string` Returns the text content of the TTextBox control. This method is required by IDataRenderer. It is the same as getText().
`public`	`getDataChanged() : bool` Returns a value indicating whether postback has caused the control data change. This method is required by the \Prado\Web\UI\IPostBackDataHandler interface.
`public`	`getEnableClientScript() : bool`
`public`	`getIsValid() : bool` Returns true if this control validated successfully. Defaults to true.
`public`	`getMaxLength() : int`
`public`	`getPersistPassword() : bool`
`public`	`getReadOnly() : bool`
`public`	`getRows() : int`
`public`	`getSafeText() : string`
`public`	`getText() : string`
`public`	`getTextMode() : TTextBoxMode`
`public`	`getValidationGroup() : string`
`public`	`getValidationPropertyValue() : mixed` Returns the value to be validated. This methid is required by \Prado\Web\UI\IValidatable interface.
`public`	`getWrap() : bool`
`public`	`loadPostData(string $key, array<string\|int, mixed> $values) : bool` Loads user input data. This method is primarly used by framework developers.
`public`	`onTextChanged(TEventParameter $param) : mixed` Raises <b>OnTextChanged</b> event. This method is invoked when the value of the \Prado\Web\UI\WebControls\getText 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.
`public`	`raisePostDataChangedEvent() : mixed` Raises postdata changed event. This method is required by IPostBackDataHandler interface. It is invoked by the framework when \Prado\Web\UI\WebControls\getText property is changed on postback. This method is primarly used by framework developers.
`public`	`renderBeginTag(THtmlWriter $writer) : mixed` Renders an additional line-break after the opening tag when it is in MultiLine text mode.
`public`	`renderContents(THtmlWriter $writer) : mixed` Renders the body content of the textbox when it is in MultiLine text mode.
`public`	`setAutoCompleteType(TTextBoxAutoCompleteType $value) : mixed`
`public`	`setAutoPostBack(bool $value) : mixed` 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.
`public`	`setAutoTrim(bool $value) : mixed` Sets the value indicating if the input text should be trimmed spaces
`public`	`setCausesValidation(bool $value) : mixed`
`public`	`setColumns(int $value) : mixed` Sets the display width of the text box in characters.
`public`	`setConfig(HTMLPurifier_Config $value) : mixed` Sets a custom configuration for HTMLPurifier.
`public`	`setData(string $value) : mixed` Sets the text content of the TTextBox control. This method is required by IDataRenderer. It is the same as setText().
`public`	`setEnableClientScript(bool $value) : mixed`
`public`	`setIsValid(bool $value) : mixed`
`public`	`setMaxLength(int $value) : mixed` Sets the maximum number of characters allowed in the text box.
`public`	`setPersistPassword(bool $value) : mixed`
`public`	`setReadOnly(bool $value) : mixed`
`public`	`setRows(int $value) : mixed` Sets the number of rows displayed in a multiline text box.
`public`	`setText(string $value) : mixed` Sets the text content of the TTextBox control.
`public`	`setTextMode(TTextBoxMode $value) : mixed` Sets the behavior mode of the TTextBox component.
`public`	`setValidationGroup(string $value) : mixed`
`public`	`setWrap(bool $value) : mixed` Sets the value indicating whether the text content wraps within a multiline text box.
`protected`	`addAttributesToRender(THtmlWriter $writer) : mixed` Adds attribute name-value pairs to renderer. This method overrides the parent implementation with additional textbox specific attributes.
`protected`	`getClientClassName() : string` Gets the name of the javascript class responsible for performing postback for this control. This method overrides the parent implementation.
`protected`	`getPostBackOptions() : array<string\|int, mixed>` Gets the post back options for this textbox.
`protected`	`getSafeTextParser() : HTMLPurifier`
`protected`	`getTagName() : string` Returns the tag name used for this control.
`protected`	`renderClientControlScript(mixed $writer) : mixed` Renders the javascript for textbox.

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addedControl, addParsedObject, applyStyleSheetSkin, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, autoBindProperty, bindProperty, broadcastEvent, bubbleEvent, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, clearNamingContainer, clearStyle, clearViewState, convertUniqueIdToClientId, copyBaseAttributes, createChildControls, createdOnTemplate, dataBind, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, ensureChildControls, evaluateExpression, evaluateStatements, findControl, findControlsByID, findControlsByType, focus, fxAttachClassBehavior, fxDetachClassBehavior, getAccessKey, getAdapter, getAllowChildControls, getApplication, getAttribute, getAttributes, getAutoGlobalListen, getBackColor, getBehaviors, getBehaviorsEnabled, getBorderColor, getBorderStyle, getBorderWidth, getClassHierarchy, getClientID, getControls, getCssClass, getCustomData, getDecorator, getDisplay, getEnabled, getEnableTheming, getEnableViewState, getEnsureId, getEventHandlers, getFont, getForeColor, getHasAdapter, getHasAttributes, getHasChildInitialized, getHasControls, getHasInitialized, getHasLoaded, getHasLoadedPostData, getHasPreRendered, getHasStyle, getHeight, getID, getIsSkinApplied, getListeningToGlobalEvents, getNamingContainer, getPage, getParent, getPluginModule, getRegisteredObject, getRequest, getResponse, getService, getSession, getSkinID, getSourceTemplateControl, getStyle, getSubProperty, getTabIndex, getTemplateControl, getToolTip, getUniqueID, getUser, getViewState, getVisible, getWidth, hasAttribute, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, isObjectRegistered, listen, loadState, onDataBinding, onInit, onLoad, onPreRender, onUnload, publishAsset, publishFilePath, raiseEvent, registerObject, removeAttribute, removedControl, render, renderBeginTag, renderChildren, renderContents, renderControl, renderEndTag, saveState, setAccessKey, setAdapter, setAttribute, setBackColor, setBorderColor, setBorderStyle, setBorderWidth, setCssClass, setCustomData, setDisplay, setEnabled, setEnableTheming, setEnableViewState, setEnsureId, setForeColor, setHeight, setID, setPage, setSkinID, setStyle, setSubProperty, setTabIndex, setTemplateControl, setToolTip, setViewState, setVisible, setWidth, trackViewState, unbindProperty, unlisten, unregisterObject, _getZappableSleepProps, addAttributesToRender, autoDataBindProperties, clearChildState, clearControlState, createControlCollection, createStyle, dataBindChildren, dataBindProperties, getCallChain, getChildControlsCreated, getClassFxEvents, getControlStage, getControlState, getTagName, initRecursive, instanceBehavior, isDescendentOf, loadRecursive, loadStateRecursive, preRenderRecursive, raiseBubbleEvent, saveStateRecursive, setChildControlsCreated, setControlStage, setControlState, traverseChildControls, unloadRecursive, broadcastEventInternal, clearCachedUniqueID, clearNameTable, fillNameTable, filter_prado_fx, generateAutomaticID

Constants summary
`public mixed`	`DEFAULT_COLUMNS` Default number of columns (for MultiLine text box)	`20`
`public mixed`	`DEFAULT_ROWS` Default number of rows (for MultiLine text box)	`4`

Inherited constants
\Prado\Web\UI\TControl::AUTOMATIC_ID_PREFIX, \Prado\Web\UI\TControl::CLIENT_ID_SEPARATOR, \Prado\Web\UI\TControl::CS_CHILD_INITIALIZED, \Prado\Web\UI\TControl::CS_CONSTRUCTED, \Prado\Web\UI\TControl::CS_INITIALIZED, \Prado\Web\UI\TControl::CS_LOADED, \Prado\Web\UI\TControl::CS_PRERENDERED, \Prado\Web\UI\TControl::CS_STATE_LOADED, \Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER, \Prado\Web\UI\TControl::ID_FORMAT, \Prado\Web\UI\TControl::ID_SEPARATOR, \Prado\Web\UI\TControl::IS_CHILD_CREATED, \Prado\Web\UI\TControl::IS_CREATING_CHILD, \Prado\Web\UI\TControl::IS_DISABLE_THEMING, \Prado\Web\UI\TControl::IS_DISABLE_VIEWSTATE, \Prado\Web\UI\TControl::IS_ID_SET, \Prado\Web\UI\TControl::IS_SKIN_APPLIED, \Prado\Web\UI\TControl::IS_STYLESHEET_APPLIED, \Prado\Web\UI\TControl::RF_ADAPTER, \Prado\Web\UI\TControl::RF_AUTO_BINDINGS, \Prado\Web\UI\TControl::RF_CHILD_STATE, \Prado\Web\UI\TControl::RF_CONTROLS, \Prado\Web\UI\TControl::RF_CONTROLSTATE, \Prado\Web\UI\TControl::RF_DATA_BINDINGS, \Prado\Web\UI\TControl::RF_EVENTS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS_ID, \Prado\Web\UI\TControl::RF_NAMED_OBJECTS, \Prado\Web\UI\TControl::RF_SKIN_ID

Classes

Interfaces

Traits

Search results

Class \Prado\Web\UI\WebControls\TTextBox

Class hierarchy