Class TPage
| 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
|
|
|
void
|
|
|
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
|
|
|
THead
|
|
|
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
|
Returns a list of registered validators.
|
|
protected
boolean
|
|
|
protected
void
|
Loads page state from persistent storage.
|
|
void
|
This method is invoked right after the control has loaded its state.
|
|
void
|
Raises OnInitComplete event.
|
|
void
|
Raises OnLoadComplete event.
|
|
void
|
Raises OnPreInit event.
|
|
void
|
Raises OnPreLoad event.
|
|
void
|
Raises OnPreRenderComplete event.
|
|
void
|
Raises OnSaveStateComplete event.
|
|
protected
void
|
Sets Adapter to TActivePageAdapter and calls apter to process the callback request.
|
|
protected
void
|
|
|
protected
void
|
|
|
protected
void
|
Processes post data.
|
|
void
|
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
|
|
|
void
|
Registers a control to raise callback event in the current request.
|
|
void
|
Sets the state to be stored on the client side.
|
|
void
|
|
|
void
|
|
|
void
|
|
|
void
|
Sets input focus on a control after the page is rendered to users.
|
|
void
|
Registers a TForm instance to the page.
|
|
void
|
|
|
void
|
|
|
void
|
|
|
void
|
Registers a control to raise postback event in the current request.
|
|
void
|
|
|
void
|
Sets the stylesheet theme to be used for the page.
|
|
void
|
Sets the theme to be used for the page.
|
|
void
|
Sets the page title.
|
|
void
|
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 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 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()
|
| Constructor Details |
__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 | $control | a 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 | $control | a 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 | $control | the control to be rendered |
| Output |
| Exception |
| throws | TConfigurationException if the control is outside of the form |
|
getCachingStack
| public TStack getCachingStack |
() |
|
getCallbackClient
Gets the callback client script handler that allows javascript functions to be executed during the callback response.
|
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
|
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
| Output |
|
TForm
| the form on the page |
| Exception |
|
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 |
| throws | TInvalidOperationException 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 |
| |