org.apache.fop.layout.hyphenation: public interface: PatternConsumer

org.apache.fop.layout.hyphenation
public interface: PatternConsumer [javadoc | source]

All Known Implementing Classes:
HyphenationTree, PatternParser

This interface is used to connect the XML pattern file parser to the hyphenation tree.

author: Carlos - Villegas

Method from org.apache.fop.layout.hyphenation.PatternConsumer Summary:
addClass, addException, addPattern

Method from org.apache.fop.layout.hyphenation.PatternConsumer Detail:
public void addClass(String chargroup) Add a character class. A character class defines characters that are considered equivalent for the purpose of hyphenation (e.g. "aA"). It usually means to ignore case.
public void addException(String word, ArrayList hyphenatedword) Add a hyphenation exception. An exception replaces the result obtained by the algorithm for cases for which this fails or the user wants to provide his own hyphenation. A hyphenatedword is a ArrayList of alternating String's and Hyphen instances
public void addPattern(String pattern, String values) Add hyphenation patterns.

Method from org.apache.fop.layout.hyphenation.PatternConsumer Detail:

 public  void addClass(String chargroup)Add a character class.
A character class defines characters that are considered
equivalent for the purpose of hyphenation (e.g. "aA"). It
usually means to ignore case.

 public  void addException(String word,
    ArrayList hyphenatedword)Add a hyphenation exception. An exception replaces the
result obtained by the algorithm for cases for which this
fails or the user wants to provide his own hyphenation.
A hyphenatedword is a ArrayList of alternating String's and
Hyphen  instances

 public  void addPattern(String pattern,
    String values)Add hyphenation patterns.