Class Units

java.lang.Object
org.apache.poi.util.Units

public class Units extends Object
Author:
Yegor Kozlov
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final float
    Width of one "standard character" of the default font in pixels.
    static final int
     
    static final int
    Column widths are in fractional characters, this is the EMU equivalent.
    static final int
    In Escher absolute distances are specified in English Metric Units (EMUs), occasionally referred to as A units; there are 360000 EMUs per centimeter, 914400 EMUs per inch, 12700 EMUs per point.
    static final int
     
    static final int
    Master DPI (576 pixels per inch).
    static final int
    Pixels DPI (96 pixels per inch)
    static final int
    Points DPI (72 pixels per inch)
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    static int
    charactersToEMU(double characters)
     
    static int
    columnWidthToEMU(int columnWidth)
     
    static int
    doubleToFixedPoint(double floatPoint)
    Converts a value of type floating point to a FixedPoint
    static double
    fixedPointToDouble(int fixedPoint)
    Converts a value of type FixedPoint to a floating point
    static double
    masterToPoints(int masterDPI)
     
    static int
    pixelToEMU(int pixels)
    Converts pixels to EMUs
    static double
    pixelToPoints(int pixel)
     
    static int
    pointsToMaster(double points)
     
    static int
    pointsToPixel(double points)
     
    static int
    toEMU(double points)
    Converts points to EMUs
    static double
    toPoints(long emu)
    Converts EMUs to points
    static int
    TwipsToEMU(short twips)
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • EMU_PER_PIXEL

      public static final int EMU_PER_PIXEL
      In Escher absolute distances are specified in English Metric Units (EMUs), occasionally referred to as A units; there are 360000 EMUs per centimeter, 914400 EMUs per inch, 12700 EMUs per point.
      See Also:
    • EMU_PER_POINT

      public static final int EMU_PER_POINT
      See Also:
    • EMU_PER_CENTIMETER

      public static final int EMU_PER_CENTIMETER
      See Also:
    • MASTER_DPI

      public static final int MASTER_DPI
      Master DPI (576 pixels per inch). Used by the reference coordinate system in PowerPoint (HSLF)
      See Also:
    • PIXEL_DPI

      public static final int PIXEL_DPI
      Pixels DPI (96 pixels per inch)
      See Also:
    • POINT_DPI

      public static final int POINT_DPI
      Points DPI (72 pixels per inch)
      See Also:
    • DEFAULT_CHARACTER_WIDTH

      public static final float DEFAULT_CHARACTER_WIDTH
      Width of one "standard character" of the default font in pixels. Same for Calibri and Arial. "Standard character" defined as the widest digit character in the given font. Copied from XSSFWorkbook, since that isn't available here.

      Note this is only valid for workbooks using the default Excel font.

      Would be nice to eventually support arbitrary document default fonts.

      See Also:
    • EMU_PER_CHARACTER

      public static final int EMU_PER_CHARACTER
      Column widths are in fractional characters, this is the EMU equivalent. One character is defined as the widest value for the integers 0-9 in the default font.
      See Also:
  • Constructor Details

    • Units

      public Units()
  • Method Details

    • toEMU

      public static int toEMU(double points)
      Converts points to EMUs
      Parameters:
      points - points
      Returns:
      EMUs
    • pixelToEMU

      public static int pixelToEMU(int pixels)
      Converts pixels to EMUs
      Parameters:
      pixels - pixels
      Returns:
      EMUs
    • toPoints

      public static double toPoints(long emu)
      Converts EMUs to points
      Parameters:
      emu - emu
      Returns:
      points
    • fixedPointToDouble

      public static double fixedPointToDouble(int fixedPoint)
      Converts a value of type FixedPoint to a floating point
      Parameters:
      fixedPoint - value in fixed point notation
      Returns:
      floating point (double)
      See Also:
    • doubleToFixedPoint

      public static int doubleToFixedPoint(double floatPoint)
      Converts a value of type floating point to a FixedPoint
      Parameters:
      floatPoint - value in floating point notation
      Returns:
      fixedPoint value in fixed points notation
      See Also:
    • masterToPoints

      public static double masterToPoints(int masterDPI)
    • pointsToMaster

      public static int pointsToMaster(double points)
    • pointsToPixel

      public static int pointsToPixel(double points)
    • pixelToPoints

      public static double pixelToPoints(int pixel)
    • charactersToEMU

      public static int charactersToEMU(double characters)
    • columnWidthToEMU

      public static int columnWidthToEMU(int columnWidth)
      Parameters:
      columnWidth - specified in 256ths of a standard character
      Returns:
      equivalent EMUs
    • TwipsToEMU

      public static int TwipsToEMU(short twips)
      Parameters:
      twips - (1/20th of a point) typically used for row heights
      Returns:
      equivalent EMUs