Class TForm

Description

TForm class

TForm displays an HTML form. Besides regular body content, it displays hidden fields, javascript blocks and files that are registered through TClientScriptManager.

A TForm is required for a page that needs postback. Each page can contain at most one TForm. If multiple HTML forms are needed, please use regular HTML form tags for those forms that post to different URLs.

  • author: Qiang Xue <qiang.xue@gmail.com>
  • version: $Id: TForm.php 2998 2011-06-24 22:12:36Z ctrlaltca@gmail.com $
  • since: 3.0

Located in /Web/UI/TForm.php (line 30)

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --TForm
Method Summary
string getDefaultButton ()
string getEnctype ()
string getMethod ()
string getName ()
void onInit (mixed $param)
void render (THtmlWriter $writer)
void setDefaultButton (string $value)
void setEnctype (string $value)
void setMethod (string $value)
Methods
addAttributesToRender (line 46)

Adds form specific attributes to renderer.

  • access: protected
void addAttributesToRender (THtmlWriter $writer)
getDefaultButton (line 111)
  • return: id path to the default button control.
  • access: public
string getDefaultButton ()
getEnctype (line 146)
  • return: the encoding type a browser uses to post data back to the server
  • access: public
string getEnctype ()
getMethod (line 130)
  • return: form submission method. Defaults to 'post'.
  • access: public
string getMethod ()
getName (line 166)
  • return: form name, which is equal to UniqueID.
  • access: public
string getName ()
onInit (line 36)

Registers the form with the page.

  • access: public
void onInit (mixed $param)
  • mixed $param: event parameter

Redefinition of:
TControl::onInit()
This method is invoked when the control enters 'OnInit' stage.
render (line 72)

Renders the form.

  • access: public
void render (THtmlWriter $writer)

Redefinition of:
TControl::render()
Renders the control.
setDefaultButton (line 122)

Sets a button to be default one in a form.

A default button will be clicked if a user presses 'Enter' key within the form.

  • access: public
void setDefaultButton (string $value)
  • string $value: id path to the default button control.
setEnctype (line 158)
  • access: public
void setEnctype (string $value)
  • string $value: the encoding type a browser uses to post data back to the server. Commonly used types include
    • application/x-www-form-urlencoded : Form data is encoded as name/value pairs. This is the standard encoding format.
    • multipart/form-data : Form data is encoded as a message with a separate part for each control on the page.
    • text/plain : Form data is encoded in plain text, without any control or formatting characters.
setMethod (line 138)
  • access: public
void setMethod (string $value)
  • string $value: form submission method. Valid values include 'post' and 'get'.

Inherited Methods

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:38:15 +0200 by phpDocumentor 1.4.3