Packages:
System
System.Caching
System.Collections
System.Data
System.Data.ActiveRecord
System.Data.ActiveRecord.Relations
System.Data.ActiveRecord.Scaffold
System.Data.ActiveReecord.Scaffold.InputBuilder
System.Data.Commom.Sqlite
System.Data.Common
System.Data.Common.Mssql
System.Data.Common.Mysql
System.Data.Common.Oracle
System.Data.Common.Pgsql
System.Data.Common.Sqlite
System.Data.DataGateway
System.Data.SqlMap
System.Data.SqlMap.Configuration
System.Data.SqlMap.Statements
System.Exceptions
System.I18N
System.IO
System.Security
System.Util
System.Web
System.Web.Services
System.Web.UI
System.Web.UI.ActiveControls
System.Web.UI.WebControls
System.Web.UI.WebControls.assets
System.Xml


Classes:
Keyword

Class TPage

TPage class

Since: 3.0
Author: Qiang Xue <qiang.xue@gmail.com>
Constants Inherited From TTemplateControl
EXT_TEMPLATE,
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,

Constructor Summary
public
Constructor.

Method Summary
void
Applies a skin in the current theme to a control.
void
Applies a stylesheet skin in the current theme to a control.
void
beginFormRender ( mixed $writer)
void
endFormRender ( mixed $writer)
void
Ensures the control is rendered within a form.
TStack
TCallbackClientScript
Gets the callback client script handler that allows javascript functions to be executed during the callback response.
string
Callback parameter is decoded assuming JSON encoding.
TControl
TClientScriptManager
string
Returns the state to be stored on the client side.
boolean
boolean
boolean
TForm
getForm ()
THead
getHead ()
boolean
boolean
boolean
boolean
Returns whether user input is valid or not.
string
string
TControl
array
Get a list of IDs of controls that are enabled and require post data.
string
IPageStatePersister
string
TTheme
TTheme
string
TList
getValidators ( string $validationGroup)
Returns a list of registered validators.
protected  boolean
isSystemPostField ( string $field)
protected  void
Loads page state from persistent storage.
void
This method is invoked right after the control has loaded its state.
void
onInitComplete ( mixed $param)
Raises OnInitComplete event.
void
onLoadComplete ( mixed $param)
Raises OnLoadComplete event.
void
onPreInit ( mixed $param)
Raises OnPreInit event.
void
onPreLoad ( mixed $param)
Raises OnPreLoad event.
void
onPreRenderComplete ( mixed $param)
Raises OnPreRenderComplete event.
void
onSaveStateComplete ( mixed $param)
Raises OnSaveStateComplete event.
protected  void
processCallbackRequest ( mixed $writer)
Sets Adapter to TActivePageAdapter and calls apter to process the callback request.
protected  void
processNormalRequest ( mixed $writer)
protected  void
processPostBackRequest ( mixed $writer)
protected  void
processPostData ( TMap $postData, boolean $beforeLoad)
Processes post data.
void
registerCachingAction ( string $context, string $funcName, array $funcParams)
Registers an action associated with the content being cached.
void
Register post data loaders for Callback to collect post data.
void
Registers a control for loading post data in the next postback.
void
run ( THtmlTextWriter $writer)
Runs through the page lifecycles.
protected  void
Saves page state from persistent storage.
void
This method is invoked when control state is to be saved.
void
Set a new callback client handler.
void
setCallbackEventParameter ( mixed $value)
void
setCallbackEventTarget ( TControl $control)
Registers a control to raise callback event in the current request.
void
setClientState ( string $state)
Sets the state to be stored on the client side.
void
setClientSupportsJavaScript ( boolean $value)
void
setEnableStateEncryption ( boolean $value)
void
setEnableStateValidation ( boolean $value)
void
setFocus ( TControl|string $value)
Sets input focus on a control after the page is rendered to users.
void
setForm ( TForm $form)
Registers a TForm instance to the page.
void
setHead ( THead $value)
void
setPagePath ( string $value)
void
setPostBackEventParameter ( string $value)
void
setPostBackEventTarget ( TControl $control)
Registers a control to raise postback event in the current request.
void
setStatePersisterClass ( string $value)
void
setStyleSheetTheme ( string|TTheme $value)
Sets the stylesheet theme to be used for the page.
void
setTheme ( string|TTheme $value)
Sets the theme to be used for the page.
void
setTitle ( string $value)
Sets the page title.
void
validate ( string $validationGroup)
Performs input validation.
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()
Methods Inherited From TCompositeControl
TCompositeControl::initRecursive()
Methods Inherited From TControl
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()
Methods Inherited From TApplicationComponent
TApplicationComponent::getApplication(), TApplicationComponent::getRequest(), TApplicationComponent::getResponse(), TApplicationComponent::getService(), TApplicationComponent::getSession(), TApplicationComponent::getUser(), TApplicationComponent::publishAsset(), TApplicationComponent::publishFilePath()
Methods 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()

Constant Summary
string FIELD_CALLBACK_PARAMETER
string FIELD_CALLBACK_TARGET
string FIELD_LASTFOCUS
string FIELD_PAGESTATE
string FIELD_POSTBACK_PARAMETER
string FIELD_POSTBACK_TARGET system post fields

Constructor Details

__construct

public __construct

Constructor.

Sets the page object to itself. Derived classes must call parent implementation.


Method Details

applyControlSkin

public void applyControlSkin (TControl $control )

Applies a skin in the current theme to a control.

This method should only be used by framework developers.

Input
TControl$controla control to be applied skin with
Output
Exception

applyControlStyleSheet

public void applyControlStyleSheet (TControl $control )

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

This method should only be used by framework developers.

Input
TControl$controla control to be applied stylesheet skin with
Output
Exception

beginFormRender

public void beginFormRender (mixed $writer )

Input
mixed$writer
Output
Exception

endFormRender

public void endFormRender (mixed $writer )

Input
mixed$writer
Output
Exception

ensureRenderInForm

public void ensureRenderInForm (TControl $control )

Ensures the control is rendered within a form.

Input
TControl$controlthe control to be rendered
Output
Exception
throwsTConfigurationException if the control is outside of the form

getCachingStack

public TStack getCachingStack ()

Output
TStack stack of TOutputCache objects
Exception

getCallbackClient

public TCallbackClientScript getCallbackClient ()

Gets the callback client script handler that allows javascript functions to be executed during the callback response.

Output
TCallbackClientScript interface to client-side javascript code.
Exception

getCallbackEventParameter

public string getCallbackEventParameter ()

Callback parameter is decoded assuming JSON encoding.

Output
string callback event parameter
Exception

getCallbackEventTarget

public TControl getCallbackEventTarget ()

Output
TControl the control responsible for the current callback event, null if nonexistent
Exception

getClientScript

public TClientScriptManager getClientScript ()

Output
TClientScriptManager client script manager
Exception

getClientState

public string getClientState ()

Returns the state to be stored on the client side.

This method should only be used by framework and control developers.

Output
string the state to be stored on the client side
Exception

getClientSupportsJavaScript

public boolean getClientSupportsJavaScript ()

Output
boolean whether client supports javascript. Defaults to true.
Exception

getEnableStateEncryption

public boolean getEnableStateEncryption ()

Output
boolean whether page state should be encrypted. Defaults to false.
Exception

getEnableStateValidation

public boolean getEnableStateValidation ()

Output
boolean whether page state should be HMAC validated. Defaults to true.
Exception

getForm

public TForm getForm ()

Output
TForm the form on the page
Exception

getHead

public THead getHead ()

Output
THead page head, null if not available
Exception

getIsCallback

public boolean getIsCallback ()

Output
boolean whether this is a callback request
Exception

getIsLoadingPostData

public boolean getIsLoadingPostData ()

Output
boolean true if loading post data.
Exception

getIsPostBack

public boolean getIsPostBack ()

Output
boolean whether the current page request is a postback
Exception

getIsValid

public boolean getIsValid ()

Returns whether user input is valid or not.

This method must be invoked after validate is called.

Output
boolean whether the user input is valid or not.
Exception
throwsTInvalidOperationException if validate is not invoked yet.

getPagePath

public string getPagePath ()

Output
string the requested page path for this page
Exception

getPostBackEventParameter

public string getPostBackEventParameter ()

Output
string postback event parameter
Exception

getPostBackEventTarget

public TControl getPostBackEventTarget ()

Output
TControl the control responsible for the current postback event, null if nonexistent
Exception

getPostDataLoaders

public array getPostDataLoaders ()

Get a list of IDs of controls that are enabled and require post data.

Output
array list of IDs implementing IPostBackDataHandler
Exception