com.aspose.words

Class Hyphenation

java.lang.Object

com.aspose.words.Hyphenation

public class Hyphenation
extends java.lang.Object

Provides methods for working with hyphenation dictionaries. These dictionaries prescribe where words of a specific language can be hyphenated.

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

Method Summary

Modifier and Type	Method and Description
static IHyphenationCallback	getCallback() Gets callback interface used to request dictionaries when page layout of the document is built.
static IWarningCallback	getWarningCallback() Called during a load hyphenation patterns, when an issue is detected that might result in formatting fidelity loss.
static boolean	isDictionaryRegistered(java.lang.String language) Returns False if for the specified language there is no dictionary registered or if registered is Null dictionary, True otherwise.
static void	registerDictionary(java.lang.String language, java.io.InputStream stream)
static void	registerDictionary(java.lang.String language, java.lang.String fileName) Registers and loads a hyphenation dictionary for the specified language from file.
static void	setCallback(IHyphenationCallback value) Sets callback interface used to request dictionaries when page layout of the document is built.
static void	setWarningCallback(IWarningCallback value) Called during a load hyphenation patterns, when an issue is detected that might result in formatting fidelity loss.
static void	unregisterDictionary(java.lang.String language) Unregisters a hyphenation dictionary for the specified language.

Methods inherited from class java.lang.Object

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

Method Detail

registerDictionary

public static void registerDictionary(java.lang.String language,
                                      java.io.InputStream stream)
                               throws java.lang.Exception

Throws:

java.lang.Exception

registerDictionary

public static void registerDictionary(java.lang.String language,
                                      java.lang.String fileName)
                               throws java.lang.Exception

Registers and loads a hyphenation dictionary for the specified language from file. Throws if dictionary cannot be read or has invalid format.

This method can also be used to register Null dictionary to prevent getCallback() / setCallback(com.aspose.words.IHyphenationCallback) from being called repeatedly for the same language.

Parameters:

language - A language name, e.g. "en-US". See .NET documentation for "culture name" and RFC 4646 for details.

fileName - A path to the dictionary file in Open Office format.

Throws:

java.lang.Exception

unregisterDictionary

public static void unregisterDictionary(java.lang.String language)

Unregisters a hyphenation dictionary for the specified language.

This is different from registering Null dictionary. Unregistering a dictionary enables callback for the specified language.

Parameters:

language - A language name, e.g. "en-US". See .NET documentation for "culture name" and RFC 4646 for details.

isDictionaryRegistered

public static boolean isDictionaryRegistered(java.lang.String language)

Returns False if for the specified language there is no dictionary registered or if registered is Null dictionary, True otherwise.

getCallback

public static IHyphenationCallback getCallback()

Gets callback interface used to request dictionaries when page layout of the document is built. This allows delay loading of dictionaries which may be useful when processing documents in many languages.

Returns:

Callback interface used to request dictionaries when page layout of the document is built.

setCallback

public static void setCallback(IHyphenationCallback value)

Sets callback interface used to request dictionaries when page layout of the document is built. This allows delay loading of dictionaries which may be useful when processing documents in many languages.

Parameters:

value - Callback interface used to request dictionaries when page layout of the document is built.

getWarningCallback

public static IWarningCallback getWarningCallback()

Called during a load hyphenation patterns, when an issue is detected that might result in formatting fidelity loss.

Returns:

The corresponding IWarningCallback value.

setWarningCallback

public static void setWarningCallback(IWarningCallback value)

Called during a load hyphenation patterns, when an issue is detected that might result in formatting fidelity loss.

Parameters:

value - The corresponding IWarningCallback value.