Package org.apache.fontbox.afm

Class FontMetric

  • public class FontMetric
extends java.lang.Object
    This is the outermost AFM type. This can be created by the afmparser with a valid AFM document.
    Version:
    $Revision: 1.3 $
    Author:
    Ben Litchfield (ben@benlitchfield.com)

    • Constructor Detail

      • FontMetric

        public FontMetric()
        Constructor.

    • Method Detail

      • getCharacterWidth

        public float getCharacterWidth​(java.lang.String name)
                        throws java.io.IOException
        This will get the width of a character.
        Parameters:
        name - The character to get the width for.
        Returns:
        The width of the character.
        Throws:
        java.io.IOException - If this AFM file does not handle the character.

      • getCharacterHeight

        public float getCharacterHeight​(java.lang.String name)
                         throws java.io.IOException
        This will get the width of a character.
        Parameters:
        name - The character to get the width for.
        Returns:
        The width of the character.
        Throws:
        java.io.IOException - If this AFM file does not handle the character.

      • getAverageCharacterWidth

        public float getAverageCharacterWidth()
                               throws java.io.IOException
        This will get the average width of a character.
        Returns:
        The width of the character.
        Throws:
        java.io.IOException - If this AFM file does not handle the character.

      • addComment

        public void addComment​(java.lang.String comment)
        This will add a new comment.
        Parameters:
        comment - The comment to add to this metric.

      • getComments

        public java.util.List<java.lang.String> getComments()
        This will get all comments.
        Returns:
        The list of all comments.

      • getAFMVersion

        public float getAFMVersion()
        This will get the version of the AFM document.
        Returns:
        The version of the document.

      • getMetricSets

        public int getMetricSets()
        This will get the metricSets attribute.
        Returns:
        The value of the metric sets.

      • setAFMVersion

        public void setAFMVersion​(float afmVersionValue)
        This will set the version of the AFM document.
        Parameters:
        afmVersionValue - The version of the document.

      • setMetricSets

        public void setMetricSets​(int metricSetsValue)
        This will set the metricSets attribute. This value must be 0,1, or 2.
        Parameters:
        metricSetsValue - The new metric sets attribute.

      • getFontName

        public java.lang.String getFontName()
        Getter for property fontName.
        Returns:
        Value of property fontName.

      • setFontName

        public void setFontName​(java.lang.String name)
        Setter for property fontName.
        Parameters:
        name - New value of property fontName.

      • getFullName

        public java.lang.String getFullName()
        Getter for property fullName.
        Returns:
        Value of property fullName.

      • setFullName

        public void setFullName​(java.lang.String fullNameValue)
        Setter for property fullName.
        Parameters:
        fullNameValue - New value of property fullName.

      • getFamilyName

        public java.lang.String getFamilyName()
        Getter for property familyName.
        Returns:
        Value of property familyName.

      • setFamilyName

        public void setFamilyName​(java.lang.String familyNameValue)
        Setter for property familyName.
        Parameters:
        familyNameValue - New value of property familyName.

      • getWeight

        public java.lang.String getWeight()
        Getter for property weight.
        Returns:
        Value of property weight.

      • setWeight

        public void setWeight​(java.lang.String weightValue)
        Setter for property weight.
        Parameters:
        weightValue - New value of property weight.

      • getFontBBox

        public BoundingBox getFontBBox()
        Getter for property fontBBox.
        Returns:
        Value of property fontBBox.

      • setFontBBox

        public void setFontBBox​(BoundingBox bBox)
        Setter for property fontBBox.
        Parameters:
        bBox - New value of property fontBBox.

      • getNotice

        public java.lang.String getNotice()
        Getter for property notice.
        Returns:
        Value of property notice.

      • setNotice

        public void setNotice​(java.lang.String noticeValue)
        Setter for property notice.
        Parameters:
        noticeValue - New value of property notice.

      • getEncodingScheme

        public java.lang.String getEncodingScheme()
        Getter for property encodingScheme.
        Returns:
        Value of property encodingScheme.

      • setEncodingScheme

        public void setEncodingScheme​(java.lang.String encodingSchemeValue)
        Setter for property encodingScheme.
        Parameters:
        encodingSchemeValue - New value of property encodingScheme.

      • getMappingScheme

        public int getMappingScheme()
        Getter for property mappingScheme.
        Returns:
        Value of property mappingScheme.

      • setMappingScheme

        public void setMappingScheme​(int mappingSchemeValue)
        Setter for property mappingScheme.
        Parameters:
        mappingSchemeValue - New value of property mappingScheme.

      • getEscChar

        public int getEscChar()
        Getter for property escChar.
        Returns:
        Value of property escChar.

      • setEscChar

        public void setEscChar​(int escCharValue)
        Setter for property escChar.
        Parameters:
        escCharValue - New value of property escChar.

      • getCharacterSet

        public java.lang.String getCharacterSet()
        Getter for property characterSet.
        Returns:
        Value of property characterSet.

      • setCharacterSet

        public void setCharacterSet​(java.lang.String characterSetValue)
        Setter for property characterSet.
        Parameters:
        characterSetValue - New value of property characterSet.

      • getCharacters

        public int getCharacters()
        Getter for property characters.
        Returns:
        Value of property characters.

      • setCharacters

        public void setCharacters​(int charactersValue)
        Setter for property characters.
        Parameters:
        charactersValue - New value of property characters.

      • isBaseFont

        public boolean isBaseFont()
        Getter for property isBaseFont.
        Returns:
        Value of property isBaseFont.

      • setIsBaseFont

        public void setIsBaseFont​(boolean isBaseFontValue)
        Setter for property isBaseFont.
        Parameters:
        isBaseFontValue - New value of property isBaseFont.

      • getVVector

        public float[] getVVector()
        Getter for property vVector.
        Returns:
        Value of property vVector.

      • setVVector

        public void setVVector​(float[] vVectorValue)
        Setter for property vVector.
        Parameters:
        vVectorValue - New value of property vVector.

      • isFixedV

        public boolean isFixedV()
        Getter for property isFixedV.
        Returns:
        Value of property isFixedV.

      • setIsFixedV

        public void setIsFixedV​(boolean isFixedVValue)
        Setter for property isFixedV.
        Parameters:
        isFixedVValue - New value of property isFixedV.

      • getCapHeight

        public float getCapHeight()
        Getter for property capHeight.
        Returns:
        Value of property capHeight.

      • setCapHeight

        public void setCapHeight​(float capHeightValue)
        Setter for property capHeight.
        Parameters:
        capHeightValue - New value of property capHeight.

      • getXHeight

        public float getXHeight()
        Getter for property xHeight.
        Returns:
        Value of property xHeight.

      • setXHeight

        public void setXHeight​(float xHeightValue)
        Setter for property xHeight.
        Parameters:
        xHeightValue - New value of property xHeight.

      • getAscender

        public float getAscender()
        Getter for property ascender.
        Returns:
        Value of property ascender.

      • setAscender

        public void setAscender​(float ascenderValue)
        Setter for property ascender.
        Parameters:
        ascenderValue - New value of property ascender.

      • getDescender

        public float getDescender()
        Getter for property descender.
        Returns:
        Value of property descender.

      • setDescender

        public void setDescender​(float descenderValue)
        Setter for property descender.
        Parameters:
        descenderValue - New value of property descender.

      • getFontVersion

        public java.lang.String getFontVersion()
        Getter for property fontVersion.
        Returns:
        Value of property fontVersion.

      • setFontVersion

        public void setFontVersion​(java.lang.String fontVersionValue)
        Setter for property fontVersion.
        Parameters:
        fontVersionValue - New value of property fontVersion.

      • getUnderlinePosition

        public float getUnderlinePosition()
        Getter for property underlinePosition.
        Returns:
        Value of property underlinePosition.

      • setUnderlinePosition

        public void setUnderlinePosition​(float underlinePositionValue)
        Setter for property underlinePosition.
        Parameters:
        underlinePositionValue - New value of property underlinePosition.

      • getUnderlineThickness

        public float getUnderlineThickness()
        Getter for property underlineThickness.
        Returns:
        Value of property underlineThickness.

      • setUnderlineThickness

        public void setUnderlineThickness​(float underlineThicknessValue)
        Setter for property underlineThickness.
        Parameters:
        underlineThicknessValue - New value of property underlineThickness.

      • getItalicAngle

        public float getItalicAngle()
        Getter for property italicAngle.
        Returns:
        Value of property italicAngle.

      • setItalicAngle

        public void setItalicAngle​(float italicAngleValue)
        Setter for property italicAngle.
        Parameters:
        italicAngleValue - New value of property italicAngle.

      • getCharWidth

        public float[] getCharWidth()
        Getter for property charWidth.
        Returns:
        Value of property charWidth.

      • setCharWidth

        public void setCharWidth​(float[] charWidthValue)
        Setter for property charWidth.
        Parameters:
        charWidthValue - New value of property charWidth.

      • isFixedPitch

        public boolean isFixedPitch()
        Getter for property isFixedPitch.
        Returns:
        Value of property isFixedPitch.

      • setFixedPitch

        public void setFixedPitch​(boolean isFixedPitchValue)
        Setter for property isFixedPitch.
        Parameters:
        isFixedPitchValue - New value of property isFixedPitch.

      • getCharMetrics

        public java.util.List<CharMetric> getCharMetrics()
        Getter for property charMetrics.
        Returns:
        Value of property charMetrics.

      • setCharMetrics

        public void setCharMetrics​(java.util.List<CharMetric> charMetricsValue)
        Setter for property charMetrics.
        Parameters:
        charMetricsValue - New value of property charMetrics.

      • addCharMetric

        public void addCharMetric​(CharMetric metric)
        This will add another character metric.
        Parameters:
        metric - The character metric to add.

      • getTrackKern

        public java.util.List<TrackKern> getTrackKern()
        Getter for property trackKern.
        Returns:
        Value of property trackKern.

      • setTrackKern

        public void setTrackKern​(java.util.List<TrackKern> trackKernValue)
        Setter for property trackKern.
        Parameters:
        trackKernValue - New value of property trackKern.

      • addTrackKern

        public void addTrackKern​(TrackKern kern)
        This will add another track kern.
        Parameters:
        kern - The track kerning data.

      • getComposites

        public java.util.List<Composite> getComposites()
        Getter for property composites.
        Returns:
        Value of property composites.

      • setComposites

        public void setComposites​(java.util.List<Composite> compositesList)
        Setter for property composites.
        Parameters:
        compositesList - New value of property composites.

      • addComposite

        public void addComposite​(Composite composite)
        This will add a single composite part to the picture.
        Parameters:
        composite - The composite info to add.

      • getKernPairs

        public java.util.List<KernPair> getKernPairs()
        Getter for property kernPairs.
        Returns:
        Value of property kernPairs.

      • addKernPair

        public void addKernPair​(KernPair kernPair)
        This will add a kern pair.
        Parameters:
        kernPair - The kern pair to add.

      • setKernPairs

        public void setKernPairs​(java.util.List<KernPair> kernPairsList)
        Setter for property kernPairs.
        Parameters:
        kernPairsList - New value of property kernPairs.

      • getKernPairs0

        public java.util.List<KernPair> getKernPairs0()
        Getter for property kernPairs0.
        Returns:
        Value of property kernPairs0.

      • addKernPair0

        public void addKernPair0​(KernPair kernPair)
        This will add a kern pair.
        Parameters:
        kernPair - The kern pair to add.

      • setKernPairs0

        public void setKernPairs0​(java.util.List<KernPair> kernPairs0List)
        Setter for property kernPairs0.
        Parameters:
        kernPairs0List - New value of property kernPairs0.

      • getKernPairs1

        public java.util.List<KernPair> getKernPairs1()
        Getter for property kernPairs1.
        Returns:
        Value of property kernPairs1.

      • addKernPair1

        public void addKernPair1​(KernPair kernPair)
        This will add a kern pair.
        Parameters:
        kernPair - The kern pair to add.

      • setKernPairs1

        public void setKernPairs1​(java.util.List<KernPair> kernPairs1List)
        Setter for property kernPairs1.
        Parameters:
        kernPairs1List - New value of property kernPairs1.

      • getStandardHorizontalWidth

        public float getStandardHorizontalWidth()
        Getter for property standardHorizontalWidth.
        Returns:
        Value of property standardHorizontalWidth.

      • setStandardHorizontalWidth

        public void setStandardHorizontalWidth​(float standardHorizontalWidthValue)
        Setter for property standardHorizontalWidth.
        Parameters:
        standardHorizontalWidthValue - New value of property standardHorizontalWidth.

      • getStandardVerticalWidth

        public float getStandardVerticalWidth()
        Getter for property standardVerticalWidth.
        Returns:
        Value of property standardVerticalWidth.

      • setStandardVerticalWidth

        public void setStandardVerticalWidth​(float standardVerticalWidthValue)
        Setter for property standardVerticalWidth.
        Parameters:
        standardVerticalWidthValue - New value of property standardVerticalWidth.