net.sf.jett.model.VerticalAlignment Maven / Gradle / Ivy

package net.sf.jett.model;

/**
 * VerticalAlignments represent the built-in vertical alignment
 * names that correspond with Excel's vertical alignment scheme.  These are
 * used in conjunction with the vertical alignment property in the style tag.
 * Legal values are the names of the enumeration objects, without underscores,
 * case insensitive, e.g. "justify" == "Justify" == "JUSTIFY".
 *
 * @author Randy Gettman
 * @since 0.4.0
 * @see net.sf.jett.tag.StyleTag
 * @see net.sf.jett.parser.StyleParser#PROPERTY_VERTICAL_ALIGNMENT
 */
public enum VerticalAlignment
{
   BOTTOM     ((short) org.apache.poi.ss.usermodel.VerticalAlignment.BOTTOM.ordinal()),
   CENTER     ((short) org.apache.poi.ss.usermodel.VerticalAlignment.CENTER.ordinal()),
   DISTRIBUTED((short) org.apache.poi.ss.usermodel.VerticalAlignment.DISTRIBUTED.ordinal()),
   JUSTIFY    ((short) org.apache.poi.ss.usermodel.VerticalAlignment.JUSTIFY.ordinal()),
   TOP        ((short) org.apache.poi.ss.usermodel.VerticalAlignment.TOP.ordinal());

   private short myIndex;

   /**
    * Constructs a VerticalAlignment.
    * @param index The index.
    */
   VerticalAlignment(short index)
   {
      myIndex = index;
   }

   /**
    * Returns the index.
    * @return The index.
    */
   public short getIndex()
   {
      return myIndex;
   }

   /**
    * Returns the name, in all lowercase, no underscores or spaces.
    * @return The name, in all lowercase, no underscores or spaces.
    */
   public String toString()
   {
      return name().trim().toLowerCase().replace("_", "");
   }
}