Source for file Layout.interface.php

<?php
 
/**
 * Layouts are assigned to Containers and they specify how (in terms of location,
 * not appearance) the sub-<code>Components</code> are going to be rendered on the screen.
 *
 * @package harmoni.gui
 * 
 * @copyright Copyright &copy; 2005, Middlebury College
 * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
 *
 * @version $Id: Layout.interface.php,v 1.5 2007/09/04 20:25:21 adamfranco Exp $
 */
class LayoutInterface {
 
    /**
     * Lays out and renders the given container and its components. The Layout
     * object should arrange the <code>Components</code> in a well-defined manner
     * and then call the <code>render()</code> methods of each individual component.
     * @access public
     * @param ref object The container to render.
     * @param ref object theme The Theme object to use in producing the result
     *  of this method.
     * @param string tabs This is a string (normally a bunch of tabs) that will be
     *  prepended to each text line. This argument is optional but its usage is highly
     *  recommended in order to produce a nicely formatted HTML output.
     ***/
    function render($container, $theme, $tabs = "") {
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
    }
    
    /**
     * Returns any CSS code that might be needed in order for this <code>Layout</code>
     * to render properly.
     * @access public
     * @param string tabs This is a string (normally a bunch of tabs) that will be
     *  prepended to each text line. This argument is optional but its usage is highly
     *  recommended in order to produce a nicely formatted HTML output.
     * @return string The CSS code that might be needed in order for this <code>Layout</code>
     *  to render properly.
     ***/
    function getCSS($tabs = "") {
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
    }
    
}
 
?>