PRADO Component Framework for PHP 5
  • Home
  • About
  • Testimonials
  • Demos
  • Download
  • Documentation
  • Forum
  • Development
  • Tutorials
  • Class Docs
  • API Manual
  • Wiki

Packages

  • None
  • System
    • Caching
    • Collections
    • Data
      • ActiveRecord
        • Relations
        • Scaffold
          • InputBuilder
      • Commom
        • Sqlite
      • Common
        • Mssql
        • Mysql
        • Oracle
        • Pgsql
        • Sqlite
      • DataGateway
      • SqlMap
        • Configuration
        • Statements
    • Exceptions
    • I18N
    • IO
    • Security
    • Util
    • Web
      • Javascripts
      • Services
      • UI
        • ActiveControls
        • WebControls
    • Xml
  • Wsat
    • pages
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class THiddenField

THiddenField class

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

TComponent
Extended by TApplicationComponent
Extended by TControl implements IRenderable, IBindable
Extended by THiddenField implements IPostBackDataHandler, IValidatable, IDataRenderer

Direct known subclasses

TActiveHiddenField
Package: System\Web\UI\WebControls
Copyright: Copyright © 2005-2014 PradoSoft
License: BSD License
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0
Located at Web/UI/WebControls/THiddenField.php
Methods summary
protected string
# getTagName( )

Returns

string
tag name of the hidden field.
public
# focus( )

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

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

Overrides

TControl::focus()
public
# render( THtmlWriter $writer )

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

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

Parameters

$writer
THtmlWriter
the writer used for the rendering purpose

Overrides

TControl::render()
public boolean
# loadPostData( string $key, array $values )

Loads hidden field data. This method is primarly used by framework developers.

Loads hidden field data. This method is primarly used by framework developers.

Parameters

$key
string
the key that can be used to retrieve data from the input data collection
$values
array
the input data collection

Returns

boolean
whether the data of the component has been changed

Implementation of

IPostBackDataHandler::loadPostData()
public boolean
# getDataChanged( )

Returns a value indicating whether postback has caused the control data change. This method is required by the IPostBackDataHandler interface.

Returns a value indicating whether postback has caused the control data change. This method is required by the IPostBackDataHandler interface.

Returns

boolean
whether postback has caused the control data change. False if the page is not in postback mode.

Implementation of

IPostBackDataHandler::getDataChanged()
public mixed
# getValidationPropertyValue( )

Returns the value to be validated. This methid is required by IValidatable interface.

Returns the value to be validated. This methid is required by IValidatable interface.

Returns

mixed
the value of the property to be validated.

Implementation of

IValidatable::getValidationPropertyValue()
public boolean
# getIsValid( )

Returns true if this control validated successfully. Defaults to true.

Returns true if this control validated successfully. Defaults to true.

Returns

boolean
wether this control validated successfully.

Implementation of

IValidatable::getIsValid()
public boolean
# setIsValid( boolean $value )

Parameters

$value
boolean
wether this control is valid.

Returns

boolean
wether this control's validators validated successfully

Implementation of

IValidatable::setIsValid()
public
# raisePostDataChangedEvent( )

Raises postdata changed event. This method calls THiddenField::onValueChanged() method. This method is primarly used by framework developers.

Raises postdata changed event. This method calls THiddenField::onValueChanged() method. This method is primarly used by framework developers.

Implementation of

IPostBackDataHandler::raisePostDataChangedEvent()
public
# onValueChanged( TEventParameter $param )

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

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

Parameters

$param
TEventParameter
event parameter to be passed to the event handlers
public string
# getValue( )

Returns

string
the value of the THiddenField
public
# setValue( string $value )

Sets the value of the THiddenField

Sets the value of the THiddenField

Parameters

$value
string
the value to be set
public string
# getData( )

Returns the value of the hidden field. This method is required by IDataRenderer. It is the same as THiddenField::getValue().

Returns the value of the hidden field. This method is required by IDataRenderer. It is the same as THiddenField::getValue().

Returns

string
value of the hidden field

Since

3.1.0

See

THiddenField::getValue()

Implementation of

IDataRenderer::getData()
public
# setData( string $value )

Sets the value of the hidden field. This method is required by IDataRenderer. It is the same as THiddenField::setValue().

Sets the value of the hidden field. This method is required by IDataRenderer. It is the same as THiddenField::setValue().

Parameters

$value
string
value of the hidden field

Since

3.1.0

See

THiddenField::setValue()

Implementation of

IDataRenderer::setData()
public boolean
# getEnableTheming( )

Returns

boolean
whether theming is enabled for this control. Defaults to false.

Overrides

TControl::getEnableTheming()
public
# setEnableTheming( boolean $value )

Parameters

$value
boolean
whether theming is enabled for this control.

Throws

TNotSupportedException
This method is always thrown when calling this method.

Overrides

TControl::setEnableTheming()
public
# setSkinID( string $value )

Parameters

$value
string
Skin ID

Throws

TNotSupportedException
This method is always thrown when calling this method.

Overrides

TControl::setSkinID()
Methods inherited from TControl
__construct(), __get(), addParsedObject(), addToPostDataLoader(), addedControl(), applyStyleSheetSkin(), autoBindProperty(), autoDataBindProperties(), bindProperty(), broadcastEvent(), bubbleEvent(), clearChildState(), clearControlState(), clearNamingContainer(), clearViewState(), convertUniqueIdToClientId(), createChildControls(), createControlCollection(), dataBind(), dataBindChildren(), dataBindProperties(), ensureChildControls(), findControl(), findControlsByID(), findControlsByType(), getAdapter(), getAllowChildControls(), getAttribute(), getAttributes(), getChildControlsCreated(), getClientID(), getControlStage(), getControlState(), getControls(), getCustomData(), getEnableViewState(), getEnabled(), getHasAdapter(), getHasAttributes(), getHasChildInitialized(), getHasControls(), getHasInitialized(), getHasLoaded(), getHasLoadedPostData(), getHasPreRendered(), getID(), getIsSkinApplied(), getNamingContainer(), getPage(), getParent(), getRegisteredObject(), getSkinID(), getSourceTemplateControl(), getTemplateControl(), getUniqueID(), getViewState(), getVisible(), hasAttribute(), initRecursive(), isDescendentOf(), isObjectRegistered(), loadRecursive(), loadState(), loadStateRecursive(), onDataBinding(), onInit(), onLoad(), onPreRender(), onUnload(), preRenderRecursive(), raiseBubbleEvent(), registerObject(), removeAttribute(), removedControl(), renderChildren(), renderControl(), saveState(), saveStateRecursive(), setAdapter(), setAttribute(), setChildControlsCreated(), setControlStage(), setControlState(), setCustomData(), setEnableViewState(), setEnabled(), setID(), setPage(), setTemplateControl(), setViewState(), setVisible(), trackViewState(), traverseChildControls(), unbindProperty(), unloadRecursive(), unregisterObject()
Methods inherited from TApplicationComponent
getApplication(), getRequest(), getResponse(), getService(), getSession(), getUser(), publishAsset(), publishFilePath()
Methods inherited from TComponent
__call(), __destruct(), __isset(), __set(), __sleep(), __unset(), __wakeup(), asa(), attachBehavior(), attachBehaviors(), attachClassBehavior(), attachEventHandler(), canGetProperty(), canSetProperty(), clearBehaviors(), createdOnTemplate(), detachBehavior(), detachBehaviors(), detachClassBehavior(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), evaluateStatements(), fxAttachClassBehavior(), fxDetachClassBehavior(), getAutoGlobalListen(), getBehaviorsEnabled(), getClassHierarchy(), getEventHandlers(), getListeningToGlobalEvents(), getSubProperty(), hasEvent(), hasEventHandler(), hasProperty(), isa(), listen(), raiseEvent(), setSubProperty(), unlisten()
Constants inherited from TControl
AUTOMATIC_ID_PREFIX, CLIENT_ID_SEPARATOR, CS_CHILD_INITIALIZED, CS_CONSTRUCTED, CS_INITIALIZED, CS_LOADED, CS_PRERENDERED, CS_STATE_LOADED, ID_FORMAT, ID_SEPARATOR, IS_CHILD_CREATED, IS_CREATING_CHILD, IS_DISABLE_THEMING, IS_DISABLE_VIEWSTATE, IS_ID_SET, IS_SKIN_APPLIED, IS_STYLESHEET_APPLIED, RF_ADAPTER, RF_AUTO_BINDINGS, RF_CHILD_STATE, RF_CONTROLS, RF_CONTROLSTATE, RF_DATA_BINDINGS, RF_EVENTS, RF_NAMED_CONTROLS, RF_NAMED_CONTROLS_ID, RF_NAMED_OBJECTS, RF_SKIN_ID
Constants inherited from TComponent
GLOBAL_RAISE_EVENT_LISTENER
Terms of Service | Contact Us
PRADO v3.2.4 API Manual API documentation generated by ApiGen 2.8.0
Copyright © 2006-2014 by the PRADO Group.
Powered by PRADO