Source for file Blank.class.php

Documentation is available at Blank.class.php

  1. <?php
  2.  
  3. require_once(HARMONI."GUIManager/Component.class.php");
  4.  
  5. /**
  6. * This is a simple implementation of a Blank component. Blank components do not
  7. * have any content and naturally have their type set to <code>BLANK</code>.
  8. * <br /><br />
  9. * <code>Components</code> are the basic units that can be displayed on
  10. * the screen. The main method <code>render()</code> which renders the component
  11. * on the screen.
  12. *
  13. * @package harmoni.gui.components
  14. *
  15. * @copyright Copyright &copy; 2005, Middlebury College
  16. * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
  17. *
  18. * @version $Id: Blank.class.php,v 1.5 2005/02/07 21:38:14 adamfranco Exp $
  19. */
  20. class Blank extends Component {
  21.  
  22. /**
  23. * The constructor.
  24. * @access public
  25. * @param integer index The index of this component. The index has no semantic meaning:
  26. * you can think of the index as 'level' of the component. Alternatively,
  27. * the index could serve as means of distinguishing between components with
  28. * the same type. Most often one would use the index in conjunction with
  29. * the <code>getStylesForComponentType()</code> and
  30. * <code>addStyleForComponentType()</code> methods.
  31. * @param optional object StyleCollections styles,... Zero, one, or more StyleCollection
  32. * objects that will be added to the newly created Component. Warning, this will
  33. * result in copying the objects instead of referencing them as using
  34. * <code>addStyle()</code> would do.
  35. ***/
  36. function Blank($index) {
  37. $this->Component(null, BLANK, $index);
  38. // if there are style collections to add
  39. if (func_num_args() > 1)
  40. for ($i = 1; $i < func_num_args(); $i++)
  41. $this->addStyle(func_get_arg($i));
  42. }
  43.  
  44. }
  45.  
  46. ?>

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