com.groupdocs.viewer.fonts

Class FolderFontSource

java.lang.Object

com.groupdocs.viewer.fonts.FolderFontSource

All Implemented Interfaces:

com.aspose.ms.System.IEquatable<FolderFontSource>, FontSource

public final class FolderFontSource
extends Object
implements FontSource, com.aspose.ms.System.IEquatable<FolderFontSource>

Represents a folder that contains TrueType fonts.

The FolderFontSource class is used to specify a folder location that contains TrueType fonts. It allows the GroupDocs.Viewer API to access the fonts stored in the specified folder for document rendering purposes.

Example usage:

 FontSettings.setFontSources(new FolderFontSource("/path/to/fonts/folder", SearchOption.ALL_FOLDERS));
 

See Also:

FontSource, FontSettings

Constructor Summary

Constructors

Constructor and Description
FolderFontSource(String folderPath, SearchOption searchOption) Initializes a new instance of the FolderFontSource class.

Method Summary

Modifier and Type	Method and Description
boolean	equals(FolderFontSource other) Determines whether the current FolderFontSource is the same as the specified FolderFontSource object.
boolean	equals(Object o) Determines whether the current FolderFontSource is the same as the specified object.
String	getFolderPath() Gets the path to the folder that contains TrueType fonts.
SearchOption	getSearchOption() Gets the search option that specifies whether to search the current folder, or the current folder and all subfolders.
int	hashCode() Returns the hash code for the current FolderFontSource object.
static boolean	isEqualTo(FolderFontSource left, FolderFontSource right) Determines whether two FolderFontSource objects are the same.
static boolean	isNotEqualTo(FolderFontSource left, FolderFontSource right) Determines whether two FolderFontSource objects are not the same.
boolean	isRecursive() Checks if the fonts would be searched recursively.
String	toString() Returns a string that represents the current object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FolderFontSource

public FolderFontSource(String folderPath,
                        SearchOption searchOption)

Initializes a new instance of the FolderFontSource class.

Parameters:

folderPath - Path to the folder that contains TrueType fonts.

searchOption - Specifies whether to search the current folder, or the current folder and all sub-folders.

Throws:

IllegalArgumentException - Thrown when folderPath is null.

FileNotFoundException - Thrown when the path specified in folderPath can't be located.

Method Detail

equals

public boolean equals(FolderFontSource other)

Determines whether the current FolderFontSource is the same as the specified FolderFontSource object.

Parameters:

other - The object to compare with the current FolderFontSource object.

Returns:

true if both FolderFontSource objects are the same; otherwise, false

equals

public boolean equals(Object o)

Determines whether the current FolderFontSource is the same as the specified object.

Specified by:

equals in interface com.aspose.ms.System.IEquatable<FolderFontSource>

Overrides:

equals in class Object

Parameters:

o - The object to compare with the current FolderFontSource object.

Returns:

true if the obj parameter is of type FolderFontSource and is the same as the current FolderFontSource object; otherwise, false

getFolderPath

public String getFolderPath()

Gets the path to the folder that contains TrueType fonts.

Returns:

the path to the folder that contains TrueType fonts.

getSearchOption

public SearchOption getSearchOption()

Gets the search option that specifies whether to search the current folder, or the current folder and all subfolders.

Returns:

the search option.

hashCode

public int hashCode()

Returns the hash code for the current FolderFontSource object.

Overrides:

hashCode in class Object

Returns:

a hash code for the current FolderFontSource object.

isEqualTo

public static boolean isEqualTo(FolderFontSource left,
                                FolderFontSource right)

Determines whether two FolderFontSource objects are the same.

Parameters:

left - The left FolderFontSource object.

right - The right FolderFontSource object.

Returns:

true if both FolderFontSource objects are the same; otherwise, false.

isNotEqualTo

public static boolean isNotEqualTo(FolderFontSource left,
                                   FolderFontSource right)

Determines whether two FolderFontSource objects are not the same.

Parameters:

left - The left FolderFontSource object.

right - The right FolderFontSource object.

Returns:

true if both FolderFontSource objects are not the same; otherwise, false.

isRecursive

public boolean isRecursive()

Checks if the fonts would be searched recursively.

Returns:

true if the fonts would be searched recursively, false otherwise.

toString

public String toString()

Returns a string that represents the current object.

Overrides:

toString in class Object

Returns:

a string that represents the current object.