Class TPage

Description

TPage class

Located in /Web/UI/TPage.php (line 29)

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --TCompositeControl
            |
            --TTemplateControl
               |
               --TPage
Class Constant Summary
 FIELD_CALLBACK_ID = 'PRADO_CALLBACK_ID'
 FIELD_CALLBACK_PARAMETER = 'PRADO_CALLBACK_PARAMETER'
 FIELD_CALLBACK_TARGET = 'PRADO_CALLBACK_TARGET'
 FIELD_LASTFOCUS = 'PRADO_LASTFOCUS'
 FIELD_PAGESTATE = 'PRADO_PAGESTATE'
 FIELD_POSTBACK_PARAMETER = 'PRADO_POSTBACK_PARAMETER'
 FIELD_POSTBACK_TARGET = 'PRADO_POSTBACK_TARGET'
Method Summary
TPage __construct ()
void applyControlSkin (TControl $control)
void applyControlStyleSheet (TControl $control)
void beginFormRender (mixed $writer)
void endFormRender (mixed $writer)
void ensureRenderInForm (TControl $control)
boolean getIsCallback ()
boolean getIsPostBack ()
boolean getIsValid ()
string getPagePath ()
string getTitle ()
TList getValidators ([string $validationGroup = null])
boolean isSystemPostField (string $field)
void loadPageState ()
void loadState ()
void onInitComplete (mixed $param)
void onLoadComplete (mixed $param)
void onPreInit (mixed $param)
void onPreLoad (mixed $param)
void onPreRenderComplete (mixed $param)
void onSaveStateComplete (mixed $param)
void processCallbackRequest (mixed $writer)
void processNormalRequest (mixed $writer)
void processPostBackRequest (mixed $writer)
void processPostData (TMap $postData, boolean $beforeLoad)
void registerRequiresPostData (TControl $control)
void run (THtmlTextWriter $writer)
void savePageState ()
void saveState ()
void setEnableStateEncryption (boolean $value)
void setEnableStateValidation (boolean $value)
void setFocus (TControl|string $value)
void setForm (TForm $form)
void setHead (THead $value)
void setPagePath (string $value)
void setPostBackEventParameter (string $value)
void setPostBackEventTarget (TControl $control)
void setStatePersisterClass (string $value)
void setStyleSheetTheme (string|TTheme $value)
void setTheme (string|TTheme $value)
void setTitle (string $value)
void validate ([string $validationGroup = null])
Methods
Constructor __construct (line 150)

Constructor.

Sets the page object to itself.

  • access: public
TPage __construct ()

Redefinition of:
TControl::__construct()
Constructor.
applyControlSkin (line 397)

Applies a skin in the current theme to a control.

This method should only be used by framework developers.

  • access: public
void applyControlSkin (TControl $control)
  • TControl $control: a control to be applied skin with
applyControlStyleSheet (line 408)

Applies a stylesheet skin in the current theme to a control.

This method should only be used by framework developers.

  • access: public
void applyControlStyleSheet (TControl $control)
  • TControl $control: a control to be applied stylesheet skin with
beginFormRender (line 729)
  • access: public
void beginFormRender (mixed $writer)
endFormRender (line 744)
  • access: public
void endFormRender (mixed $writer)
ensureRenderInForm (line 720)

Ensures the control is rendered within a form.

  • access: public
  • throws: TConfigurationException if the control is outside of the form
void ensureRenderInForm (TControl $control)
  • TControl $control: the control to be rendered
getClientScript (line 417)
  • return: client script manager
  • access: public
TClientScriptManager getClientScript ()
getClientSupportsJavaScript (line 779)
  • return: whether client supports javascript. Currently, this method always returns true. If future, we may add some browser capability detection functionality.
  • access: public
boolean getClientSupportsJavaScript ()
getEnableStateEncryption (line 884)
  • return: whether page state should be encrypted. Defaults to false.
  • access: public
boolean getEnableStateEncryption ()
getEnableStateValidation (line 868)
  • return: whether page state should be HMAC validated. Defaults to true.
  • access: public
boolean getEnableStateValidation ()
getForm (line 262)
  • return: the form on the page
  • access: public
TForm getForm ()
getHead (line 788)
  • return: page head, null if not available
  • access: public
THead getHead ()
getIsCallback (line 540)

TBD

  • return: whether this is a callback request
  • access: public
boolean getIsCallback ()
getIsPostBack (line 531)
  • return: whether the current page request is a postback
  • access: public
boolean getIsPostBack ()
getIsValid (line 337)

Returns whether user input is valid or not.

This method must be invoked after validate is called.

  • return: whether the user input is valid or not.
  • access: public
  • throws: TInvalidOperationException if validate is not invoked yet.
boolean getIsValid ()
getPagePath (line 900)
  • return: the requested page path for this page
  • access: public
string getPagePath ()
getPostBackEventParameter (line 634)
  • return: postback event parameter
  • access: public
string getPostBackEventParameter ()
getPostBackEventTarget (line 611)
  • return: the control responsible for the current postback event, null if nonexistent
  • access: public
TControl getPostBackEventTarget ()
getStatePersister (line 853)
  • return: page state persister
  • access: public
IPageStatePersister getStatePersister ()
getStatePersisterClass (line 837)
  • return: class name of the page state persister. Defaults to TPageStatePersister.
  • access: public
string getStatePersisterClass ()
getStyleSheetTheme (line 376)
  • return: the stylesheet theme used for the page. Defaults to null.
  • access: public
TTheme getStyleSheetTheme ()
getTheme (line 356)
  • return: the theme used for the page. Defaults to null.
  • access: public
TTheme getTheme ()
getTitle (line 812)
  • return: page title.
  • access: public
string getTitle ()
getValidators (line 287)

Returns a list of registered validators.

If validation group is specified, only the validators in that group will be returned.

  • return: registered validators in the requested group. If the group is null, all validators will be returned.
  • access: public
TList getValidators ([string $validationGroup = null])
  • string $validationGroup: validation group
isSystemPostField (line 591)
  • return: whether the specified field is a system field in postback data
  • access: protected
boolean isSystemPostField (string $field)
  • string $field: the field name
loadPageState (line 570)

Loads page state from persistent storage.

  • access: protected
void loadPageState ()
loadState (line 561)

This method is invoked right after the control has loaded its state.

You can override this method to initialize data from the control state. Parent implementation must be invoked.

  • access: public
void loadState ()

Redefinition of:
TControl::loadState()
This method is invoked right after the control has loaded its state.
onInitComplete (line 446)

Raises OnInitComplete event.

This method is invoked right after OnInit stage and before OnLoad stage. You may override this method to provide additional initialization that should be done after OnInit. Remember to call the parent implementation to ensure OnInitComplete event is raised.

  • access: public
void onInitComplete (mixed $param)
  • mixed $param: event parameter
onLoadComplete (line 472)

Raises OnLoadComplete event.

This method is invoked right after OnLoad stage. You may override this method to provide additional page loading logic that should be done after OnLoad. Remember to call the parent implementation to ensure OnLoadComplete event is raised.

  • access: public
void onLoadComplete (mixed $param)
  • mixed $param: event parameter
onPreInit (line 433)

Raises OnPreInit event.

This method is invoked right before OnInit stage. You may override this method to provide additional initialization that should be done before OnInit (e.g. setting Theme or StyleSheetTheme). Remember to call the parent implementation to ensure OnPreInit event is raised.

  • access: public
void onPreInit (mixed $param)
  • mixed $param: event parameter
onPreLoad (line 459)

Raises OnPreLoad event.

This method is invoked right before OnLoad stage. You may override this method to provide additional page loading logic that should be done before OnLoad. Remember to call the parent implementation to ensure OnPreLoad event is raised.

  • access: public
void onPreLoad (mixed $param)
  • mixed $param: event parameter
onPreRenderComplete (line 485)

Raises OnPreRenderComplete event.

This method is invoked right after OnPreRender stage. You may override this method to provide additional preparation for page rendering that should be done after OnPreRender. Remember to call the parent implementation to ensure OnPreRenderComplete event is raised.

  • access: public
void onPreRenderComplete (mixed $param)
  • mixed $param: event parameter
onSaveStateComplete (line 512)

Raises OnSaveStateComplete event.

This method is invoked right after onSaveState stage. You may override this method to provide additional logic after page state is saved. Remember to call the parent implementation to ensure OnSaveStateComplete event is raised.

  • access: public
void onSaveStateComplete (mixed $param)
  • mixed $param: event parameter
processCallbackRequest (line 255)
  • access: protected
void processCallbackRequest (mixed $writer)
processNormalRequest (line 176)
  • access: protected
void processNormalRequest (mixed $writer)
processPostBackRequest (line 210)
  • access: protected
void processPostBackRequest (mixed $writer)
processPostData (line 657)

Processes post data.

  • access: protected
void processPostData (TMap $postData, boolean $beforeLoad)
  • TMap $postData: post data to be processed
  • boolean $beforeLoad: whether this method is invoked before OnLoad.
registerRequiresPostData (line 603)

Registers a control for loading post data in the next postback.

This method needs to be invoked if the control to load post data may not have a post variable in some cases. For example, a checkbox, if not checked, will not have a post value.

  • access: public
void registerRequiresPostData (TControl $control)
  • TControl $control: control registered for loading post data
run (line 160)

Runs through the page lifecycles.

  • access: public
void run (THtmlTextWriter $writer)
  • THtmlTextWriter $writer: the HTML writer
savePageState (line 580)

Saves page state from persistent storage.

  • access: protected
void savePageState ()
saveState (line 550)

This method is invoked when control state is to be saved.

You can override this method to do last step state saving. Parent implementation must be invoked.

  • access: public
void saveState ()

Redefinition of:
TControl::saveState()
This method is invoked when control state is to be saved.
setEnableStateEncryption (line 892)
  • access: public
void setEnableStateEncryption (boolean $value)
  • boolean $value: whether page state should be encrypted.
setEnableStateValidation (line 876)
  • access: public
void setEnableStateValidation (boolean $value)
  • boolean $value: whether page state should be HMAC validated.
setFocus (line 769)

Sets input focus on a control after the page is rendered to users.

  • access: public
void setFocus (TControl|string $value)
  • TControl|string $value: control to receive focus, or the ID of the element on the page to receive focus
setForm (line 273)

Registers a TForm instance to the page.

Note, a page can contain at most one TForm instance.

  • access: public
  • throws: TInvalidOperationException if this method is invoked twice or more.
void setForm (TForm $form)
  • TForm $form: the form on the page
setHead (line 797)
  • access: public
  • throws: TInvalidOperationException if a head already exists
void setHead (THead $value)
  • THead $value: page head
setPagePath (line 908)
  • access: public
void setPagePath (string $value)
  • string $value: the requested page path for this page
setPostBackEventParameter (line 647)
  • access: public
void setPostBackEventParameter (string $value)
  • string $value: postback event parameter
setPostBackEventTarget (line 626)

Registers a control to raise postback event in the current request.

  • access: public
void setPostBackEventTarget (TControl $control)
  • TControl $control: control registered to raise postback event.
setStatePersisterClass (line 845)
  • access: public
void setStatePersisterClass (string $value)
  • string $value: class name of the page state persister.
setStyleSheetTheme (line 387)

Sets the stylesheet theme to be used for the page.

  • access: public
void setStyleSheetTheme (string|TTheme $value)
  • string|TTheme $value: the stylesheet theme name or the stylesheet theme object to be used for the page.
setTheme (line 367)

Sets the theme to be used for the page.

  • access: public
void setTheme (string|TTheme $value)
  • string|TTheme $value: the theme name or the theme object to be used for the page.
setTitle (line 826)

Sets the page title.

Note, a THead control needs to place on the page in order that this title be rendered.

  • access: public
void setTitle (string $value)
  • string $value: page title. This will override the title set in Head.
validate (line 309)

Performs input validation.

This method will invoke the registered validators to perform the actual validation. If validation group is specified, only the validators in that group will be invoked.

  • access: public
void validate ([string $validationGroup = null])
  • string $validationGroup: validation group. If null, all validators will perform validation.

Inherited Methods

Inherited From TTemplateControl

TTemplateControl::createChildControls()
TTemplateControl::getIsSourceTemplateControl()
TTemplateControl::getMaster()
TTemplateControl::getMasterClass()
TTemplateControl::getTemplate()
TTemplateControl::getTemplateDirectory()
TTemplateControl::initRecursive()
TTemplateControl::injectContent()
TTemplateControl::loadTemplate()
TTemplateControl::registerContent()
TTemplateControl::registerContentPlaceHolder()
TTemplateControl::setMasterClass()
TTemplateControl::setTemplate()

Inherited From TCompositeControl

TCompositeControl::initRecursive()

Inherited From TControl

TControl::__construct()
TControl::addedControl()
TControl::addParsedObject()
TControl::applyStyleSheetSkin()
TControl::autoBindProperty()
TControl::autoDataBindProperties()
TControl::bindProperty()
TControl::broadcastEvent()
TControl::broadcastEventInternal()
TControl::bubbleEvent()
TControl::clearChildState()
TControl::clearControlState()
TControl::clearNamingContainer()
TControl::clearViewState()
TControl::createChildControls()
TControl::createControlCollection()
TControl::createdOnTemplate()
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::getEnabled()
TControl::getEnableTheming()
TControl::getEnableViewState()
TControl::getHasAdapter()
TControl::getHasAttributes()
TControl::getHasControls()
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::setEnabled()
TControl::setEnableTheming()
TControl::setEnableViewState()
TControl::setID()
TControl::setPage()
TControl::setSkinID()
TControl::setTemplateControl()
TControl::setViewState()
TControl::setVisible()
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::attachEventHandler()
TComponent::canGetProperty()
TComponent::canSetProperty()
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
FIELD_CALLBACK_ID = 'PRADO_CALLBACK_ID' (line 40)
FIELD_CALLBACK_PARAMETER = 'PRADO_CALLBACK_PARAMETER' (line 39)
FIELD_CALLBACK_TARGET = 'PRADO_CALLBACK_TARGET' (line 38)
FIELD_LASTFOCUS = 'PRADO_LASTFOCUS' (line 36)
FIELD_PAGESTATE = 'PRADO_PAGESTATE' (line 37)
FIELD_POSTBACK_PARAMETER = 'PRADO_POSTBACK_PARAMETER' (line 35)
FIELD_POSTBACK_TARGET = 'PRADO_POSTBACK_TARGET' (line 34)

system post fields

Inherited Constants

Inherited from TTemplateControl

Inherited from TControl

Documentation generated on Sun, 04 Jun 2006 18:59:58 -0400 by phpDocumentor 1.3.0RC4