org.axsl.hyphenR
Interface HyphenBreak

public interface HyphenBreak

Specialized information about a specific hyphenation break opportunity in a word. This handles "hard" hyphenation cases, such as those where the word changes spelling when it is hyphenated. Most hyphenation break opportunities do not require a HyphenBreak.

Method Summary

java.lang.String	postDelete() Assuming that a hyphen is placed at this point, provides the text immediately after that hyphen that should be removed.
java.lang.String	postInsert() Assuming that a hyphen is placed at this point, provides the text that should be inserted immediately after that hyphen.
java.lang.String	preDelete() Assuming that a hyphen is placed at this point, provides the text immediately before that hyphen that should be removed.
java.lang.String	preInsert() Assuming that a hyphen is placed at this point, provides the text that should be inserted immediately before that hyphen.

Method Detail

preDelete

public java.lang.String preDelete()

Assuming that a hyphen is placed at this point, provides the text immediately before that hyphen that should be removed. Note that this deletion should occur chronologically before the text returned by preInsert() is inserted.

Returns:

The text that should be deleted before the hyphen, or null if none should be deleted.

preInsert

public java.lang.String preInsert()

Assuming that a hyphen is placed at this point, provides the text that should be inserted immediately before that hyphen. Note that this insertion should occur chronologically after the text returned by preDelete() is deleted.

Returns:

The text that should be inserted before the hyphen, or null if none should be inserted.

postDelete

public java.lang.String postDelete()

Assuming that a hyphen is placed at this point, provides the text immediately after that hyphen that should be removed. Note that this deletion should occur chronologically before the text returned by postInsert() is inserted.

Returns:

The text that should be deleted after the hyphen, or null if none should be deleted.

postInsert

public java.lang.String postInsert()

Assuming that a hyphen is placed at this point, provides the text that should be inserted immediately after that hyphen. Note that this insertion should occur chronologically after the text returned by postDelete() is deleted.

Returns:

The text that should be inserted after the hyphen, or null if none should be inserted.