DynamicAtom.java

/* DynamicAtom.java
 * =========================================================================
 * This file is part of the JLaTeXMath Library - http://forge.scilab.org/jlatexmath
 * 
 * Copyright (C) 2010 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.
 *
 * Linking this library statically or dynamically with other modules 
 * is making a combined work based on this library. Thus, the terms 
 * and conditions of the GNU General Public License cover the whole 
 * combination.
 * 
 * As a special exception, the copyright holders of this library give you 
 * permission to link this library with independent modules to produce 
 * an executable, regardless of the license terms of these independent 
 * modules, and to copy and distribute the resulting executable under terms 
 * of your choice, provided that you also meet, for each linked independent 
 * module, the terms and conditions of the license of that module. 
 * An independent module is a module which is not derived from or based 
 * on this library. If you modify this library, you may extend this exception 
 * to your version of the library, but you are not obliged to do so. 
 * If you do not wish to do so, delete this exception statement from your 
 * version.
 * 
 */

package org.scilab.forge.jlatexmath.dynamic;

import org.scilab.forge.jlatexmath.Atom;
import org.scilab.forge.jlatexmath.Box;
import org.scilab.forge.jlatexmath.EmptyAtom;
import org.scilab.forge.jlatexmath.StrutBox;
import org.scilab.forge.jlatexmath.TeXEnvironment;
import org.scilab.forge.jlatexmath.TeXFormula;

/**
 * This kind of atom is used to have a dynamic content
 * which comes from an other soft such as ggb.
 * The goal is to avoid the reparsing (and the reatomization)
 * of the expression. 
 */
public class DynamicAtom extends Atom {
    
    private static ExternalConverterFactory ecFactory;
    private ExternalConverter converter;
    private TeXFormula formula = new TeXFormula();
    private String externalCode;
    private boolean insert;
    private boolean refreshed;

    public DynamicAtom(String externalCode, String option) {
	this.externalCode = externalCode;
	if (ecFactory != null) {
	    this.converter = ecFactory.getExternalConverter();
	}
	if (option != null && option.equals("i")) {
	    insert = true;
	}
    }

    public static boolean hasAnExternalConverterFactory() {
	return ecFactory != null;
    }

    public static void setExternalConverterFactory(ExternalConverterFactory factory) {
	ecFactory = factory;
    }

    public boolean getInsertMode() {
	return insert;
    }

    public Atom getAtom() {
	if (!refreshed) {
	    formula.setLaTeX(converter.getLaTeXString(externalCode));
	    refreshed = true;
	}
	
	if (formula.root == null) {
	    return new EmptyAtom();
	}

	return formula.root;
    }

    public Box createBox(TeXEnvironment env) {
	if (converter != null) {
	    if (refreshed) {
		refreshed = false;
	    } else {
		formula.setLaTeX(converter.getLaTeXString(externalCode));
	    }
	    if (formula.root != null) {
		return formula.root.createBox(env);
	    }
	}

	return new StrutBox(0, 0, 0, 0);
    }
}