From 502676c24a6889051b82de1697596ccfeed77f65 Mon Sep 17 00:00:00 2001 From: xue <> Date: Sun, 4 Jun 2006 15:33:50 +0000 Subject: Some minor documentation change. Changed TControl::onBubbleEvent() to TControl::bubbleEvent() --- framework/Web/UI/TControl.php | 9 +++++---- framework/Web/UI/WebControls/TDataBoundControl.php | 8 ++++---- framework/Web/UI/WebControls/TDataGrid.php | 11 ++++------- framework/Web/UI/WebControls/TDataList.php | 6 ++---- framework/Web/UI/WebControls/TMultiView.php | 2 +- framework/Web/UI/WebControls/TRepeater.php | 6 ++---- framework/Web/UI/WebControls/TWizard.php | 2 +- 7 files changed, 19 insertions(+), 25 deletions(-) (limited to 'framework/Web') diff --git a/framework/Web/UI/TControl.php b/framework/Web/UI/TControl.php index 36cc34dd..21065ae6 100644 --- a/framework/Web/UI/TControl.php +++ b/framework/Web/UI/TControl.php @@ -590,6 +590,7 @@ class TControl extends TApplicationComponent implements IRenderable, IBindable } /** + * Sets a custom control attribute. * @param string attribute name * @param string value of the attribute */ @@ -1315,18 +1316,18 @@ class TControl extends TApplicationComponent implements IRenderable, IBindable } /** - * Invokes the parent's onBubbleEvent method. + * 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 - * @see onBubbleEvent + * @see bubbleEvent */ protected function raiseBubbleEvent($sender,$param) { $control=$this; while($control=$control->_parent) { - if($control->onBubbleEvent($sender,$param)) + if($control->bubbleEvent($sender,$param)) break; } } @@ -1340,7 +1341,7 @@ class TControl extends TApplicationComponent implements IRenderable, IBindable * @return boolean true if the event bubbling is handled and no more bubbling. * @see raiseBubbleEvent */ - public function onBubbleEvent($sender,$param) + public function bubbleEvent($sender,$param) { return false; } diff --git a/framework/Web/UI/WebControls/TDataBoundControl.php b/framework/Web/UI/WebControls/TDataBoundControl.php index 9e6ecbf3..09023b66 100644 --- a/framework/Web/UI/WebControls/TDataBoundControl.php +++ b/framework/Web/UI/WebControls/TDataBoundControl.php @@ -128,7 +128,7 @@ abstract class TDataBoundControl extends TWebControl } /** - * @return boolean if databind has been invoked in the previous page request + * @return boolean whether databind has been invoked in the previous page request */ protected function getIsDataBound() { @@ -272,7 +272,7 @@ abstract class TDataBoundControl extends TWebControl } /** - * Sets page's OnPreLoad event handler as {@link onPagePreLoad}. + * Sets page's OnPreLoad event handler as {@link pagePreLoad}. * If viewstate is disabled and the current request is a postback, * {@link setRequiresDataBinding RequiresDataBinding} will be set true. * This method overrides the parent implementation. @@ -282,7 +282,7 @@ abstract class TDataBoundControl extends TWebControl { parent::onInit($param); $page=$this->getPage(); - $page->attachEventHandler('OnPreLoad',array($this,'onPagePreLoad')); + $page->attachEventHandler('OnPreLoad',array($this,'pagePreLoad')); } /** @@ -291,7 +291,7 @@ abstract class TDataBoundControl extends TWebControl * @param mixed event sender * @param TEventParameter event parameter */ - public function onPagePreLoad($sender,$param) + public function pagePreLoad($sender,$param) { $this->_initialized=true; $isPostBack=$this->getPage()->getIsPostBack(); diff --git a/framework/Web/UI/WebControls/TDataGrid.php b/framework/Web/UI/WebControls/TDataGrid.php index 82c243ca..d2625c0d 100644 --- a/framework/Web/UI/WebControls/TDataGrid.php +++ b/framework/Web/UI/WebControls/TDataGrid.php @@ -217,7 +217,7 @@ class TDataGrid extends TBaseDataList implements INamingContainer } /** - * @return TDataGridColumnCollection automatically specified datagrid columns + * @return TDataGridColumnCollection automatically generated datagrid columns */ public function getAutoColumns() { @@ -683,7 +683,6 @@ class TDataGrid extends TBaseDataList implements INamingContainer } /** - * Handles OnBubbleEvent. * This method overrides parent's implementation to handle * {@link onItemCommand OnItemCommand} event which is bubbled from * {@link TDataGridItem} child controls. @@ -696,7 +695,7 @@ class TDataGrid extends TBaseDataList implements INamingContainer * @param TEventParameter event parameter * @return boolean whether the event bubbling should stop here. */ - public function onBubbleEvent($sender,$param) + public function bubbleEvent($sender,$param) { if($param instanceof TDataGridCommandEventParameter) { @@ -1890,14 +1889,13 @@ class TDataGridItem extends TTableRow implements INamingContainer } /** - * Handles BubbleEvent. * This method overrides parent's implementation by wrapping event parameter * for OnCommand event with item information. * @param TControl the sender of the event * @param TEventParameter event parameter * @return boolean whether the event bubbling should stop here. */ - public function onBubbleEvent($sender,$param) + public function bubbleEvent($sender,$param) { if($param instanceof TCommandEventParameter) { @@ -1934,14 +1932,13 @@ class TDataGridPager extends TPanel implements INamingContainer } /** - * Handles BubbleEvent. * This method overrides parent's implementation by wrapping event parameter * for OnCommand event with item information. * @param TControl the sender of the event * @param TEventParameter event parameter * @return boolean whether the event bubbling should stop here. */ - public function onBubbleEvent($sender,$param) + public function bubbleEvent($sender,$param) { if($param instanceof TCommandEventParameter) { diff --git a/framework/Web/UI/WebControls/TDataList.php b/framework/Web/UI/WebControls/TDataList.php index 695d072a..0bec8921 100644 --- a/framework/Web/UI/WebControls/TDataList.php +++ b/framework/Web/UI/WebControls/TDataList.php @@ -635,7 +635,6 @@ class TDataList extends TBaseDataList implements INamingContainer, IRepeatInfoUs } /** - * Handles BubbleEvent. * This method overrides parent's implementation to handle * {@link onItemCommand OnItemCommand} event which is bubbled from * {@link TDataListItem} child controls. @@ -648,7 +647,7 @@ class TDataList extends TBaseDataList implements INamingContainer, IRepeatInfoUs * @param TEventParameter event parameter * @return boolean whether the event bubbling should stop here. */ - public function onBubbleEvent($sender,$param) + public function bubbleEvent($sender,$param) { if($param instanceof TDataListCommandEventParameter) { @@ -1356,14 +1355,13 @@ class TDataListItem extends TWebControl implements INamingContainer } /** - * Handles BubbleEvent. * This method overrides parent's implementation by wrapping event parameter * for Command event with item information. * @param TControl the sender of the event * @param TEventParameter event parameter * @return boolean whether the event bubbling should stop here. */ - public function onBubbleEvent($sender,$param) + public function bubbleEvent($sender,$param) { if($param instanceof TCommandEventParameter) { diff --git a/framework/Web/UI/WebControls/TMultiView.php b/framework/Web/UI/WebControls/TMultiView.php index 59b9f53d..b6001f90 100644 --- a/framework/Web/UI/WebControls/TMultiView.php +++ b/framework/Web/UI/WebControls/TMultiView.php @@ -213,7 +213,7 @@ class TMultiView extends TControl * @param mixed event parameter * @return boolean whether this event is handled */ - public function onBubbleEvent($sender,$param) + public function bubbleEvent($sender,$param) { if(!$this->_ignoreBubbleEvents && ($param instanceof TCommandEventParameter)) { diff --git a/framework/Web/UI/WebControls/TRepeater.php b/framework/Web/UI/WebControls/TRepeater.php index 9aa7af8d..2070cb1a 100644 --- a/framework/Web/UI/WebControls/TRepeater.php +++ b/framework/Web/UI/WebControls/TRepeater.php @@ -463,7 +463,6 @@ class TRepeater extends TDataBoundControl implements INamingContainer } /** - * Handles BubbleEvent. * This method overrides parent's implementation to handle * {@link onItemCommand OnItemCommand} event which is bubbled from * {@link TRepeaterItem} child controls. @@ -472,7 +471,7 @@ class TRepeater extends TDataBoundControl implements INamingContainer * @param TEventParameter event parameter * @return boolean whether the event bubbling should stop here. */ - public function onBubbleEvent($sender,$param) + public function bubbleEvent($sender,$param) { if($param instanceof TRepeaterCommandEventParameter) { @@ -717,14 +716,13 @@ class TRepeaterItem extends TControl implements INamingContainer } /** - * Handles BubbleEvent. * This method overrides parent's implementation by wrapping event parameter * for Command event with item information. * @param TControl the sender of the event * @param TEventParameter event parameter * @return boolean whether the event bubbling should stop here. */ - public function onBubbleEvent($sender,$param) + public function bubbleEvent($sender,$param) { if($param instanceof TCommandEventParameter) { diff --git a/framework/Web/UI/WebControls/TWizard.php b/framework/Web/UI/WebControls/TWizard.php index 2cc3f346..f92742e7 100644 --- a/framework/Web/UI/WebControls/TWizard.php +++ b/framework/Web/UI/WebControls/TWizard.php @@ -1333,7 +1333,7 @@ class TWizard extends TWebControl implements INamingContainer * @param TEventParameter event parameter * @throws TInvalidDataValueException if a navigation command is associated with an invalid parameter */ - public function onBubbleEvent($sender,$param) + public function bubbleEvent($sender,$param) { if($param instanceof TCommandEventParameter) { -- cgit v1.2.3