com.aspose.words

Class StreamFontSource

java.lang.Object

com.aspose.words.FontSourceBase

com.aspose.words.StreamFontSource

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.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StreamFontSource() Initializes a new instance of this class.
protected	StreamFontSource(int priority) Initializes a new instance of this class.
protected	StreamFontSource(int priority, java.lang.String cacheKey) Initializes a new instance of this class.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCacheKey() The key of this source in the cache.
java.lang.String	getCacheKeyInternal()
java.lang.String	getFilePath()
java.lang.Iterable	getFontDataInternal()
int	getSize()
int	getType() Returns the type of the font source.
abstract java.io.InputStream	openFontDataStream() This method should open the stream with font data on demand.

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

StreamFontSource

protected StreamFontSource()

Initializes a new instance of this class.

StreamFontSource

protected StreamFontSource(int priority)

Initializes a new instance of this class.

StreamFontSource

protected StreamFontSource(int priority,
                           java.lang.String cacheKey)

Initializes a new instance of this class.

Method 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 and methods.

Returns:

The corresponding String value.

getType

public final int getType()

Returns the type of the font source.

Specified by:

getType in class FontSourceBase

Returns:

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

openFontDataStream

public abstract java.io.InputStream openFontDataStream()
                                                throws java.lang.Exception

This method should open the stream with font data on demand.

Returns:

Font data stream.

Throws:

java.lang.Exception

getSize

public int getSize()

getFilePath

public java.lang.String getFilePath()

getCacheKeyInternal

public java.lang.String getCacheKeyInternal()

getFontDataInternal

public java.lang.Iterable getFontDataInternal()

Overrides:

getFontDataInternal in class FontSourceBase