/* Row.java
 * =========================================================================
 * This file is originally part of the JMathTeX Library - http://jmathtex.sourceforge.net
 * 
 * Copyright (C) 2004-2007 Universiteit Gent
 * Copyright (C) 2009 DENIZET Calixte
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at
 * your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 * 
 * A copy of the GNU General Public License can be found in the file
 * LICENSE.txt provided with the source distribution of this program (see
 * the META-INF directory in the source jar). This license can also be
 * found on the GNU website at http://www.gnu.org/licenses/gpl.html.
 * 
 * If you did not receive a copy of the GNU General Public License along
 * with this program, contact the lead developer, or write to the Free
 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 * 
 */

package org.scilab.forge.jlatexmath;

/**
 * A "composed atom": an atom that consists of child atoms that will be displayed 
 * next to each other horizontally with glue between them.
 */
public interface Row {

    /**
     * Sets the given dummy containing the atom that comes just before
     * the first child atom of this "composed atom". This method will allways be called
     * by another composed atom, so this composed atom will be a child of it (nested). 
     * This is necessary to determine the glue to insert between the first child atom 
     * of this nested composed atom and the atom that the dummy contains. 
     * 
     * @param dummy the dummy that comes just before this "composed atom"
     */
    public void setPreviousAtom(Dummy dummy);
}