org.scilab.forge.jlatexmath.VCenteredAtom Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jlatexmath Show documentation

A Java API to render LaTeX

There is a newer version: 1.0.7

/* VCenteredAtom.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;

/**
 * An atom representing another atom vertically centered with respect to the axis 
 * (determined by a general TeXFont parameter)
 */
public class VCenteredAtom extends Atom {

   // atom to be centered vertically with respect to the axis
   private final Atom atom;

   public VCenteredAtom(Atom atom) {
      this.atom = atom;
   }

   public Box createBox(TeXEnvironment env) {
      Box b = atom.createBox(env);

      float total = b.getHeight() + b.getDepth(), axis = env.getTeXFont()
            .getAxisHeight(env.getStyle());

      // center on axis
      b.setShift(-(total / 2) - axis);
      
      // put in horizontal box, so shifting will be vertically!
      return new HorizontalBox(b);
   }
}