Source for file StyleProperty.interface.php

<?php
 
/**
 * A StyleProperty (SP) is one of the tree building pieces of CSS styles. It stores
 * information about a single CSS style property by storing one or more
 * <code>StyleComponents</code>.
 * 
 * The other two CSS styles building pieces are <code>StyleComponents</code> and
 * <code>StyleCollections</code>. To clarify the relationship between these three
 * building pieces, consider the following example:
 * <pre>
 * div {
 *     margin: 20px;
 *     border: 1px solid #000;
 * }
 * </pre>
 * <code>div</code> is a <code>StyleCollection</code> consisting of 2
 * <code>StyleProperties</code>: <code>margin</code> and <code>border</code>. Each
 * of the latter consists of one or more <code>StyleComponents</code>. In
 * specific, <code>margin</code> consists of one <code>StyleComponent</code>
 * with the value <code>20px</code>, and <code>border</code> has three
 * <code>StyleComponents</code> with values <code>1px</code>, <code>solid</code>,
 * and <code>#000</code> correspondingly.
 *
 * @package harmoni.gui
 * 
 * @copyright Copyright &copy; 2005, Middlebury College
 * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
 *
 * @version $Id: StyleProperty.interface.php,v 1.6 2007/09/04 20:25:21 adamfranco Exp $
 ***/
 
class StylePropertyInterface {
 
    /**
     * Returns the CSS code for this StyleProperty.
     * @access public
     * @return string The CSS code for this StyleProperty.
     ***/
    function getCSS() {
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
    }
    
    /**
     * Returns the name of this StyleProperty.
     * @access public
     * @return string The name of this StyleProperty.
     ***/
    function getName() {
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
    }
    
    /**
     * Returns the display name of this StyleProperty.
     * @access public
     * @return string The display name of this StyleProperty.
     ***/
    function getDisplayName() {
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
    }
    
    /**
     * Returns the description of this StlyeProperty.
     * @access public
     * @return string The description of this StlyeProperty.
     ***/
    function getDescription() {
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
    }
    
    /**
     * Adds one StyleComponent to this StyleProperty.
     * @access public
     * @param ref object A StyleComponent object.
     ***/
    function addSC($sc) {
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
    }
 
    /**
     * Returns the StyleComponents of this StyleProperty in a suitable
     * for CSS generation order.
     * @access public
     * @return array An array of the StyleComponents of this StyleProperty.
     ***/
    function getSCs() {
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
    }
    
    
}
 
?>