Package org.apache.poi.ooxml.util

Class POIXMLUnits

  • public class POIXMLUnits
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      POIXMLUnits()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static long parseLength​(STCoordinate coordUnion)
      The standard states that ST_Coordinate is read and written as either a length followed by a unit, or EMUs with no unit present.
      static long parseLength​(STCoordinate32 coordUnion)
      The standard states that ST_Coordinate32 is read and written as either a length followed by a unit, or EMUs with no unit present.
      static long parseLength​(STTextPoint coordUnion)
      The standard states that ST_TextPoint is read and written as a length followed by a unit or as hundredths of a point with no unit present.
      static long parseLength​(org.openxmlformats.schemas.officeDocument.x2006.sharedTypes.STTwipsMeasure coordUnion)
      If no unit is specified, a twips-measure is a twentieth of a point
      static long parseLength​(STHpsMeasure coordUnion)
      If no unit is specified, a hps-measure is a half of a point
      static long parseLength​(STMeasurementOrPercent coordUnion)
      If no unit is specified, DXA (twentieth of a point) is assumed
      static long parseLength​(STSignedHpsMeasure coordUnion)
      If no unit is specified, a hps-measure is a half of a point
      static long parseLength​(STSignedTwipsMeasure coordUnion)
      If no unit is specified, a twips-measure is a twentieth of a point
      static boolean parseOnOff​(org.openxmlformats.schemas.officeDocument.x2006.sharedTypes.STOnOff onOff)  
      static boolean parseOnOff​(CTOnOff onOff)  
      static int parsePercent​(STDepthPercent pctUnion)  
      static int parsePercent​(STGapAmount pctUnion)  
      static int parsePercent​(STHoleSize pctUnion)  
      static int parsePercent​(STHPercent pctUnion)  
      static int parsePercent​(STOverlap pctUnion)  
      static int parsePercent​(STPercentage pctUnion)
      Office will read percentages formatted with a trailing percent sign or formatted as 1000th of a percent without a trailing percent sign
      static int parsePercent​(STPositiveFixedPercentage pctUnion)
      Office will read percentages formatted with a trailing percent sign or formatted as 1000th of a percent without a trailing percent sign
      static int parsePercent​(STPositivePercentage pctUnion)
      Office will read percentages formatted with a trailing percent sign or formatted as 1000th of a percent without a trailing percent sign
      static int parsePercent​(STTextBulletSizePercent pctUnion)
      Specifies the percentage of the text size that this bullet should be.
      static int parsePercent​(STTextFontScalePercentOrPercentString pctUnion)
      Office will read percentages formatted with a trailing percent sign or formatted as 1000th of a percent without a trailing percent sign
      static int parsePercent​(STTextSpacingPercentOrPercentString pctUnion)
      Office will read percentages formatted with a trailing percent sign or formatted as 1000th of a percent without a trailing percent sign
      static int parsePercent​(STDecimalNumberOrPercent pctUnion)
      This type seems to be interpreted as percent value when the trailing percent sign is missing.
      static int parsePercent​(STTextScale pctUnion)
      This type seems to be interpreted as percent value when the trailing percent sign is missing.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • POIXMLUnits

        public POIXMLUnits()

    • Method Detail

      • parsePercent

        public static int parsePercent​(STPositivePercentage pctUnion)
        Office will read percentages formatted with a trailing percent sign or formatted as 1000th of a percent without a trailing percent sign
        Returns:
        the percent scaled by 1000, so 100% = 100000

      • parsePercent

        public static int parsePercent​(STPositiveFixedPercentage pctUnion)
        Office will read percentages formatted with a trailing percent sign or formatted as 1000th of a percent without a trailing percent sign
        Returns:
        the percent scaled by 1000, so 100% = 100000

      • parsePercent

        public static int parsePercent​(STPercentage pctUnion)
        Office will read percentages formatted with a trailing percent sign or formatted as 1000th of a percent without a trailing percent sign
        Returns:
        the percent scaled by 1000, so 100% = 100000

      • parsePercent

        public static int parsePercent​(STTextBulletSizePercent pctUnion)
        Specifies the percentage of the text size that this bullet should be. It is specified here in terms of 100% being equal to 100000 and 1% being specified in increments of 1000. This attribute should not be lower than 25%, or 25000, and not be higher than 400%, or 400000.
        Returns:
        the percent scaled by 1000, so 100% = 100000

      • parsePercent

        public static int parsePercent​(STTextSpacingPercentOrPercentString pctUnion)
        Office will read percentages formatted with a trailing percent sign or formatted as 1000th of a percent without a trailing percent sign
        Returns:
        the percent scaled by 1000, so 100% = 100000

      • parsePercent

        public static int parsePercent​(STTextFontScalePercentOrPercentString pctUnion)
        Office will read percentages formatted with a trailing percent sign or formatted as 1000th of a percent without a trailing percent sign
        Returns:
        the percent scaled by 1000, so 100% = 100000

      • parsePercent

        public static int parsePercent​(STDecimalNumberOrPercent pctUnion)
        This type seems to be interpreted as percent value when the trailing percent sign is missing.

        sample snippet from settings.xml 

        
    <w:zoom w:percent="50" />
        Returns:
        the percent scaled by 1000, so 100% = 100000

      • parsePercent

        public static int parsePercent​(STTextScale pctUnion)
        This type seems to be interpreted as percent value when the trailing percent sign is missing.

        sample snippet from settings.xml 

        
    <w:textscale w:w="50" />
        Returns:
        the percent scaled by 1000, so 100% = 100000

      • parsePercent

        public static int parsePercent​(STGapAmount pctUnion)

      • parsePercent

        public static int parsePercent​(STOverlap pctUnion)

      • parsePercent

        public static int parsePercent​(STDepthPercent pctUnion)

      • parsePercent

        public static int parsePercent​(STHPercent pctUnion)

      • parsePercent

        public static int parsePercent​(STHoleSize pctUnion)

      • parseLength

        public static long parseLength​(STCoordinate32 coordUnion)
        The standard states that ST_Coordinate32 is read and written as either a length followed by a unit, or EMUs with no unit present.
        Returns:
        length in EMUs

      • parseLength

        public static long parseLength​(STCoordinate coordUnion)
        The standard states that ST_Coordinate is read and written as either a length followed by a unit, or EMUs with no unit present.
        Returns:
        length in EMUs

      • parseLength

        public static long parseLength​(STTextPoint coordUnion)
        The standard states that ST_TextPoint is read and written as a length followed by a unit or as hundredths of a point with no unit present.
        Returns:
        length in EMUs

      • parseLength

        public static long parseLength​(org.openxmlformats.schemas.officeDocument.x2006.sharedTypes.STTwipsMeasure coordUnion)
        If no unit is specified, a twips-measure is a twentieth of a point
        Returns:
        length in EMUs

      • parseLength

        public static long parseLength​(STSignedTwipsMeasure coordUnion)
        If no unit is specified, a twips-measure is a twentieth of a point
        Returns:
        length in EMUs

      • parseLength

        public static long parseLength​(STHpsMeasure coordUnion)
        If no unit is specified, a hps-measure is a half of a point
        Returns:
        length in EMUs

      • parseLength

        public static long parseLength​(STSignedHpsMeasure coordUnion)
        If no unit is specified, a hps-measure is a half of a point
        Returns:
        length in EMUs

      • parseLength

        public static long parseLength​(STMeasurementOrPercent coordUnion)
        If no unit is specified, DXA (twentieth of a point) is assumed
        Returns:
        length in EMUs

      • parseOnOff

        public static boolean parseOnOff​(CTOnOff onOff)

      • parseOnOff

        public static boolean parseOnOff​(org.openxmlformats.schemas.officeDocument.x2006.sharedTypes.STOnOff onOff)