[ Index ]
 

Code source de PRADO 3.0.6

Accédez au Source d'autres logiciels libresSoutenez Angelica Josefina !

title

Body

[fermer]

/framework/Web/UI/ -> TControl.php (sommaire)

TControl, TControlCollection, TEventParameter and INamingContainer class file

Author: Qiang Xue <qiang.xue@gmail.com>
Copyright: Copyright © 2005 PradoSoft
License: http://www.pradosoft.com/license/
Version: $Id: TControl.php 1528 2006-11-29 01:50:37Z xue $
Poids: 2238 lignes (66 kb)
Inclus ou requis:0 fois
Référencé: 0 fois
Nécessite: 0 fichiers

Définit 15 classes

TControl:: (97 méthodes):
  __construct()
  __get()
  getHasAdapter()
  getAdapter()
  setAdapter()
  getParent()
  getNamingContainer()
  getPage()
  setPage()
  setTemplateControl()
  getTemplateControl()
  getSourceTemplateControl()
  getControlStage()
  setControlStage()
  getID()
  setID()
  getUniqueID()
  focus()
  getClientID()
  getSkinID()
  setSkinID()
  getEnableTheming()
  setEnableTheming()
  getCustomData()
  setCustomData()
  getHasControls()
  getControls()
  createControlCollection()
  getVisible()
  setVisible()
  getEnabled()
  setEnabled()
  getHasAttributes()
  getAttributes()
  hasAttribute()
  getAttribute()
  setAttribute()
  removeAttribute()
  getEnableViewState()
  setEnableViewState()
  getControlState()
  setControlState()
  clearControlState()
  getViewState()
  setViewState()
  clearViewState()
  bindProperty()
  unbindProperty()
  autoBindProperty()
  dataBind()
  dataBindProperties()
  autoDataBindProperties()
  dataBindChildren()
  getChildControlsCreated()
  setChildControlsCreated()
  ensureChildControls()
  createChildControls()
  findControl()
  findControlsByType()
  findControlsByID()
  clearNamingContainer()
  registerObject()
  unregisterObject()
  isObjectRegistered()
  getRegisteredObject()
  getAllowChildControls()
  addParsedObject()
  clearChildState()
  isDescendentOf()
  addedControl()
  removedControl()
  initRecursive()
  loadRecursive()
  preRenderRecursive()
  unloadRecursive()
  onInit()
  onLoad()
  onDataBinding()
  onUnload()
  onPreRender()
  raiseBubbleEvent()
  bubbleEvent()
  broadcastEvent()
  broadcastEventInternal()
  traverseChildControls()
  renderControl()
  render()
  renderChildren()
  saveState()
  loadState()
  loadStateRecursive()
  saveStateRecursive()
  applyStyleSheetSkin()
  clearCachedUniqueID()
  generateAutomaticID()
  clearNameTable()
  fillNameTable()

TControlCollection:: (5 méthodes):
  __construct()
  getOwner()
  insertAt()
  removeAt()
  clear()

TEmptyControlCollection:: (1 méthode):
  __construct()

INamingContainer:: (0 méthodes):

IPostBackEventHandler:: (1 méthode):
  raisePostBackEvent()

IPostBackDataHandler:: (2 méthodes):
  loadPostData()
  raisePostDataChangedEvent()

IValidator:: (5 méthodes):
  validate()
  getIsValid()
  setIsValid()
  getErrorMessage()
  setErrorMessage()

IValidatable:: (1 méthode):
  getValidationPropertyValue()

IBroadcastEventReceiver:: (1 méthode):
  broadcastEventReceived()

ITheme:: (1 méthode):
  applySkin()

ITemplate:: (1 méthode):
  instantiateIn()

IButtonControl:: (12 méthodes):
  getText()
  setText()
  getCausesValidation()
  setCausesValidation()
  getCommandName()
  setCommandName()
  getCommandParameter()
  setCommandParameter()
  getValidationGroup()
  setValidationGroup()
  onClick()
  onCommand()

TBroadcastEventParameter:: (5 méthodes):
  __construct()
  getName()
  setName()
  getParameter()
  setParameter()

TCommandEventParameter:: (3 méthodes):
  __construct()
  getCommandName()
  getCommandParameter()

TCompositeLiteral:: (6 méthodes):
  __construct()
  getContainer()
  setContainer()
  evaluateDynamicContent()
  dataBind()
  render()


Classe: TControl  - X-Ref

TControl class

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.

__construct()   X-Ref
Constructor.


__get($name)   X-Ref
Returns a property value by name or a control by ID.
This overrides the parent implementation by allowing accessing
a control via its ID using the following syntax,
<code>
$menuBar=$this->menuBar;
</code>
Note, the control must be configured in the template
with explicit ID. If the name matches both a property and a control ID,
the control ID will take the precedence.

param: string the property name or control ID
return: mixed the property value or the target control

getHasAdapter()   X-Ref

return: boolean whether there is an adapter for this control

getAdapter()   X-Ref

return: TControlAdapter control adapter. Null if not exists.

setAdapter(TControlAdapter $adapter)   X-Ref

param: TControlAdapter control adapter

getParent()   X-Ref

return: TControl the parent of this control

getNamingContainer()   X-Ref

return: TControl the naming container of this control

getPage()   X-Ref

return: TPage the page that contains this control

setPage($page)   X-Ref
Sets the page for a control.
Only framework developers should use this method.

param: TPage the page that contains this control

setTemplateControl($control)   X-Ref
Sets the control whose template contains this control.
Only framework developers should use this method.

param: TTemplateControl the control whose template contains this control

getTemplateControl()   X-Ref

return: TTemplateControl the control whose template contains this control

getSourceTemplateControl()   X-Ref

return: TTemplateControl the control whose template is loaded from

getControlStage()   X-Ref
Gets the lifecycle step the control is currently at.
This method should only be used by control developers.

return: integer the lifecycle step the control is currently at.

setControlStage($value)   X-Ref
Sets the lifecycle step the control is currently at.
This method should only be used by control developers.

param: integer the lifecycle step the control is currently at.

getID($hideAutoID=true)   X-Ref
Returns the id of the control.
Control ID can be either manually set or automatically generated.
If $hideAutoID is true, automatically generated ID will be returned as an empty string.

param: boolean whether to hide automatically generated ID
return: string the ID of the control

setID($id)   X-Ref

param: string the new control ID. The value must consist of word characters [a-zA-Z0-9_] only

getUniqueID()   X-Ref
Returns a unique ID that identifies the control in the page hierarchy.
A unique ID is the contenation of all naming container controls' IDs and the control ID.
These IDs are separated by '$' character.
Control users should not rely on the specific format of UniqueID, however.

return: string a unique ID that identifies the control in the page hierarchy

focus()   X-Ref
Sets input focus to this control.


getClientID()   X-Ref
Returns the client ID of the control.
The client ID can be used to uniquely identify
the control in client-side scripts (such as JavaScript).
Do not rely on the explicit format of the return ID.

return: string the client ID of the control

getSkinID()   X-Ref

return: string the skin ID of this control, '' if not set

setSkinID($value)   X-Ref

param: string the skin ID of this control

getEnableTheming()   X-Ref

return: boolean whether theming is enabled for this control.

setEnableTheming($value)   X-Ref

param: boolean whether to enable theming

getCustomData()   X-Ref
Returns custom data associated with this control.
A control may be associated with some custom data for various purposes.
For example, a button may be associated with a string to identify itself
in a generic OnClick event handler.

return: mixed custom data associated with this control. Defaults to null.

setCustomData($value)   X-Ref
Associates custom data with this control.
Note, the custom data must be serializable and unserializable.

param: mixed custom data

getHasControls()   X-Ref

return: boolean whether the control has child controls

getControls()   X-Ref

return: TControlCollection the child control collection

createControlCollection()   X-Ref
Creates a control collection object that is to be used to hold child controls

return: TControlCollection control collection

getVisible($checkParents=true)   X-Ref
Checks if a control is visible.
If parent check is required, then a control is visible only if the control
and all its ancestors are visible.

param: boolean whether the parents should also be checked if visible
return: boolean whether the control is visible (default=true).

setVisible($value)   X-Ref

param: boolean whether the control is visible

getEnabled($checkParents=false)   X-Ref
Returns a value indicating whether the control is enabled.
A control is enabled if it allows client user interaction.
If $checkParents is true, all parent controls will be checked,
and unless they are all enabled, false will be returned.
The property Enabled is mainly used for {@link TWebControl}
derived controls.

param: boolean whether the parents should also be checked enabled
return: boolean whether the control is enabled.

setEnabled($value)   X-Ref

param: boolean whether the control is to be enabled.

getHasAttributes()   X-Ref

return: boolean whether the control has custom attributes

getAttributes()   X-Ref
Returns the list of custom attributes.
Custom attributes are name-value pairs that may be rendered
as HTML tags' attributes.

return: TAttributeCollection the list of custom attributes

hasAttribute($name)   X-Ref

return: boolean whether the named attribute exists

getAttribute($name)   X-Ref

return: string attribute value, null if attribute does not exist

setAttribute($name,$value)   X-Ref
Sets a custom control attribute.

param: string attribute name
param: string value of the attribute

removeAttribute($name)   X-Ref
Removes the named attribute.

param: string the name of the attribute to be removed.
return: string attribute value removed, null if attribute does not exist.

getEnableViewState($checkParents=false)   X-Ref

return: boolean whether viewstate is enabled

setEnableViewState($value)   X-Ref

param: boolean set whether to enable viewstate

getControlState($key,$defaultValue=null)   X-Ref
Returns a controlstate value.

This function is mainly used in defining getter functions for control properties
that must be kept in controlstate.
param: string the name of the controlstate value to be returned
param: mixed the default value. If $key is not found in controlstate, $defaultValue will be returned
return: mixed the controlstate value corresponding to $key

setControlState($key,$value,$defaultValue=null)   X-Ref
Sets a controlstate value.

This function is very useful in defining setter functions for control properties
that must be kept in controlstate.
Make sure that the controlstate value must be serializable and unserializable.
param: string the name of the controlstate value
param: mixed the controlstate value to be set
param: mixed default value. If $value===$defaultValue, the item will be cleared from controlstate

clearControlState($key)   X-Ref
Clears a controlstate value.

param: string the name of the controlstate value to be cleared

getViewState($key,$defaultValue=null)   X-Ref
Returns a viewstate value.

This function is very useful in defining getter functions for component properties
that must be kept in viewstate.
param: string the name of the viewstate value to be returned
param: mixed the default value. If $key is not found in viewstate, $defaultValue will be returned
return: mixed the viewstate value corresponding to $key

setViewState($key,$value,$defaultValue=null)   X-Ref
Sets a viewstate value.

This function is very useful in defining setter functions for control properties
that must be kept in viewstate.
Make sure that the viewstate value must be serializable and unserializable.
param: string the name of the viewstate value
param: mixed the viewstate value to be set
param: mixed default value. If $value===$defaultValue, the item will be cleared from the viewstate.

clearViewState($key)   X-Ref
Clears a viewstate value.

param: string the name of the viewstate value to be cleared

bindProperty($name,$expression)   X-Ref
Sets up the binding between a property (or property path) and an expression.
The context of the expression is the template control (or the control itself if it is a page).

param: string the property name, or property path
param: string the expression

unbindProperty($name)   X-Ref
Breaks the binding between a property (or property path) and an expression.

param: string the property name (or property path)

autoBindProperty($name,$expression)   X-Ref
Sets up the binding between a property (or property path) and an expression.
Unlike regular databinding, the expression bound by this method
is automatically evaluated during {@link prerenderRecursive()}.
The context of the expression is the template control (or the control itself if it is a page).

param: string the property name, or property path
param: string the expression

dataBind()   X-Ref
Performs the databinding for this control.


dataBindProperties()   X-Ref
Databinding properties of the control.


autoDataBindProperties()   X-Ref
Auto databinding properties of the control.


dataBindChildren()   X-Ref
Databinding child controls.


getChildControlsCreated()   X-Ref

return: boolean whether child controls have been created

setChildControlsCreated($value)   X-Ref
Sets a value indicating whether child controls are created.
If false, any existing child controls will be cleared up.

param: boolean whether child controls are created

ensureChildControls()   X-Ref
Ensures child controls are created.
If child controls are not created yet, this method will invoke
{@link createChildControls} to create them.


createChildControls()   X-Ref
Creates child controls.
This method can be overriden for controls who want to have their controls.
Do not call this method directly. Instead, call {@link ensureChildControls}
to ensure child controls are created only once.


findControl($id)   X-Ref
Finds a control by ID path within the current naming container.
The current naming container is either the control itself
if it implements {@link INamingContainer} or the control's naming container.
The ID path is an ID sequence separated by {@link TControl::ID_SEPARATOR}.
For example, 'Repeater1.Item1.Button1' looks for a control with ID 'Button1'
whose naming container is 'Item1' whose naming container is 'Repeater1'.

param: string ID of the control to be looked up
return: TControl|null the control found, null if not found

findControlsByType($type)   X-Ref
Finds all child and grand-child controls that are of the specified type.

param: string the class name
return: array list of controls found

findControlsByID($id)   X-Ref
Finds all child and grand-child controls with the specified ID.
Note, this method is different from {@link findControl} in that
it searches through all controls that have this control as the ancestor
while {@link findcontrol} only searches through controls that have this
control as the direct naming container.

param: string the ID being looked for
return: array list of controls found

clearNamingContainer()   X-Ref
Resets the control as a naming container.
Only framework developers should use this method.


registerObject($name,$object)   X-Ref
Registers an object by a name.
A registered object can be accessed like a public member variable.
This method should only be used by framework and control developers.

param: string name of the object
param: object object to be declared

unregisterObject($name)   X-Ref
Unregisters an object by name.

param: string name of the object

isObjectRegistered($name)   X-Ref

return: boolean whether an object has been registered with the name

getRegisteredObject($name)   X-Ref
Returns the named registered object.
A component with explicit ID on a template will be registered to
the template owner. This method allows you to obtain this component
with the ID.

return: mixed the named registered object. Null if object is not found.

getAllowChildControls()   X-Ref

return: boolean whether body contents are allowed for this control. Defaults to true.

addParsedObject($object)   X-Ref
Adds the object instantiated on a template to the child control collection.
This method overrides the parent implementation.
Only framework developers and control developers should use this method.

param: string|TComponent text string or component parsed and instantiated in template

clearChildState()   X-Ref
Clears up the child state data.
After a control loads its state, those state that do not belong to
any existing child controls are stored as child state.
This method will remove these state.
Only frameworker developers and control developers should use this method.


isDescendentOf($ancestor)   X-Ref

param: TControl the potential ancestor control
return: boolean if the control is a descendent (parent, parent of parent, etc.)

addedControl($control)   X-Ref
Adds a control into the child collection of the control.
Control lifecycles will be caught up during the addition.
Only framework developers should use this method.

param: TControl the new child control

removedControl($control)   X-Ref
Removes a control from the child collection of the control.
Only framework developers should use this method.

param: TControl the child control removed

initRecursive($namingContainer=null)   X-Ref
Performs the Init step for the control and all its child controls.
Only framework developers should use this method.

param: TControl the naming container control

loadRecursive()   X-Ref
Performs the Load step for the control and all its child controls.
Only framework developers should use this method.


preRenderRecursive()   X-Ref
Performs the PreRender step for the control and all its child controls.
Only framework developers should use this method.


unloadRecursive()   X-Ref
Performs the Unload step for the control and all its child controls.
Only framework developers should use this method.


onInit($param)   X-Ref
This method is invoked when the control enters 'OnInit' stage.
The method raises 'OnInit' event.
If you override this method, be sure to call the parent implementation
so that the event handlers can be invoked.

param: TEventParameter event parameter to be passed to the event handlers

onLoad($param)   X-Ref
This method is invoked when the control enters 'OnLoad' stage.
The method raises 'OnLoad' event.
If you override this method, be sure to call the parent implementation
so that the event handlers can be invoked.

param: TEventParameter event parameter to be passed to the event handlers

onDataBinding($param)   X-Ref
Raises 'OnDataBinding' event.
This method is invoked when {@link dataBind} is invoked.

param: TEventParameter event parameter to be passed to the event handlers

onUnload($param)   X-Ref
This method is invoked when the control enters 'OnUnload' stage.
The method raises 'OnUnload' event.
If you override this method, be sure to call the parent implementation
so that the event handlers can be invoked.

param: TEventParameter event parameter to be passed to the event handlers

onPreRender($param)   X-Ref
This method is invoked when the control enters 'OnPreRender' stage.
The method raises 'OnPreRender' event.
If you override this method, be sure to call the parent implementation
so that the event handlers can be invoked.

param: TEventParameter event parameter to be passed to the event handlers

raiseBubbleEvent($sender,$param)   X-Ref
Invokes the parent's bubbleEvent method.
A control who wants to bubble an event must call this method in its onEvent method.

param: TControl sender of the event
param: TEventParameter event parameter

bubbleEvent($sender,$param)   X-Ref
This method responds to a bubbled event.
This method should be overriden to provide customized response to a bubbled event.
Check the type of event parameter to determine what event is bubbled currently.

param: TControl sender of the event
param: TEventParameter event parameters
return: boolean true if the event bubbling is handled and no more bubbling.

broadcastEvent($name,$sender,$param)   X-Ref
Broadcasts an event.
The event will be sent to all controls on the current page hierarchy.
If a control defines the event, the event will be raised for the control.
If a control implements {@link IBroadcastEventReceiver}, its
{@link IBroadcastEventReceiver::broadcastEventReceived broadcastEventReceived()} method will
be invoked which gives the control a chance to respond to the event.
For example, when broadcasting event 'OnClick', all controls having 'OnClick'
event will have this event raised, and all controls implementing
{@link IBroadcastEventReceiver} will also have its
{@link IBroadcastEventReceiver::broadcastEventReceived broadcastEventReceived()}
invoked.

param: string name of the broadcast event
param: TControl sender of this event
param: TEventParameter event parameter

broadcastEventInternal($name,$sender,$param)   X-Ref
Recursively broadcasts an event.
This method should only be used by framework developers.

param: string name of the broadcast event
param: TControl sender of the event
param: TBroadcastEventParameter event parameter

traverseChildControls($param,$preCallback=null,$postCallback=null)   X-Ref
Traverse the whole control hierarchy rooted at this control.
Callback function may be invoked for each control being visited.
A pre-callback is invoked before traversing child controls;
A post-callback is invoked after traversing child controls.
Callback functions can be global functions or class methods.
They must be of the following signature:
<code>
function callback_func($control,$param) {...}
</code>
where $control refers to the control being visited and $param
is the parameter that is passed originally when calling this traverse function.

param: mixed parameter to be passed to callbacks for each control
param: callback callback invoked before traversing child controls. If null, it is ignored.
param: callback callback invoked after traversing child controls. If null, it is ignored.

renderControl($writer)   X-Ref
Renders the control.
Only when the control is visible will the control be rendered.

param: THtmlWriter the writer used for the rendering purpose

render($writer)   X-Ref
Renders the control.
This method is invoked by {@link renderControl} when the control is visible.
You can override this method to provide customized rendering of the control.
By default, the control simply renders all its child contents.

param: THtmlWriter the writer used for the rendering purpose

renderChildren($writer)   X-Ref
Renders the children of the control.
This method iterates through all child controls and static text strings
and renders them in order.

param: THtmlWriter the writer used for the rendering purpose

saveState()   X-Ref
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.


loadState()   X-Ref
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.


loadStateRecursive(&$state,$needViewState=true)   X-Ref
Loads state (viewstate and controlstate) into a control and its children.

param: TMap the collection of the state
param: boolean whether the viewstate should be loaded

saveStateRecursive($needViewState=true)   X-Ref
Saves all control state (viewstate and controlstate) as a collection.

param: boolean whether the viewstate should be saved
return: array the collection of the control state (including its children's state).

applyStyleSheetSkin($page)   X-Ref
Applies a stylesheet skin to a control.

param: TPage the page containing the control

clearCachedUniqueID($recursive)   X-Ref
Clears the cached UniqueID.
If $recursive=true, all children's cached UniqueID will be cleared as well.

param: boolean whether the clearing is recursive.

generateAutomaticID()   X-Ref
Generates an automatic ID for the control.


clearNameTable()   X-Ref
Clears the list of the controls whose IDs are managed by the specified naming container.


fillNameTable($container,$controls)   X-Ref
Updates the list of the controls whose IDs are managed by the specified naming container.

param: TControl the naming container
param: TControlCollection list of controls

Classe: TControlCollection  - X-Ref

TControlCollection class

TControlCollection implements a collection that enables
controls to maintain a list of their child controls.

__construct(TControl $owner,$readOnly=false)   X-Ref
Constructor.

param: TControl the control that owns this collection.
param: boolean whether the list is read-only

getOwner()   X-Ref

return: TControl the control that owns this collection.

insertAt($index,$item)   X-Ref
Inserts an item at the specified position.
This overrides the parent implementation by performing additional
operations for each newly added child control.

param: integer the speicified position.
param: mixed new item

removeAt($index)   X-Ref
Removes an item at the specified position.
This overrides the parent implementation by performing additional
cleanup work when removing a child control.

param: integer the index of the item to be removed.
return: mixed the removed item.

clear()   X-Ref
Overrides the parent implementation by invoking {@link TControl::clearNamingContainer}


Classe: TEmptyControlCollection  - X-Ref

TEmptyControlCollection class

TEmptyControlCollection implements an empty control list that prohibits adding
controls to it. This is useful for controls that do not allow child controls.

__construct(TControl $owner)   X-Ref
Constructor.

param: TControl the control that owns this collection.

Interface: INamingContainer  - X-Ref

INamingContainer interface.
INamingContainer marks a control as a naming container.

Interface: IPostBackEventHandler  - X-Ref

IPostBackEventHandler interface

If a control wants to respond to postback event, it must implement this interface.

raisePostBackEvent($param)   X-Ref
Raises postback event.
The implementation of this function should raise appropriate event(s) (e.g. OnClick, OnCommand)
indicating the component is responsible for the postback event.

param: string the parameter associated with the postback event

Interface: IPostBackDataHandler  - X-Ref

IPostBackDataHandler interface

If a control wants to load post data, it must implement this interface.

loadPostData($key,$values)   X-Ref
Loads user input data.
The implementation of this function can use $values[$key] to get the user input
data that are meant for the particular control.

param: string the key that can be used to retrieve data from the input data collection
param: array the input data collection
return: boolean whether the data of the control has been changed

raisePostDataChangedEvent()   X-Ref
Raises postdata changed event.
The implementation of this function should raise appropriate event(s) (e.g. OnTextChanged)
indicating the control data is changed.


Interface: IValidator  - X-Ref

IValidator interface

If a control wants to validate user input, it must implement this interface.

validate()   X-Ref
Validates certain data.
The implementation of this function should validate certain data
(e.g. data entered into TTextBox control).

return: boolean whether the data passes the validation

getIsValid()   X-Ref

return: boolean whether the previous {@link validate()} is successful.

setIsValid($value)   X-Ref

param: boolean whether the validator validates successfully

getErrorMessage()   X-Ref

return: string error message during last validate

setErrorMessage($value)   X-Ref

param: string error message for the validation

Interface: IValidatable  - X-Ref

IValidatable interface

If a control wants to be validated by a validator, it must implement this interface.

getValidationPropertyValue()   X-Ref

return: mixed the value of the property to be validated.

Interface: IBroadcastEventReceiver  - X-Ref

IBroadcastEventReceiver interface

If a control wants to check broadcast event, it must implement this interface.

broadcastEventReceived($sender,$param)   X-Ref
Handles broadcast event.
This method is invoked automatically when an event is broadcasted.
Within this method, you may check the event name given in
the event parameter to determine  whether you should respond to
this event.

param: TControl sender of the event
param: TBroadCastEventParameter event parameter

Interface: ITheme  - X-Ref

ITheme interface.

This interface must be implemented by theme.

applySkin($control)   X-Ref
Applies this theme to the specified control.

param: TControl the control to be applied with this theme

Interface: ITemplate  - X-Ref

ITemplate interface

ITemplate specifies the interface for classes encapsulating
parsed template structures.

instantiateIn($parent)   X-Ref
Instantiates the template.
Content in the template will be instantiated as components and text strings
and passed to the specified parent control.

param: TControl the parent control

Interface: IButtonControl  - X-Ref

IButtonControl interface

IButtonControl specifies the common properties and events that must
be implemented by a button control, such as {@link TButton}, {@link TLinkButton},
{@link TImageButton}.

getText()   X-Ref

return: string caption of the button

setText($value)   X-Ref

param: string caption of the button

getCausesValidation()   X-Ref

return: boolean whether postback event trigger by this button will cause input validation

setCausesValidation($value)   X-Ref

param: boolean whether postback event trigger by this button will cause input validation

getCommandName()   X-Ref

return: string the command name associated with the {@link onCommand OnCommand} event.

setCommandName($value)   X-Ref

param: string the command name associated with the {@link onCommand OnCommand} event.

getCommandParameter()   X-Ref

return: string the parameter associated with the {@link onCommand OnCommand} event

setCommandParameter($value)   X-Ref

param: string the parameter associated with the {@link onCommand OnCommand} event.

getValidationGroup()   X-Ref

return: string the group of validators which the button causes validation upon postback

setValidationGroup($value)   X-Ref

param: string the group of validators which the button causes validation upon postback

onClick($param)   X-Ref
Raises <b>OnClick</b> event.

param: TEventParameter event parameter to be passed to the event handlers

onCommand($param)   X-Ref
Raises <b>OnCommand</b> event.

param: TCommandEventParameter event parameter to be passed to the event handlers

Classe: TBroadcastEventParameter  - X-Ref

TBroadcastEventParameter class

TBroadcastEventParameter encapsulates the parameter data for
events that are broadcasted. The name of of the event is specified via
{@link setName Name} property while the event parameter is via
{@link setParameter Parameter} property.

__construct($name='',$parameter=null)   X-Ref
Constructor.

param: string name of the broadcast event
param: mixed parameter of the broadcast event

getName()   X-Ref

return: string name of the broadcast event

setName($value)   X-Ref

param: string name of the broadcast event

getParameter()   X-Ref

return: mixed parameter of the broadcast event

setParameter($value)   X-Ref

param: mixed parameter of the broadcast event

Classe: TCommandEventParameter  - X-Ref

TCommandEventParameter class

TCommandEventParameter encapsulates the parameter data for <b>Command</b>
event of button controls. You can access the name of the command via
{@link getCommandName CommandName} property, and the parameter carried
with the command via {@link getCommandParameter CommandParameter} property.

__construct($name='',$parameter='')   X-Ref
Constructor.

param: string name of the command
param: string parameter of the command

getCommandName()   X-Ref

return: string name of the command

getCommandParameter()   X-Ref

return: string parameter of the command

Classe: TCompositeLiteral  - X-Ref

TCompositeLiteral class

TCompositeLiteral is used internally by {@link TTemplate} for representing
consecutive static strings, expressions and statements.

__construct($items)   X-Ref
Constructor.

param: array list of items to be represented by TCompositeLiteral

getContainer()   X-Ref

return: TComponent container of this component. It serves as the evaluation context of expressions and statements.

setContainer(TComponent $value)   X-Ref

param: TComponent container of this component. It serves as the evaluation context of expressions and statements.

evaluateDynamicContent()   X-Ref
Evaluates the expressions and/or statements in the component.


dataBind()   X-Ref
Performs databindings.
This method is required by {@link IBindable}


render($writer)   X-Ref
Renders the content stored in this component.
This method is required by {@link IRenderable}

param: ITextWriter



Généré le : Sun Feb 25 21:07:04 2007 par Balluche grâce à PHPXref 0.7