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

Source for file Menu.php

Documentation is available at Menu.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 Ext JS: http://extjs.com
  11.  * 
  12.  */
  13.  
  14. /**
  15.  * @see PhpExt_Observable
  16.  */
  17. include_once 'PhpExt/Observable.php';
  18. /**
  19.  * @see PhpExt_Menu_BaseItemCollection
  20.  */
  21. include_once 'PhpExt/Menu/BaseItemCollection.php';
  22.  
  23.  
  24. /**
  25.  * A menu object. This is the container to which you add all other menu items. Menu can also serve a as a base class when you want a specialzed menu based off of another component (like {@link PhpExt_Menu_DateMenu for example}).
  26.  *  
  27.  * @package PhpExt
  28.  * @subpackage Menu
  29.  */
  30. class PhpExt_Menu_Menu extends PhpExt_Observable 
  31. {
  32.     // AllowOtherMenus
  33.     /**
  34.      * True to allow multiple menus to be displayed at the same time (defaults to false)
  35.      * @param boolean $value 
  36.      * @return PhpExt_Menu_Menu 
  37.      */
  38.     public function setAllowOtherMenus($value) {
  39.         $this->setExtConfigProperty("allowOtherMenus", $value);
  40.         return $this;
  41.     }    
  42.     /**
  43.      * True to allow multiple menus to be displayed at the same time (defaults to false)
  44.      * @return boolean 
  45.      */
  46.     public function getAllowOtherMenus() {
  47.         return $this->getExtConfigProperty("allowOtherMenus");
  48.     }
  49.     
  50.     // DefaultAlign
  51.     /**
  52.      * The default {@link PhpExt_Ext::combineAnchors()} anchor position value for this menu relative to its element of origin (defaults to "tl-bl?")
  53.      * @param boolean $value 
  54.      * @return PhpExt_Menu_Menu 
  55.      */
  56.     public function setDefaultAlign($value) {
  57.         $this->setExtConfigProperty("defaultAlign", $value);
  58.         return $this;
  59.     }    
  60.     /**
  61.      * The default {@link PhpExt_Ext::combineAnchors()} anchor position value for this menu relative to its element of origin (defaults to "tl-bl?")
  62.      * @return boolean 
  63.      */
  64.     public function getDefaultAlign() {
  65.         return $this->getExtConfigProperty("defaultAlign");
  66.     }
  67.     
  68.     // Defaults
  69.     /**
  70.      * A config object that will be applied to all items added to this container either via the items config or via the add method. The defaults config can contain any number of name/value property pairs to be added to each item, and should be valid for the types of items being added to the menu.
  71.      * @param PhpExt_Config_ConfigObject $value 
  72.      * @return PhpExt_Menu_Menu 
  73.      */
  74.     public function setDefaults($value) {
  75.         $this->setExtConfigProperty("defaults", $value);
  76.         return $this;
  77.     }    
  78.     /**
  79.      * A config object that will be applied to all items added to this container either via the items config or via the add method. The defaults config can contain any number of name/value property pairs to be added to each item, and should be valid for the types of items being added to the menu.
  80.      * @return PhpExt_Config_ConfigObject 
  81.      */
  82.     public function getDefaults() {
  83.         return $this->getExtConfigProperty("defaults");
  84.     }
  85.     
  86.     // Items
  87.     /**
  88.      * @var PhpExt_Menu_BaseItemCollection 
  89.      */
  90.     protected $_items;
  91.     /**
  92.      * An array of items to be added to this menu. See add for a list of valid item types.
  93.      * @return PhpExt_Menu_BaseItemCollection 
  94.      */
  95.     public function getItems() {
  96.         return $this->getExtConfigProperty("items");
  97.     }
  98.     /**
  99.      * Helper function to quick add a separator
  100.      * @return PhpExt_Menu_Menu 
  101.      */
  102.     public function addSeparator($key) {
  103.         $this->_items->add(PhpExt_Menu_Separator(), $key);
  104.         return $this;
  105.     }
  106.     /**
  107.      * Helper function to quick add a checkitem
  108.      * @return PhpExt_Menu_Menu 
  109.      */
  110.     public function addCheckItem($key, $text, $handler = null) {
  111.         $this->_items->add(new PhpExt_Menu_MenuCheckItem($text, $handler), $key);
  112.         return $this;
  113.     }        
  114.     /**
  115.      * Helper function to quick add a textitem
  116.      * @return PhpExt_Menu_Menu 
  117.      */
  118.     public function addTextItem($key, $text, $handler = null) {
  119.         $this->_items->add(new PhpExt_Menu_MenuTextItem($text, $handler), $key);
  120.         return $this;
  121.     }
  122.     /**
  123.      * Helper function to quick add an item
  124.      * @return PhpExt_Menu_Menu 
  125.      */
  126.     public function addItem($key, PhpExt_Menu_BaseItem $item) {
  127.         $this->_items->add($item, $key);
  128.         return $this;
  129.     }
  130.     
  131.     
  132.     // MinWidth
  133.     /**
  134.      * The minimum width of the menu in pixels (defaults to 120)
  135.      * @param integer $value 
  136.      * @return PhpExt_Menu_Menu 
  137.      */
  138.     public function setMinWidth($value) {
  139.         $this->setExtConfigProperty("minWidth", $value);
  140.         return $this;
  141.     }    
  142.     /**
  143.      * The minimum width of the menu in pixels (defaults to 120)
  144.      * @return integer 
  145.      */
  146.     public function getMinWidth() {
  147.         return $this->getExtConfigProperty("minWidth");
  148.     }
  149.     
  150.     // Shadow
  151.     /**
  152.      * True or {@link PhpExt_Shadow::$MODE_SIDES} for the default effect, {@link PhpExt_Shadow::MODE_FRAME} for 4-way shadow, and {@link PhpExt_Shadow::MODE_DROP} for bottom-right shadow (defaults to {@link PhpExt_Shadow::MODE_SIDES})
  153.      * @uses PhpExt_Shadow::$MODE_SIDES
  154.      * @uses PhpExt_Shadow::$MODE_FRAME
  155.      * @uses PhpExt_Shadow::$MODE_DROP
  156.      * @param string $value 
  157.      * @return PhpExt_Menu_Menu 
  158.      */
  159.     public function setShadow($value) {
  160.         $this->setExtConfigProperty("shadow", $value);
  161.         return $this;
  162.     }    
  163.     /**
  164.      * True or {@link PhpExt_Shadow::$MODE_SIDES} for the default effect, {@link PhpExt_Shadow::MODE_FRAME} for 4-way shadow, and {@link PhpExt_Shadow::MODE_DROP} for bottom-right shadow (defaults to {@link PhpExt_Shadow::MODE_SIDES})
  165.      * @uses PhpExt_Shadow::$MODE_SIDES
  166.      * @uses PhpExt_Shadow::$MODE_FRAME
  167.      * @uses PhpExt_Shadow::$MODE_DROP
  168.      * @return string 
  169.      */
  170.     public function getShadow() {
  171.         return $this->getExtConfigProperty("shadow");
  172.     }
  173.     
  174.     // SubMenuAlign
  175.     /**
  176.      * The {@link PhpExt_Ext::combineAnchors()} anchor position value to use for submenus of this menu (defaults to "tl-tr?")
  177.      * @param string $value 
  178.      * @return PhpExt_Menu_Menu 
  179.      */
  180.     public function setSubMenuAlign($value) {
  181.         $this->setExtConfigProperty("subMenuAlign", $value);
  182.         return $this;
  183.     }    
  184.     /**
  185.      * The {@link PhpExt_Ext::combineAnchors()} anchor position value to use for submenus of this menu (defaults to "tl-tr?")
  186.      * @return string 
  187.      */
  188.     public function getSubMenuAlign() {
  189.         return $this->getExtConfigProperty("subMenuAlign");
  190.     }
  191.     
  192.     public $AllowOtherMenus = false;
  193.     public $DefaultAlign = null; //"tl-bl";
  194.     public $Defaults = null;        
  195.     public $Items = array();
  196.     public $MinWidth = null;
  197.     public $Shadow = null;
  198.     public $SubMenuAlign = null;
  199.     
  200.         
  201.     public function __construct() {
  202.         parent::__construct();
  203.         $this->setExtClassInfo("Ext.menu.Menu");
  204.         
  205.         $validProps = array(
  206.             "activeClass",
  207.             "canActivate",
  208.             "handler",
  209.             "hideDelay",
  210.             "hideOnClick",
  211.             "scope",
  212.             "items"            
  213.         );
  214.         $this->addValidConfigProperties($validProps);
  215.         
  216.         $this->_items = new PhpExt_Menu_BaseItemCollection();
  217.         $this->setExtConfigProperty('items', $this->_items);
  218.     
  219.     }
  220.         
  221.          
  222. }
Documentation generated on Fri, 08 Aug 2008 15:56:41 -0500 by phpDocumentor 1.4.0