java.lang.ObjectFontSourceBase
com.aspose.words.FileFontSource
public class FileFontSource
Example:
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());
Constructor Summary |
---|
FileFontSource(java.lang.String filePath, int priority)
Ctor. |
FileFontSource(java.lang.String filePath, int priority, java.lang.String cacheKey)
Ctor. |
FileFontSource(java.lang.String filePath)
Ctor. |
Property Getters/Setters Summary | ||
---|---|---|
java.lang.String | getCacheKey() | |
The key of this source in the cache. | ||
java.lang.String | getFilePath() | |
Path to the font file. | ||
int | getPriority() | → inherited from FontSourceBase |
Returns the font source priority. | ||
int | getType() | |
Returns the type of the font source. The value of the property is FontSourceType integer constant. | ||
IWarningCallback | getWarningCallback() | → inherited from FontSourceBase |
void | setWarningCallback(IWarningCallback value) | |
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() | → inherited from FontSourceBase |
Returns list of fonts available via this source. |
Constructor Detail |
---|
public FileFontSource(java.lang.String filePath, int priority)
filePath
- Path to font file.priority
- Font source priority. See the 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());
public FileFontSource(java.lang.String filePath, int priority, java.lang.String cacheKey)
filePath
- Path to font file.priority
- Font source priority. See the cacheKey
- The key of this source in the cache. See public FileFontSource(java.lang.String filePath)
filePath
- Path to font file.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());
Property Getters/Setters Detail |
---|
getCacheKey | |
public java.lang.String getCacheKey() |
This key is used to identify cache item when saving/loading font search cache with
If key is not specified then
getFilePath | |
public java.lang.String getFilePath() |
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());
getPriority | → inherited from FontSourceBase |
public int getPriority() |
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() |
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());
getWarningCallback/setWarningCallback | → inherited from FontSourceBase |
public IWarningCallback getWarningCallback() / public void setWarningCallback(IWarningCallback value) |
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 | → inherited from FontSourceBase |
public java.util.ArrayList<PhysicalFontInfo> getAvailableFonts() |
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())); }