Source for file MenuItem.interface.php

Documentation is available at MenuItem.interface.php

  1. <?php
  2.  
  3. require_once(HARMONI."GUIManager/Component.interface.php");
  4.  
  5. /**
  6. * <code>MenuItem</code> is an extension of <code>Component</code>; <code>MenuItems</code>
  7. * have display names and the ability to be added to <code>Menu</code> objects.
  8. *
  9. * @package harmoni.gui.components
  10. *
  11. * @copyright Copyright &copy; 2005, Middlebury College
  12. * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
  13. *
  14. * @version $Id: MenuItem.interface.php,v 1.3 2005/02/07 21:38:14 adamfranco Exp $
  15. */
  16. class MenuItemInterface extends ComponentInterface {
  17.  
  18. /**
  19. * Returns the display name of this menu item.
  20. * @access public
  21. * @return string The display name of this menu item.
  22. ***/
  23. function getDisplayName() {
  24. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  25. }
  26. /**
  27. * Sets the display name of this menu item.
  28. * @access public
  29. * @param string displayName The new display name.
  30. ***/
  31. function setDisplayName($displayName) {
  32. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  33. }
  34. }
  35.  
  36. ?>

Documentation generated on Wed, 19 Sep 2007 10:25:00 -0400 by phpDocumentor 1.3.0RC3