org.foray.fotree.fo.obj
Class FoInterword

java.lang.Object
  org.foray.fotree.fo.obj.FoWordSequenceContent
      org.foray.fotree.fo.obj.FoInterword

All Implemented Interfaces:

CharSequence

public class FoInterword
extends FoWordSequenceContent

Fo wrapper around an interword.

Constructor Summary

FoInterword(org.axsl.hyphen.Interword interword)
Constructor.

Method Summary

char	charAt(int index)
org.axsl.hyphen.Interword	getInterword() Returns the wrapped interword.
int	length()
CharSequence	subSequence(int start, int end)
char	textTransformCharAt(org.axsl.common.value.WhiteSpaceTreatment whiteSpaceTreatment, org.axsl.common.value.LinefeedTreatment linefeedTreatment, org.axsl.common.value.TextTransform textTransform, int textTransformIndex) Returns the char at a given index after text-transform is applied.
String	toString()

Methods inherited from class org.foray.fotree.fo.obj.FoWordSequenceContent

linefeedTreatmentCharAt, linefeedTreatmentLength, textTransformLength, whiteSpaceCollapseCharAt, whiteSpaceCollapseLength, whiteSpaceTreatmentCharAt, whiteSpaceTreatmentLength

Methods inherited from class java.lang.Object

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

Constructor Detail

FoInterword

public FoInterword(org.axsl.hyphen.Interword interword)

Constructor.

Parameters:

interword - The wrapped interword.

Method Detail

getInterword

public org.axsl.hyphen.Interword getInterword()

Returns the wrapped interword.

Returns:

The wrapped interword.

length

public int length()

charAt

public char charAt(int index)

subSequence

public CharSequence subSequence(int start,
                                int end)

textTransformCharAt

public char textTransformCharAt(org.axsl.common.value.WhiteSpaceTreatment whiteSpaceTreatment,
                                org.axsl.common.value.LinefeedTreatment linefeedTreatment,
                                org.axsl.common.value.TextTransform textTransform,
                                int textTransformIndex)

Description copied from class: FoWordSequenceContent

Returns the char at a given index after text-transform is applied. The text-transform is applied after linefeed-treatment, which is applied after white-space-treatment, so this method shows the effect of all of those properties.

Specified by:

textTransformCharAt in class FoWordSequenceContent

Parameters:

whiteSpaceTreatment - The white-space-treatment to be used in evaluation.

linefeedTreatment - The linefeed-treatment to be used in evaluation.

textTransform - The text-transform to be used in evaluation.

textTransformIndex - The index into the chars in this instance, after text-transform is applied.

Returns:

The char at a given index after text-transform is applied.

toString

public String toString()

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object