Class \Prado\Web\UI\TPage

TPage class

Class hierarchy

\Prado\Web\UI\TPage

\Prado\Web\UI\TTemplateControl

\Prado\Web\UI\TCompositeControl implements INamingContainer

\Prado\Web\UI\TControl implements IRenderable, IBindable

\Prado\TApplicationComponent

\Prado\TComponent

Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0

Methods summary
`public`	`__construct() : mixed` Constructor. Sets the page object to itself. Derived classes must call parent implementation.
`public`	`applyControlSkin(TControl $control) : mixed` Applies a skin in the current theme to a control. This method should only be used by framework developers.
`public`	`applyControlStyleSheet(TControl $control) : mixed` Applies a stylesheet skin in the current theme to a control. This method should only be used by framework developers.
`public`	`ensureRenderInForm(TControl $control) : mixed` Ensures the control is rendered within a form.
`public`	`flushWriter() : mixed` Flushes output
`public`	`getAutoGlobalListen() : bool` TPage does autoGlobalListen and unlisten. Developers may put fx events in the page that need to be picked up.
`public`	`getCachingStack() : TStack`
`public`	`getCallbackClient() : TCallbackClientScript` Gets the callback client script handler that allows javascript functions to be executed during the callback response.
`public`	`getCallbackEventParameter() : string` Callback parameter is decoded assuming JSON encoding.
`public`	`getCallbackEventTarget() : TControl`
`public`	`getClientScript() : TClientScriptManager`
`public`	`getClientState() : string` Returns the state to be stored on the client side. This method should only be used by framework and control developers.
`public`	`getClientSupportsJavaScript() : bool`
`public`	`getEnableStateCompression() : bool`
`public`	`getEnableStateEncryption() : bool`
`public`	`getEnableStateIGBinary() : bool`
`public`	`getEnableStateValidation() : bool`
`public`	`getForm() : TForm`
`public`	`getHead() : THead`
`public`	`getInFormRender() : bool`
`public`	`getIsCallback() : bool`
`public`	`getIsLoadingPostData() : bool`
`public`	`getIsPostBack() : bool`
`public`	`getIsValid() : bool` Returns whether user input is valid or not. This method must be invoked after validate is called.
`public`	`getPagePath() : string`
`public`	`getPostBackEventParameter() : string`
`public`	`getPostBackEventTarget() : TControl`
`public`	`getRequestClientState() : string`
`public`	`getStatePersister() : IPageStatePersister`
`public`	`getStatePersisterClass() : string`
`public`	`getStyleSheetTheme() : TTheme`
`public`	`getTheme() : TTheme`
`public`	`getTitle() : string`
`public`	`getValidators([null\|string $validationGroup = null ]) : TList` Returns a list of registered validators. If validation group is specified, only the validators in that group will be returned.
`public`	`loadState() : mixed` 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.
`public`	`onInitComplete(mixed $param) : mixed` Raises OnInitComplete event. This method is invoked right after \Prado\Web\UI\onInit stage and before \Prado\Web\UI\onLoad stage. You may override this method to provide additional initialization that should be done after \Prado\Web\UI\onInit. Remember to call the parent implementation to ensure OnInitComplete event is raised.
`public`	`onLoadComplete(mixed $param) : mixed` Raises OnLoadComplete event. This method is invoked right after \Prado\Web\UI\onLoad stage. You may override this method to provide additional page loading logic that should be done after \Prado\Web\UI\onLoad. Remember to call the parent implementation to ensure OnLoadComplete event is raised.
`public`	`onPreInit(mixed $param) : mixed` Raises OnPreInit event. This method is invoked right before \Prado\Web\UI\onInit stage. You may override this method to provide additional initialization that should be done before \Prado\Web\UI\onInit (e.g. setting \Prado\Web\UI\setTheme or \Prado\Web\UI\setStyleSheetTheme). Remember to call the parent implementation to ensure OnPreInit event is raised.
`public`	`onPreLoad(mixed $param) : mixed` Raises OnPreLoad event. This method is invoked right before \Prado\Web\UI\onLoad stage. You may override this method to provide additional page loading logic that should be done before \Prado\Web\UI\onLoad. Remember to call the parent implementation to ensure OnPreLoad event is raised.
`public`	`onPreRenderComplete(mixed $param) : mixed` Raises OnPreRenderComplete event. This method is invoked right after \Prado\Web\UI\onPreRender stage. You may override this method to provide additional preparation for page rendering that should be done after \Prado\Web\UI\onPreRender. Remember to call the parent implementation to ensure OnPreRenderComplete event is raised.
`public`	`onSaveStateComplete(mixed $param) : mixed` Raises OnSaveStateComplete event. This method is invoked right after \Prado\Web\UI\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.
`public`	`registerCachingAction(string $context, string $funcName, array<string\|int, mixed> $funcParams) : mixed` Registers an action associated with the content being cached. The registered action will be replayed if the content stored in the cache is served to end-users.
`public`	`registerRequiresPostData(TControl $control) : mixed` 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.
`public`	`run(THtmlWriter $writer) : mixed` Runs through the page lifecycles.
`public`	`saveState() : mixed` 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.
`public`	`setCallbackEventParameter(mixed $value) : mixed`
`public`	`setCallbackEventTarget(TControl $control) : mixed` Registers a control to raise callback event in the current request.
`public`	`setClientState(string $state) : mixed` Sets the state to be stored on the client side. This method should only be used by framework and control developers.
`public`	`setClientSupportsJavaScript(bool $value) : mixed`
`public`	`setEnableStateCompression(bool $value) : mixed`
`public`	`setEnableStateEncryption(bool $value) : mixed`
`public`	`setEnableStateIGBinary(bool $value) : mixed`
`public`	`setEnableStateValidation(bool $value) : mixed`
`public`	`setFocus(string\|TControl $value) : mixed` Sets input focus on a control after the page is rendered to users.
`public`	`setForm(TForm $form) : mixed` Registers a TForm instance to the page. Note, a page can contain at most one TForm instance.
`public`	`setHead(THead $value) : mixed`
`public`	`setPagePath(string $value) : mixed`
`public`	`setPostBackEventParameter(string $value) : mixed`
`public`	`setPostBackEventTarget(TControl $control) : mixed` Registers a control to raise postback event in the current request.
`public`	`setStatePersisterClass(string $value) : mixed`
`public`	`setStyleSheetTheme(string\|TTheme $value) : mixed` Sets the stylesheet theme to be used for the page.
`public`	`setTheme(string\|TTheme $value) : mixed` Sets the theme to be used for the page.
`public`	`setTitle(string $value) : mixed` Sets the page title. Note, a THead control needs to place on the page in order that this title be rendered.
`public`	`validate([string $validationGroup = null ]) : mixed` 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.
`protected static`	`decodeUTF8(mixed $data, mixed $enc) : mixed`
`protected`	`isSystemPostField(string $field) : bool`
`protected`	`loadPageState() : mixed` Loads page state from persistent storage.
`protected`	`processCallbackRequest(mixed $writer) : mixed` Sets Adapter to TActivePageAdapter and calls apter to process the callback request.
`protected`	`processNormalRequest(mixed $writer) : mixed`
`protected`	`processPostBackRequest(mixed $writer) : mixed`
`protected`	`processPostData(TMap $postData, bool $beforeLoad) : mixed` Processes post data.
`protected`	`raiseChangedEvents() : mixed` Raises OnPostDataChangedEvent for controls whose data have been changed due to the postback.
`protected`	`raisePostBackEvent() : mixed` Raises PostBack event.
`protected`	`savePageState() : mixed` Saves page state from persistent storage.
`private`	`determinePostBackMode() : mixed` Determines whether the current page request is a postback. Call getIsPostBack to get the result.
`private`	`getCssMediaType(string $url, object $theme) : string` Determines the media type of the CSS file. The media type is determined according to the following file name pattern: xxx.media-type.extension For example, 'mystyle.print.css' means its media type is 'print'.

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addedControl, addParsedObject, applyStyleSheetSkin, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, autoBindProperty, bindProperty, broadcastEvent, bubbleEvent, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, clearNamingContainer, clearViewState, convertUniqueIdToClientId, createChildControls, createdOnTemplate, dataBind, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, ensureChildControls, evaluateExpression, evaluateStatements, findControl, findControlsByID, findControlsByType, focus, fxAttachClassBehavior, fxDetachClassBehavior, getAdapter, getAllowChildControls, getApplication, getAttribute, getAttributes, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getClientID, getControls, getCustomData, getEnabled, getEnableTheming, getEnableViewState, getEventHandlers, getHasAdapter, getHasAttributes, getHasChildInitialized, getHasControls, getHasInitialized, getHasLoaded, getHasLoadedPostData, getHasPreRendered, getID, getIsSkinApplied, getIsSourceTemplateControl, getListeningToGlobalEvents, getMaster, getMasterClass, getNamingContainer, getPage, getParent, getPluginModule, getRegisteredObject, getRequest, getResponse, getService, getSession, getSkinID, getSourceTemplateControl, getSubProperty, getTemplate, getTemplateControl, getTemplateDirectory, getUniqueID, getUser, getViewState, getVisible, hasAttribute, hasEvent, hasEventHandler, hasMethod, hasProperty, injectContent, isa, isObjectRegistered, listen, loadState, onDataBinding, onInit, onLoad, onPreRender, onUnload, publishAsset, publishFilePath, raiseEvent, registerContent, registerContentPlaceHolder, registerObject, removeAttribute, removedControl, render, renderChildren, renderControl, saveState, setAdapter, setAttribute, setCustomData, setEnabled, setEnableTheming, setEnableViewState, setID, setMasterClass, setPage, setSkinID, setSubProperty, setTemplate, setTemplateControl, setViewState, setVisible, trackViewState, tryToUpdateAR, tryToUpdateView, unbindProperty, unlisten, unregisterObject, _getZappableSleepProps, autoDataBindProperties, clearChildState, clearControlState, createControlCollection, dataBindChildren, dataBindProperties, getCallChain, getChildControlsCreated, getClassFxEvents, getControlStage, getControlState, initRecursive, instanceBehavior, isDescendentOf, loadRecursive, loadStateRecursive, loadTemplate, preRenderRecursive, raiseBubbleEvent, saveStateRecursive, setChildControlsCreated, setControlStage, setControlState, traverseChildControls, unloadRecursive, broadcastEventInternal, clearCachedUniqueID, clearNameTable, fillNameTable, filter_prado_fx, generateAutomaticID

Constants summary
`public mixed`	`FIELD_CALLBACK_PARAMETER`	`'PRADO_CALLBACK_PARAMETER'`
`public mixed`	`FIELD_CALLBACK_TARGET`	`'PRADO_CALLBACK_TARGET'`
`public mixed`	`FIELD_LASTFOCUS`	`'PRADO_LASTFOCUS'`
`public mixed`	`FIELD_PAGESTATE`	`'PRADO_PAGESTATE'`
`public mixed`	`FIELD_POSTBACK_PARAMETER`	`'PRADO_POSTBACK_PARAMETER'`
`public mixed`	`FIELD_POSTBACK_TARGET` system post fields	`'PRADO_POSTBACK_TARGET'`

Inherited constants
\Prado\Web\UI\TControl::AUTOMATIC_ID_PREFIX, \Prado\Web\UI\TControl::CLIENT_ID_SEPARATOR, \Prado\Web\UI\TControl::CS_CHILD_INITIALIZED, \Prado\Web\UI\TControl::CS_CONSTRUCTED, \Prado\Web\UI\TControl::CS_INITIALIZED, \Prado\Web\UI\TControl::CS_LOADED, \Prado\Web\UI\TControl::CS_PRERENDERED, \Prado\Web\UI\TControl::CS_STATE_LOADED, \Prado\Web\UI\TTemplateControl::EXT_TEMPLATE, \Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER, \Prado\Web\UI\TControl::ID_FORMAT, \Prado\Web\UI\TControl::ID_SEPARATOR, \Prado\Web\UI\TControl::IS_CHILD_CREATED, \Prado\Web\UI\TControl::IS_CREATING_CHILD, \Prado\Web\UI\TControl::IS_DISABLE_THEMING, \Prado\Web\UI\TControl::IS_DISABLE_VIEWSTATE, \Prado\Web\UI\TControl::IS_ID_SET, \Prado\Web\UI\TControl::IS_SKIN_APPLIED, \Prado\Web\UI\TControl::IS_STYLESHEET_APPLIED, \Prado\Web\UI\TControl::RF_ADAPTER, \Prado\Web\UI\TControl::RF_AUTO_BINDINGS, \Prado\Web\UI\TControl::RF_CHILD_STATE, \Prado\Web\UI\TControl::RF_CONTROLS, \Prado\Web\UI\TControl::RF_CONTROLSTATE, \Prado\Web\UI\TControl::RF_DATA_BINDINGS, \Prado\Web\UI\TControl::RF_EVENTS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS_ID, \Prado\Web\UI\TControl::RF_NAMED_OBJECTS, \Prado\Web\UI\TControl::RF_SKIN_ID

Classes

Interfaces

Traits

Search results

Class \Prado\Web\UI\TPage

Class hierarchy