com.aspose.words

Class StreamFontSource

  • All Implemented Interfaces:
    com.aspose.words.internal.zzXpW, com.aspose.words.internal.zzXpW, com.aspose.words.internal.zzY43
    public abstract class StreamFontSource 
    extends FontSourceBase

Base class for user-defined stream font source.

In order to use the stream font source you should create a derived class from the StreamFontSource and provide implementation of the openFontDataStream() method.

openFontDataStream() method could be called several times. For the first time it will be called when Aspose.Words scans the provided font sources to get the list of available fonts. Later it may be called if the font is used in the document to parse the font data and to embed the font data to some output formats.

StreamFontSource may be useful because it allows to load the font data only when it is required and not to store it in the memory for the FontSettings lifetime.

Example:

Shows how to load fonts from stream.
public void streamFontSourceFileRendering() throws Exception {
    FontSettings fontSettings = new FontSettings();
    fontSettings.setFontsSources(new FontSourceBase[]{new StreamFontSourceFile()});

    DocumentBuilder builder = new DocumentBuilder();
    builder.getDocument().setFontSettings(fontSettings);
    builder.getFont().setName("Kreon-Regular");
    builder.writeln("Test aspose text when saving to PDF.");

    builder.getDocument().save(getArtifactsDir() + "FontSettings.StreamFontSourceFileRendering.pdf");
}

/// <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 StreamFontSourceFile extends StreamFontSource  {
    public FileInputStream openFontDataStream() throws Exception {
        return new FileInputStream(getFontsDir() + "Kreon-Regular.ttf");
    }
}

Property Getters/Setters Summary
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.
abstract System.IO.StreamopenFontDataStream()
This method should open the stream with font data on demand.
 

    • Property Getters/Setters Detail

      • 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.
      • 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()));
        }
      • openFontDataStream

        public abstract System.IO.Stream openFontDataStream()
                                               throws java.lang.Exception
        This method should open the stream with font data on demand. The stream will be closed after reading. There is no need to close it explicitly.
        Returns:
        Font data stream.

        Example:

        Shows how to load fonts from stream.
        public void streamFontSourceFileRendering() throws Exception {
            FontSettings fontSettings = new FontSettings();
            fontSettings.setFontsSources(new FontSourceBase[]{new StreamFontSourceFile()});
        
            DocumentBuilder builder = new DocumentBuilder();
            builder.getDocument().setFontSettings(fontSettings);
            builder.getFont().setName("Kreon-Regular");
            builder.writeln("Test aspose text when saving to PDF.");
        
            builder.getDocument().save(getArtifactsDir() + "FontSettings.StreamFontSourceFileRendering.pdf");
        }
        
        /// <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 StreamFontSourceFile extends StreamFontSource  {
            public FileInputStream openFontDataStream() throws Exception {
                return new FileInputStream(getFontsDir() + "Kreon-Regular.ttf");
            }
        }