com.aspose.words

Class FolderFontSource

java.lang.Object

com.aspose.words.FontSourceBase

com.aspose.words.FolderFontSource

public class FolderFontSource
extends FontSourceBase

Represents the folder that contains TrueType font files.

To learn more, visit the Working with Fonts documentation article.

Examples:

Shows how to use a local system folder which contains fonts as a font source.

 
 // Create a font source from a folder that contains font files.
 FolderFontSource folderFontSource = new FolderFontSource(getFontsDir(), false, 1);

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

 Assert.assertEquals(getFontsDir(), folderFontSource.getFolderPath());
 Assert.assertEquals(false, folderFontSource.getScanSubfolders());
 Assert.assertEquals(FontSourceType.FONTS_FOLDER, folderFontSource.getType());
 Assert.assertEquals(1, folderFontSource.getPriority());
 
 

Constructor Summary

Constructors

Constructor and Description
FolderFontSource(java.lang.String folderPath, boolean scanSubfolders) Ctor.
FolderFontSource(java.lang.String folderPath, boolean scanSubfolders, int priority) Ctor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFolderPath() Path to the folder.
java.lang.Iterable	getFontDataInternal()
boolean	getScanSubfolders() Determines whether or not to scan the subfolders.
int	getType() Returns the type of the font source.

Methods inherited from class com.aspose.words.FontSourceBase

getAvailableFonts, getPriority, getPriorityInternal, getWarningCallback, setWarningCallback

Methods inherited from class java.lang.Object

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

Constructor Detail

FolderFontSource

public FolderFontSource(java.lang.String folderPath,
                        boolean scanSubfolders)

Ctor.

Examples:

Shows how to use a local system folder which contains fonts as a font source.

 
 // Create a font source from a folder that contains font files.
 FolderFontSource folderFontSource = new FolderFontSource(getFontsDir(), false, 1);

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

 Assert.assertEquals(getFontsDir(), folderFontSource.getFolderPath());
 Assert.assertEquals(false, folderFontSource.getScanSubfolders());
 Assert.assertEquals(FontSourceType.FONTS_FOLDER, folderFontSource.getType());
 Assert.assertEquals(1, folderFontSource.getPriority());
 
 

Parameters:

folderPath - Path to folder.

scanSubfolders - Determines whether or not to scan subfolders.

FolderFontSource

public FolderFontSource(java.lang.String folderPath,
                        boolean scanSubfolders,
                        int priority)

Ctor.

Examples:

Shows how to use a local system folder which contains fonts as a font source.

 
 // Create a font source from a folder that contains font files.
 FolderFontSource folderFontSource = new FolderFontSource(getFontsDir(), false, 1);

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

 Assert.assertEquals(getFontsDir(), folderFontSource.getFolderPath());
 Assert.assertEquals(false, folderFontSource.getScanSubfolders());
 Assert.assertEquals(FontSourceType.FONTS_FOLDER, folderFontSource.getType());
 Assert.assertEquals(1, folderFontSource.getPriority());
 
 

Parameters:

folderPath - Path to folder.

scanSubfolders - Determines whether or not to scan subfolders.

priority - Font source priority. See the FontSourceBase.getPriority() property description for more information.

Method Detail

getFolderPath

public java.lang.String getFolderPath()

Path to the folder.

Examples:

Shows how to use a local system folder which contains fonts as a font source.

 
 // Create a font source from a folder that contains font files.
 FolderFontSource folderFontSource = new FolderFontSource(getFontsDir(), false, 1);

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

 Assert.assertEquals(getFontsDir(), folderFontSource.getFolderPath());
 Assert.assertEquals(false, folderFontSource.getScanSubfolders());
 Assert.assertEquals(FontSourceType.FONTS_FOLDER, folderFontSource.getType());
 Assert.assertEquals(1, folderFontSource.getPriority());
 
 

Returns:

The corresponding String value.

getScanSubfolders

public boolean getScanSubfolders()

Determines whether or not to scan the subfolders.

Examples:

Shows how to use a local system folder which contains fonts as a font source.

 
 // Create a font source from a folder that contains font files.
 FolderFontSource folderFontSource = new FolderFontSource(getFontsDir(), false, 1);

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

 Assert.assertEquals(getFontsDir(), folderFontSource.getFolderPath());
 Assert.assertEquals(false, folderFontSource.getScanSubfolders());
 Assert.assertEquals(FontSourceType.FONTS_FOLDER, folderFontSource.getType());
 Assert.assertEquals(1, folderFontSource.getPriority());
 
 

Returns:

The corresponding boolean value.

getType

public int getType()

Returns the type of the font source.

Examples:

Shows how to use a local system folder which contains fonts as a font source.

 
 // Create a font source from a folder that contains font files.
 FolderFontSource folderFontSource = new FolderFontSource(getFontsDir(), false, 1);

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

 Assert.assertEquals(getFontsDir(), folderFontSource.getFolderPath());
 Assert.assertEquals(false, folderFontSource.getScanSubfolders());
 Assert.assertEquals(FontSourceType.FONTS_FOLDER, folderFontSource.getType());
 Assert.assertEquals(1, folderFontSource.getPriority());
 
 

Specified by:

getType in class FontSourceBase

Returns:

The type of the font source. The returned value is one of FontSourceType constants.

getFontDataInternal

public java.lang.Iterable getFontDataInternal()

Overrides:

getFontDataInternal in class FontSourceBase