summaryrefslogtreecommitdiff
path: root/framework/Web/UI/ActiveControls/TActivePager.php
diff options
context:
space:
mode:
authortof <>2008-02-07 10:32:04 +0000
committertof <>2008-02-07 10:32:04 +0000
commit5e8932fb41534dc0d06e76dae7b74cf47071f6e0 (patch)
treee6d5c558783d9427aabfeb0c22d23a41d80767a1 /framework/Web/UI/ActiveControls/TActivePager.php
parent2c48bf162f2a8e7cf13e8c53b1205cc0f65132e5 (diff)
Added TActivePager
Diffstat (limited to 'framework/Web/UI/ActiveControls/TActivePager.php')
-rw-r--r--framework/Web/UI/ActiveControls/TActivePager.php204
1 files changed, 204 insertions, 0 deletions
diff --git a/framework/Web/UI/ActiveControls/TActivePager.php b/framework/Web/UI/ActiveControls/TActivePager.php
new file mode 100644
index 00000000..b23948e0
--- /dev/null
+++ b/framework/Web/UI/ActiveControls/TActivePager.php
@@ -0,0 +1,204 @@
+<?php
+/**
+ * TActivePager class file.
+ *
+ * @author "gevik" (forum contributor) and Christophe Boulain (Christophe.Boulain@gmail.com)
+ * @link http://www.pradosoft.com/
+ * @copyright Copyright &copy; 2008 PradoSoft
+ * @license http://www.pradosoft.com/license/
+ * @version $Id$
+ * @package System.Web.UI.ActiveControls
+ */
+
+/**
+ * Load active control adapter.
+ */
+Prado::using('System.Web.UI.ActiveControls.TActiveControlAdapter');
+
+/**
+ * TActivePager is the active control counter part of TPager.
+ *
+ * When a page change is requested, TActivePager raises a callback instead of the
+ * traditional postback.
+ *
+ * The {@link onCallback OnCallback} event is raised during a callback request
+ * and it is raise <b>after</b> the {@link onPageIndexChanged OnPageIndexChanged} event.
+ *
+ * @author "gevik" (forum contributor) and Christophe Boulain (Christophe.Boulain@gmail.com)
+ * @version $Id$
+ * @package System.Web.UI.ActiveControls
+ * @since 3.1.2
+ */
+class TActivePager extends TPager implements IActiveControl, ICallbackEventHandler
+{
+ /**
+ * Creates a new callback control, sets the adapter to
+ * TActiveControlAdapter. If you override this class, be sure to set the
+ * adapter appropriately by, for example, by calling this constructor.
+ */
+ public function __construct()
+ {
+ parent::__construct();
+ $this->setAdapter(new TActiveControlAdapter($this));
+ }
+
+ /**
+ * @return TBaseActiveControl standard active control options.
+ */
+ public function getActiveControl()
+ {
+ return $this->getAdapter()->getBaseActiveControl();
+ }
+
+
+ /**
+ * @return TCallbackClientSide client side request options.
+ */
+ public function getClientSide()
+ {
+ return $this->getAdapter()->getBaseActiveControl()->getClientSide();
+ }
+
+ /**
+ * Raises the callback event. This method is required by {@link
+ * ICallbackEventHandler} interface.
+ * This method is mainly used by framework and control developers.
+ * @param TCallbackEventParameter the event parameter
+ */
+
+ public function raiseCallbackEvent($param)
+ {
+ $this->onCallback($param);
+ }
+
+ /**
+ * This method is invoked when a callback is requested. The method raises
+ * 'OnCallback' event to fire up the event handlers. If you override this
+ * method, be sure to call the parent implementation so that the event
+ * handler can be invoked.
+ * @param TCallbackEventParameter event parameter to be passed to the event handlers
+ */
+
+ public function onCallback($param)
+ {
+ $this->raiseEvent('OnCallback', $this, $param);
+ }
+
+ /**
+ * Builds a dropdown list pager
+ * Override parent implementation to build Active dropdown lists.
+ */
+ protected function buildListPager()
+ {
+ $list=new TActiveDropDownList;
+
+ $list->getAdapter()->getBaseActiveControl()->setClientSide(
+ $this->getClientSide()
+ );
+
+ $this->getControls()->add($list);
+ $list->setDataSource(range(1,$this->getPageCount()));
+ $list->dataBind();
+ $list->setSelectedIndex($this->getCurrentPageIndex());
+ $list->setAutoPostBack(true);
+ $list->attachEventHandler('OnSelectedIndexChanged',array($this,'listIndexChanged'));
+ $list->attachEventHandler('OnCallback', array($this, 'handleCallback'));
+ }
+
+ /**
+ * Creates a pager button.
+ * Override parent implementation to create, depending on the button type, a TActiveLinkButton,
+ * a TActiveButton or a TActiveImageButton may be created.
+ *
+ * @param string button type, either LinkButton or PushButton
+ * @param boolean whether the button should be enabled
+ * @param string caption of the button
+ * @param string CommandName corresponding to the OnCommand event of the button
+ * @param string CommandParameter corresponding to the OnCommand event of the button
+ * @return mixed the button instance
+ */
+ protected function createPagerButton($buttonType,$enabled,$text,$commandName,$commandParameter)
+ {
+ if($buttonType===TPagerButtonType::LinkButton)
+ {
+ if($enabled)
+ $button=new TActiveLinkButton;
+ else
+ {
+ $button=new TLabel;
+ $button->setText($text);
+ return $button;
+ }
+ }
+ else if($buttonType===TPagerButtonType::ImageButton)
+ {
+ $button = new TActiveImageButton;
+ $button->setImageUrl($this->getPageImageUrl($text,$commandName));
+ if($enabled)
+ $button->Visible = true;
+ else
+ $button->Visible = false;
+ }
+ else
+ {
+ $button=new TActiveButton;
+ if(!$enabled)
+ $button->setEnabled(false);
+ }
+
+ if($buttonType===TPagerButtonType::ImageButton)
+ {
+ $button->ImageUrl = $text;
+ }
+
+ $button->setText($text);
+ $button->setCommandName($commandName);
+ $button->setCommandParameter($commandParameter);
+ $button->setCausesValidation(false);
+
+ $button->attachEventHandler('OnCallback', array($this, 'handleCallback'));
+ $button->getAdapter()->getBaseActiveControl()->setClientSide(
+ $this->getClientSide()
+ );
+
+ return $button;
+ }
+
+ /**
+ * Event handler to the OnCallback active buttons or active dropdownlist.
+ * This handler will raise the {@link onCallback OnCallback} event
+ *
+ * @param mixed $sender
+ * @param TCallbackEventParameter $param
+ */
+ public function handleCallback ($sender,$param)
+ {
+ // Update all the buttons pagers attached to the same control.
+ // Dropdown pagers doesn't need to be re-rendered.
+ $controlToPaginate=$this->getControlToPaginate();
+ foreach ($this->getNamingContainer()->findControlsByType('TActivePager') as $control)
+ {
+ if ($control->getMode() !== TPagerMode::DropDownList && $control->getControlToPaginate()===$controlToPaginate)
+ $control->render($param->getNewWriter());
+ }
+
+ // Raise callback event
+ $this->onCallback($param);
+ }
+
+ public function render ($writer)
+ {
+ if($this->getHasPreRendered())
+ {
+ parent::render($writer);
+ if($this->getActiveControl()->canUpdateClientSide())
+ $this->getPage()->getCallbackClient()->replaceContent($this,$writer);
+ }
+ else
+ {
+ $this->getPage()->getAdapter()->registerControlToRender($this,$writer);
+ }
+ }
+}
+
+?> \ No newline at end of file