com.aspose.words

Class MemoryFontSource

  • All Implemented Interfaces:
    com.aspose.words.internal.zzYVy, com.aspose.words.internal.zzYVy
    public class MemoryFontSource 
    extends FontSourceBase

Represents the single TrueType font file stored in memory.

Example:

Shows how to use a byte array with data from a font file as a font source.
byte[] fontBytes = DocumentHelper.getBytesFromStream(new FileInputStream(getMyDir() + "Alte DIN 1451 Mittelschrift.ttf"));
MemoryFontSource memoryFontSource = new MemoryFontSource(fontBytes, 0);

Document doc = new Document();
doc.setFontSettings(new FontSettings());
doc.getFontSettings().setFontsSources(new FontSourceBase[]{memoryFontSource});

Assert.assertEquals(FontSourceType.MEMORY_FONT, memoryFontSource.getType());
Assert.assertEquals(0, memoryFontSource.getPriority());

Constructor Summary
MemoryFontSource(byte[]fontData)
Ctor.
MemoryFontSource(byte[]fontData, intpriority)
Ctor.
MemoryFontSource(byte[]fontData, intpriority, java.lang.StringcacheKey)
Ctor.
 
Property Getters/Setters Summary
java.lang.StringgetCacheKey()
The key of this source in the cache.
byte[]getFontData()
Binary font data.
intgetPriority()
Returns the font source priority.
intgetType()
Returns the type of the font source. The value of the property is FontSourceType integer constant.
IWarningCallbackgetWarningCallback()
void
           Called during processing of font source when an issue is detected that might result in formatting fidelity loss.
 
Method Summary
java.util.ArrayList<PhysicalFontInfo>getAvailableFonts()
Returns list of fonts available via this source.
 

    • Constructor Detail

      • MemoryFontSource

        public MemoryFontSource(byte[] fontData)
        Ctor.
        Parameters:
        fontData - Binary font data.

        Example:

        Shows how to use a byte array with data from a font file as a font source.
        byte[] fontBytes = DocumentHelper.getBytesFromStream(new FileInputStream(getMyDir() + "Alte DIN 1451 Mittelschrift.ttf"));
        MemoryFontSource memoryFontSource = new MemoryFontSource(fontBytes, 0);
        
        Document doc = new Document();
        doc.setFontSettings(new FontSettings());
        doc.getFontSettings().setFontsSources(new FontSourceBase[]{memoryFontSource});
        
        Assert.assertEquals(FontSourceType.MEMORY_FONT, memoryFontSource.getType());
        Assert.assertEquals(0, memoryFontSource.getPriority());
      • MemoryFontSource

        public MemoryFontSource(byte[] fontData, int priority)
        Ctor.
        Parameters:
        fontData - Binary font data.
        priority - Font source priority. See the Priority property description for more information.

        Example:

        Shows how to use a byte array with data from a font file as a font source.
        byte[] fontBytes = DocumentHelper.getBytesFromStream(new FileInputStream(getMyDir() + "Alte DIN 1451 Mittelschrift.ttf"));
        MemoryFontSource memoryFontSource = new MemoryFontSource(fontBytes, 0);
        
        Document doc = new Document();
        doc.setFontSettings(new FontSettings());
        doc.getFontSettings().setFontsSources(new FontSourceBase[]{memoryFontSource});
        
        Assert.assertEquals(FontSourceType.MEMORY_FONT, memoryFontSource.getType());
        Assert.assertEquals(0, memoryFontSource.getPriority());
      • MemoryFontSource

        public MemoryFontSource(byte[] fontData, int priority, java.lang.String cacheKey)
        Ctor.
        Parameters:
        fontData - Binary font data.
        priority - Font source priority. See the Priority property description for more information.
        cacheKey - The key of this source in the cache. See CacheKey property description for more information.

        Example:

        Shows how to speed up the font cache initialization process.
        @Test
        public void loadFontSearchCache() throws Exception
        {
            final String CACHE_KEY_1 = "Arvo";
            final String CACHE_KEY_2 = "Arvo-Bold";
            FontSettings parsedFonts = new FontSettings();
            FontSettings loadedCache = new FontSettings();
        
            parsedFonts.setFontsSources(new FontSourceBase[]
                    {
                            new FileFontSource(getFontsDir() + "Arvo-Regular.ttf", 0, CACHE_KEY_1),
                            new FileFontSource(getFontsDir() + "Arvo-Bold.ttf", 0, CACHE_KEY_2)
                    });
        
            try (ByteArrayOutputStream cacheStream = new ByteArrayOutputStream())
            {
                parsedFonts.saveSearchCache(cacheStream);
                ByteArrayInputStream inputStream = new ByteArrayInputStream(cacheStream.toByteArray());
                loadedCache.setFontsSources(new FontSourceBase[]
                        {
                                new SearchCacheStream(CACHE_KEY_1),
                                new MemoryFontSource(Files.readAllBytes(Paths.get(getFontsDir() + "Arvo-Bold.ttf")), 0, CACHE_KEY_2)
                        }, inputStream);
            }
        
            Assert.assertEquals(parsedFonts.getFontsSources().length, loadedCache.getFontsSources().length);
        }
        
        /// <summary>
        /// Load the font data only when required instead of storing it in the memory
        /// for the entire lifetime of the "FontSettings" object.
        /// </summary>
        private static class SearchCacheStream extends StreamFontSource
        {
            public SearchCacheStream(String cacheKey)
            {
                super(0, cacheKey);
        
            }
        
            public FileInputStream openFontDataStream() throws Exception
            {
                return new FileInputStream(getFontsDir() + "Arvo-Regular.ttf");
            }
        }
    • Property Getters/Setters Detail

      • getCacheKey

        public java.lang.String getCacheKey()
        
        The key of this source in the cache. This key is used to identify cache item when saving/loading font search cache with saveSearchCache and setFontsSources methods.
      • getFontData

        public byte[] getFontData()
        
        Binary font data.

        Example:

        Shows how to use a byte array with data from a font file as a font source.
        byte[] fontBytes = DocumentHelper.getBytesFromStream(new FileInputStream(getMyDir() + "Alte DIN 1451 Mittelschrift.ttf"));
        MemoryFontSource memoryFontSource = new MemoryFontSource(fontBytes, 0);
        
        Document doc = new Document();
        doc.setFontSettings(new FontSettings());
        doc.getFontSettings().setFontsSources(new FontSourceBase[]{memoryFontSource});
        
        Assert.assertEquals(FontSourceType.MEMORY_FONT, memoryFontSource.getType());
        Assert.assertEquals(0, memoryFontSource.getPriority());
      • getPriority

        public int getPriority()
        
        Returns the font source priority.

        This value is used when there are fonts with the same family name and style in different font sources. In this case Aspose.Words selects the font from the source with the higher priority value.

        The default value is 0.

        Example:

        Shows how to use a font file in the local file system as a font source.
        FileFontSource fileFontSource = new FileFontSource(getMyDir() + "Alte DIN 1451 Mittelschrift.ttf", 0);
        
        Document doc = new Document();
        doc.setFontSettings(new FontSettings());
        doc.getFontSettings().setFontsSources(new FontSourceBase[]{fileFontSource});
        
        Assert.assertEquals(getMyDir() + "Alte DIN 1451 Mittelschrift.ttf", fileFontSource.getFilePath());
        Assert.assertEquals(FontSourceType.FONT_FILE, fileFontSource.getType());
        Assert.assertEquals(0, fileFontSource.getPriority());
      • getType

        public int getType()
        
        Returns the type of the font source. The value of the property is FontSourceType integer constant.

        Example:

        Shows how to use a byte array with data from a font file as a font source.
        byte[] fontBytes = DocumentHelper.getBytesFromStream(new FileInputStream(getMyDir() + "Alte DIN 1451 Mittelschrift.ttf"));
        MemoryFontSource memoryFontSource = new MemoryFontSource(fontBytes, 0);
        
        Document doc = new Document();
        doc.setFontSettings(new FontSettings());
        doc.getFontSettings().setFontsSources(new FontSourceBase[]{memoryFontSource});
        
        Assert.assertEquals(FontSourceType.MEMORY_FONT, memoryFontSource.getType());
        Assert.assertEquals(0, memoryFontSource.getPriority());
      • getWarningCallback/setWarningCallback

        public IWarningCallback getWarningCallback() / public void setWarningCallback(IWarningCallback value)
        
        Called during processing of font source when an issue is detected that might result in formatting fidelity loss.

        Example:

        Shows how to call warning callback when the font sources working with.
        @Test
        public void fontSourceWarning()
        {
            FontSettings settings = new FontSettings();
            settings.setFontsFolder("bad folder?", false);
        
            FontSourceBase source = settings.getFontsSources()[0];
            FontSourceWarningCollector callback = new FontSourceWarningCollector();
            source.setWarningCallback(callback);
        
            // Get the list of fonts to call warning callback.
            ArrayList<PhysicalFontInfo> fontInfos = source.getAvailableFonts();
        
            Assert.assertEquals("Error loading font from the folder \"bad folder?\": ",
                callback.FontSubstitutionWarnings.get(0).getDescription());
        }
        
        private static class FontSourceWarningCollector implements IWarningCallback
        {
            /// <summary>
            /// Called every time a warning occurs during processing of font source.
            /// </summary>
            public void warning(WarningInfo info)
            {
                FontSubstitutionWarnings.warning(info);
            }
        
            public WarningInfoCollection FontSubstitutionWarnings = new WarningInfoCollection();
        }
    • Method Detail

      • getAvailableFonts

        public java.util.ArrayList<PhysicalFontInfo> getAvailableFonts()
        Returns list of fonts available via this source.

        Example:

        Shows how to list available fonts.
        // Configure Aspose.Words to source fonts from a custom folder, and then print every available font.
        FontSourceBase[] folderFontSource = {new FolderFontSource(getFontsDir(), true)};
        
        for (PhysicalFontInfo fontInfo : folderFontSource[0].getAvailableFonts()) {
            System.out.println(MessageFormat.format("FontFamilyName : {0}", fontInfo.getFontFamilyName()));
            System.out.println(MessageFormat.format("FullFontName  : {0}", fontInfo.getFullFontName()));
            System.out.println(MessageFormat.format("Version  : {0}", fontInfo.getVersion()));
            System.out.println(MessageFormat.format("FilePath : {0}\n", fontInfo.getFilePath()));
        }