• Главная
• Prado
• Web
• UI
• TControl

PHP Класс Prado\Web\UI\TControl

TControl is the base class for all components on a page hierarchy. It implements the following features for UI-related functionalities: - databinding feature - parent and child relationship - naming container and containee relationship - viewstate and controlstate features - rendering scheme - control lifecycles A property can be data-bound with an expression. By calling {@link dataBind}, expressions bound to properties will be evaluated and the results will be set to the corresponding properties. Parent and child relationship determines how the presentation of controls are enclosed within each other. A parent will determine where to place the presentation of its child controls. For example, a TPanel will enclose all its child controls' presentation within a div html tag. A control's parent can be obtained via {@link getParent Parent} property, and its {@link getControls Controls} property returns a list of the control's children, including controls and static texts. The property can be manipulated like an array for adding or removing a child (see {@link TList} for more details). A naming container control implements INamingContainer and ensures that its containee controls can be differentiated by their ID property values. Naming container and containee realtionship specifies a protocol to uniquely identify an arbitrary control on a page hierarchy by an ID path (concatenation of all naming containers' IDs and the target control's ID). Viewstate and controlstate are two approaches to preserve state across page postback requests. ViewState is mainly related with UI specific state and can be disabled if not needed. ControlState represents crucial logic state and cannot be disabled. A control is rendered via its {@link render()} method (the method is invoked by the framework.) Descendant control classes may override this method for customized rendering. By default, {@link render()} invokes {@link renderChildren()} which is responsible for rendering of children of the control. Control's {@link getVisible Visible} property governs whether the control should be rendered or not. Each control on a page will undergo a series of lifecycles, including control construction, Init, Load, PreRender, Render, and OnUnload. They work together with page lifecycles to process a page request. Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод	Описание
__get ( $name ) : mixed	Returns a property value by name or a control by ID.
__isset ( $name ) : boolean	Checks for the existance of a property value by name or a control by ID.
addParsedObject ( $object )	Adds the object instantiated on a template to the child control collection.
addedControl ( $control )	Adds a control into the child collection of the control.
applyStyleSheetSkin ( $page )	Applies a stylesheet skin to a control.
autoBindProperty ( $name, $expression )	Sets up the binding between a property (or property path) and an expression.
bindProperty ( $name, $expression )	Sets up the binding between a property (or property path) and an expression.
broadcastEvent ( $name, $sender, $param )	Broadcasts an event.
bubbleEvent ( $sender, $param ) : boolean	This method responds to a bubbled event.
clearNamingContainer ( )	Resets the control as a naming container.
clearViewState ( $key )	Clears a viewstate value.
convertUniqueIdToClientId ( $uniqueID ) : string	Converts a unique ID to a client ID.
createChildControls ( )	Creates child controls.
dataBind ( )	Performs the databinding for this control.
ensureChildControls ( )	Ensures child controls are created.
findControl ( $id ) : TControl | null	Finds a control by ID path within the current naming container.
findControlsByID ( $id ) : array	Finds all child and grand-child controls with the specified ID.
findControlsByType ( $type, $strict = true ) : array	Finds all child and grand-child controls that are of the specified type.
focus ( )	Sets input focus to this control.
getAdapter ( ) : TControlAdapter
getAllowChildControls ( ) : boolean
getAttribute ( $name ) : string
getAttributes ( ) : TAttributeCollection	Returns the list of custom attributes.
getClientID ( ) : string	Returns the client ID of the control.
getControls ( ) : TControlCollection
getCustomData ( ) : mixed	Returns custom data associated with this control.
getEnableTheming ( ) : boolean
getEnableViewState ( $checkParents = false ) : boolean
getEnabled ( $checkParents = false ) : boolean	Returns a value indicating whether the control is enabled.
getHasAdapter ( ) : boolean
getHasAttributes ( ) : boolean
getHasChildInitialized ( ) : boolean
getHasControls ( ) : boolean
getHasInitialized ( ) : boolean
getHasLoaded ( ) : boolean
getHasLoadedPostData ( ) : boolean
getHasPreRendered ( ) : boolean
getID ( $hideAutoID = true ) : string	Returns the id of the control.
getIsSkinApplied ( )
getNamingContainer ( ) : TControl
getPage ( ) : TPage
getParent ( ) : TControl
getRegisteredObject ( $name ) : mixed	Returns the named registered object.
getSkinID ( ) : string
getSourceTemplateControl ( ) : TTemplateControl
getTemplateControl ( ) : TTemplateControl
getUniqueID ( ) : string	Returns a unique ID that identifies the control in the page hierarchy.
getViewState ( $key, $defaultValue = null ) : mixed	Returns a viewstate value.
getVisible ( $checkParents = true ) : boolean	Checks if a control is visible.
hasAttribute ( $name ) : boolean
isObjectRegistered ( $name ) : boolean
loadState ( )	This method is invoked right after the control has loaded its state.
onDataBinding ( $param )	Raises 'OnDataBinding' event.
onInit ( $param )	This method is invoked when the control enters 'OnInit' stage.
onLoad ( $param )	This method is invoked when the control enters 'OnLoad' stage.
onPreRender ( $param )	This method is invoked when the control enters 'OnPreRender' stage.
onUnload ( $param )	This method is invoked when the control enters 'OnUnload' stage.
registerObject ( $name, $object )	Registers an object by a name.
removeAttribute ( $name ) : string	Removes the named attribute.
removedControl ( $control )	Removes a control from the child collection of the control.
render ( $writer )	Renders the control.
renderChildren ( $writer )	Renders the children of the control.
renderControl ( $writer )	Renders the control.
saveState ( )	This method is invoked when control state is to be saved.
setAdapter ( TControlAdapter $adapter )
setAttribute ( $name, $value )	Sets a custom control attribute.
setCustomData ( $value )	Associates custom data with this control.
setEnableTheming ( $value )
setEnableViewState ( $value )
setEnabled ( $value )
setID ( $id )
setPage ( $page )	Sets the page for a control.
setSkinID ( $value )
setTemplateControl ( $control )	Sets the control whose template contains this control.
setViewState ( $key, $value, $defaultValue = null )	Sets a viewstate value.
setVisible ( $value )
trackViewState ( $enabled )	Sets a value indicating whether we should keep data in viewstate.
unbindProperty ( $name )	Breaks the binding between a property (or property path) and an expression.
unregisterObject ( $name )	Unregisters an object by name.

Защищенные методы

Метод	Описание
autoDataBindProperties ( )	Auto databinding properties of the control.
clearChildState ( )	Clears up the child state data.
clearControlState ( $key )	Clears a controlstate value.
createControlCollection ( ) : TControlCollection	Creates a control collection object that is to be used to hold child controls
dataBindChildren ( )	Databinding child controls.
dataBindProperties ( )	Databinding properties of the control.
getChildControlsCreated ( ) : boolean
getControlStage ( ) : integer	Gets the lifecycle step the control is currently at.
getControlState ( $key, $defaultValue = null ) : mixed	Returns a controlstate value.
initRecursive ( $namingContainer = null )	Performs the Init step for the control and all its child controls.
isDescendentOf ( $ancestor ) : boolean
loadRecursive ( )	Performs the Load step for the control and all its child controls.
loadStateRecursive ( &$state, $needViewState = true )	Loads state (viewstate and controlstate) into a control and its children.
preRenderRecursive ( )	Performs the PreRender step for the control and all its child controls.
raiseBubbleEvent ( $sender, $param )	Invokes the parent's bubbleEvent method.
saveStateRecursive ( $needViewState = true ) : array	Saves all control state (viewstate and controlstate) as a collection.
setChildControlsCreated ( $value )	Sets a value indicating whether child controls are created.
setControlStage ( $value )	Sets the lifecycle step the control is currently at.
setControlState ( $key, $value, $defaultValue = null )	Sets a controlstate value.
traverseChildControls ( $param, $preCallback = null, $postCallback = null )	Traverse the whole control hierarchy rooted at this control.
unloadRecursive ( )	Performs the Unload step for the control and all its child controls.

Приватные методы

Метод	Описание
broadcastEventInternal ( $name, $sender, $param )	Recursively broadcasts an event.
clearCachedUniqueID ( $recursive )	Clears the cached UniqueID.
clearNameTable ( )	Clears the list of the controls whose IDs are managed by the specified naming container.
fillNameTable ( $container, $controls )	Updates the list of the controls whose IDs are managed by the specified naming container.
generateAutomaticID ( )	Generates an automatic ID for the control.

Описание методов