From cdfe42047b3988152afaff124b0f9e8b34ab7f13 Mon Sep 17 00:00:00 2001 From: xue <> Date: Thu, 29 Dec 2005 23:28:17 +0000 Subject: Implemented broadcast event mechanism. --- demos/quickstart/themes/Simple/style.css | 3 +- framework/Web/UI/TControl.php | 124 ++++++++++++++++++++++++++++++- 2 files changed, 125 insertions(+), 2 deletions(-) diff --git a/demos/quickstart/themes/Simple/style.css b/demos/quickstart/themes/Simple/style.css index 406384d3..31fb71f4 100644 --- a/demos/quickstart/themes/Simple/style.css +++ b/demos/quickstart/themes/Simple/style.css @@ -163,9 +163,10 @@ tt { } .samplepanel { - margin: 10px; + margin: 0px; border: 1px solid silver; padding: 10px; + margin-bottom:10px; } .sampletitle { diff --git a/framework/Web/UI/TControl.php b/framework/Web/UI/TControl.php index a70e2c75..372e87df 100644 --- a/framework/Web/UI/TControl.php +++ b/framework/Web/UI/TControl.php @@ -1148,6 +1148,42 @@ class TControl extends TComponent return false; } + /** + * Broadcasts an event. + * The event will be sent to all controls on the current page hierarchy. + * If this control is not on a page, the event will be sent to all its + * child controls recursively. + * Controls implementing {@link IBroadcastEventReceiver} will get a chance + * to respond to the event. + * @param TControl sender of the event + * @param TBroadcastEventParameter event parameter + */ + protected function broadcastEvent($sender,TBroadCastEventParameter $param) + { + $origin=(($page=$this->getPage())===null)?$this:$page; + $origin->broadcastEventInternal($sender,$param); + } + + /** + * Recursively broadcasts an event. + * This method should only be used by framework developers. + * @param TControl sender of the event + * @param TBroadcastEventParameter event parameter + */ + final protected function broadcastEventInternal($sender,$param) + { + if($this instanceof IBroadcastEventReceiver) + $this->broadcastEventReceived($sender,$param); + if($this->getHasControls()) + { + foreach($this->_rf[self::RF_CONTROLS] as $control) + { + if($control instanceof TControl) + $control->broadcastEventInternal($sender,$param); + } + } + } + /** * Renders the control. * Only when the control is visible will the control be rendered. @@ -1586,10 +1622,96 @@ interface IValidatable public function getValidationPropertyValue(); } +/** + * IBroadcastEventReceiver interface + * + * If a control wants to check broadcast event, it must implement this interface. + * + * @author Qiang Xue + * @version $Revision: $ $Date: $ + * @package System.Web.UI + * @since 3.0 + */ +interface IBroadcastEventReceiver +{ + /** + * 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 + */ + public function broadcastEventReceived($sender,$param); +} + +/** + * 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. + * + * @author Qiang Xue + * @version $Revision: $ $Date: $ + * @package System.Web.UI + * @since 3.0 + */ +class TBroadcastEventParameter extends TEventParameter +{ + private $_name; + private $_param; + + /** + * Constructor. + * @param string name of the broadcast event + * @param mixed parameter of the broadcast event + */ + public function __construct($name='',$parameter=null) + { + $this->_name=$name; + $this->_param=$parameter; + } + + /** + * @return string name of the broadcast event + */ + public function getName() + { + return $this->_name; + } + + /** + * @param string name of the broadcast event + */ + public function setName($value) + { + $this->_name=$value; + } + + /** + * @return mixed parameter of the broadcast event + */ + public function getParameter() + { + return $this->_param; + } + + /** + * @param mixed parameter of the broadcast event + */ + public function setParameter($value) + { + $this->_param=$value; + } +} + /** * TCommandEventParameter class * - * TCommandEventParameter encapsulates the parameter data for OnCommand + * TCommandEventParameter encapsulates the parameter data for Command * event of button controls. You can access the name of the command via * Name property, and the parameter carried with the command via * Parameter property. -- cgit v1.2.3