Class THiddenField

Description

Implements interfaces:

THiddenField class

THiddenField displays a hidden input field on a Web page. The value of the input field can be accessed via Value property. If upon postback the value is changed, a OnValueChanged event will be raised.

  • since: 3.0
  • version: $Id: THiddenField.php 2541 2008-10-21 15:05:13Z qiang.xue $
  • author: Qiang Xue <qiang.xue@gmail.com>

Located in /Web/UI/WebControls/THiddenField.php (line 26)

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --THiddenField
Direct descendents
Class Description
TActiveHiddenField TActiveHiddenField class
Method Summary
void focus ()
string getData ()
boolean getDataChanged ()
boolean getEnableTheming ()
bool getIsValid ()
string getTagName ()
string getValue ()
boolean loadPostData (string $key, array $values)
void render (THtmlWriter $writer)
void setData (string $value)
void setEnableTheming (boolean $value)
void setIsValid (bool $value)
void setSkinID (string $value)
void setValue (string $value)
Methods
focus (line 43)

Sets focus to this control.

This method overrides the parent implementation by forbidding setting focus to this control.

  • access: public
void focus ()

Redefinition of:
TControl::focus()
Sets input focus to this control.
getData (line 179)

Returns the value of the hidden field.

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

string getData ()
getDataChanged (line 100)

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 ()
getEnableTheming (line 201)
  • return: whether theming is enabled for this control. Defaults to false.
  • access: public
boolean getEnableTheming ()

Redefinition of:
TControl::getEnableTheming()
getIsValid (line 120)

Returns true if this control validated successfully.

Defaults to true.

  • return: wether this control validated successfully.
  • access: public
bool getIsValid ()
getTagName (line 34)
  • return: tag name of the hidden field.
  • access: protected
string getTagName ()
getValidationPropertyValue (line 110)

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 ()
getValue (line 157)
  • return: the value of the THiddenField
  • access: public
string getValue ()
loadPostData (line 83)

Loads hidden field 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
onValueChanged (line 149)

This method is invoked when the value of the getValue property changes between posts to the server.

The method raises 'OnValueChanged' event to fire up the event delegates. If you override this method, be sure to call the parent implementation so that the attached event handlers can be invoked.

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

Raises postdata changed event.

This method calls onValueChanged method. This method is primarly used by framework developers.

  • access: public
void raisePostDataChangedEvent ()
render (line 54)

Renders the control.

This method overrides the parent implementation by rendering the hidden field input element.

  • access: public
void render (THtmlWriter $writer)
  • THtmlWriter $writer: the writer used for the rendering purpose

Redefinition of:
TControl::render()
Renders the control.
setData (line 192)

Sets the value of the hidden field.

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

void setData (string $value)
  • string $value: value of the hidden field
setEnableTheming (line 210)
  • access: public
  • throws: TNotSupportedException This method is always thrown when calling this method.
void setEnableTheming (boolean $value)
  • boolean $value: whether theming is enabled for this control.

Redefinition of:
TControl::setEnableTheming()
setIsValid (line 127)
  • access: public
void setIsValid (bool $value)
  • bool $value: wether this control is valid.
setSkinID (line 219)
  • access: public
  • throws: TNotSupportedException This method is always thrown when calling this method.
void setSkinID (string $value)
  • string $value: Skin ID

Redefinition of:
TControl::setSkinID()
setValue (line 166)

Sets the value of the THiddenField

  • access: public
void setValue (string $value)
  • string $value: the value to be set

Redefined in descendants as:

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::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::__get()
TComponent::__set()
Class Constants

Documentation generated on Sun, 11 Jan 2009 20:22:36 -0500 by phpDocumentor 1.3.0RC4