PhpExt : Toolbar [ class tree ] [ index ] [ all elements ]
PhpExt
Packages:
PhpExt
PhpExtUx
Services_JSON

Source for file Toolbar.php

Documentation is available at Toolbar.php

  1. <?php
  2. /**
  3.  * PHP-Ext Library
  4.  * http://php-ext.googlecode.com
  5.  * @author Sergei Walter <sergeiw[at]gmail[dot]com>
  6.  * @copyright 2008 Sergei Walter
  7.  * @license http://www.gnu.org/licenses/lgpl.html
  8.  * @link http://php-ext.googlecode.com
  9.  * 
  10.  *  Reference for Ex JS: http://extjs.com
  11.  * 
  12.  */
  13.  
  14. /**
  15.  * @see PhpExt_BoxComponent
  16.  */
  17. include_once 'PhpExt/BoxComponent.php';
  18. /**
  19.  * @see PhpExt_Toolbar_IToolbarItemCollection
  20.  */
  21. include_once 'PhpExt/Toolbar/IToolbarItemCollection.php';
  22.  
  23.  
  24. /**
  25.  * Basic Toolbar class.
  26.  * @package PhpExt
  27.  * @subpackage Toolbar
  28.  */
  29. class PhpExt_Toolbar_Toolbar extends PhpExt_BoxComponent  
  30. {
  31.     /**
  32.      * Object Collection
  33.      *
  34.      * @var PhpExt_Toolbar_IToolbarItemCollection 
  35.      */
  36.     protected $_items = null;
  37.     // Items
  38.  
  39.     /**
  40.      * 
  41.      * @return PhpExt_Toolbar_IToolbarItemCollection 
  42.      */
  43.     public function getItems() {
  44.         return $this->getExtConfigProperty("items");
  45.     }
  46.     
  47.     
  48.         
  49.     public function __construct() {
  50.         parent::__construct();
  51.         $this->setExtClassInfo("Ext.Toolbar", "toolbar");
  52.     
  53.         $validProps = array(
  54.             "items"
  55.         );
  56.         $this->addValidConfigProperties($validProps);
  57.         
  58.         $this->_items = new PhpExt_Toolbar_IToolbarItemCollection();
  59.         $this->_items->setForceArray(true);
  60.         $this->setExtConfigProperty("items", $this->_items);
  61.     }
  62.     
  63.     /**
  64.      * Helper function to quick add a separator
  65.      *
  66.      * @param string $key 
  67.      * @return PhpExt_Toolbar_Toolbar 
  68.      */
  69.     public function addSeparator($key) {
  70.         include_once 'PhpExt/Toolbar/Separator.php';
  71.         $this->_items->add(new PhpExt_Toolbar_Separator(), $key);
  72.         return $this->_items->getByName($key);
  73.     }
  74.     
  75.     /**
  76.      * Helper function to quick add a spacer
  77.      *
  78.      * @param string $key 
  79.      * @return PhpExt_Toolbar_Spacer 
  80.      */
  81.     public function addSpacer($key) {
  82.         include_once 'PhpExt/Toolbar/Spacer.php';
  83.         $this->_items->add(new PhpExt_Toolbar_Spacer(), $key);
  84.         return $this->_items->getByName($key);
  85.     }
  86.     
  87.     /**
  88.      * Helper function to quick add a fill
  89.      *
  90.      * @param string $key 
  91.      * @return PhpExt_Toolbar_Fill 
  92.      */
  93.     public function addFill($key) {
  94.         include_once 'PhpExt/Toolbar/Fill.php';
  95.         $this->_items->add(new PhpExt_Toolbar_Fill(), $key);
  96.         return $this->_items->getByName($key);
  97.     }
  98.     
  99.     /**
  100.      * Helper function to quick add a textitem
  101.      *
  102.      * @param string $key 
  103.      * @param string $text The text to show in the item
  104.      * @return PhpExt_Toolbar_TextItem 
  105.      */
  106.     public function addTextItem($key, $text) {
  107.         include_once 'PhpExt/Toolbar/TextItem.php';
  108.         $this->_items->add(new PhpExt_Toolbar_TextItem($text), $key);;
  109.         return $this->_items->getByName($key);
  110.     }
  111.     
  112.     /**
  113.      * Helper function to quick add a button
  114.      *
  115.      * @param string $key 
  116.      * @param string $text The text to show in the button
  117.      * @param string $iconUrl The URL of and image to show as button's icon
  118.      * @return PhpExt_Toolbar_Button 
  119.      */
  120.     public function addButton($key, $text, $iconUrl = null, $handler = null) {
  121.         include_once 'PhpExt/Toolbar/Button.php';
  122.         $this->_items->add(PhpExt_Toolbar_Button::createButton($text, $iconUrl, $handler), $key);
  123.         return $this->_items->getByName($key);
  124.     }
  125.     
  126.     /**
  127.      * Helper function to quick add a item
  128.      *
  129.      * @param string $key 
  130.      * @param string $item 
  131.      * @return PhpExt_Toolbar_Item 
  132.      */
  133.     public function addItem($key, &$item) {
  134.         $this->_items->add($item, $key);
  135.         return $item;
  136.     }
  137.     
  138.     var $_mustRender = false;
  139.     /**
  140.      * True to render the toolbar even if it does not have items.
  141.      *
  142.      * @return boolean 
  143.      */
  144.     public function getMustRender() {
  145.         return $this->_mustRender;
  146.     }
  147.     
  148.     /**
  149.      * True to render the toolbar even if it does not have items
  150.      *
  151.      * @param boolean $mustRender 
  152.      */
  153.     public function setMustRender($mustRender) {
  154.         $this->_mustRender = $mustRender;
  155.     }
  156.     
  157.     
  158.     public function removeItem($key) {
  159.         $this->_items->removeObject($key);
  160.     }
  161.     
  162.     public function &getItem($key) {
  163.         return $this->_items->getByName($key);
  164.     }
  165.  
  166.     /*protected function getConfigParams($lazy = false) {
  167.         $params = parent::getConfigParams($lazy);
  168.         
  169.         // Items
  170.         if ($this->_items->getCount() > 0) {
  171.             $this->_items->ForceArray = true;
  172.             $params[] = $this->paramToString("items", $this->Items);            
  173.         }        
  174.                             
  175.         return $params;
  176.     }*/
  177.          
  178. }
Documentation generated on Fri, 08 Aug 2008 16:01:32 -0500 by phpDocumentor 1.4.0