org.foray.fotree.fo.obj
Class FoWordSequenceContent

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

All Implemented Interfaces:

CharSequence

Direct Known Subclasses:

FoInterword, FoWord

public abstract class FoWordSequenceContent
extends Object
implements CharSequence

Abstract superclass for the content of an Fo Word Sequence.

Constructor Summary

FoWordSequenceContent()

Method Summary

char	linefeedTreatmentCharAt(org.axsl.common.value.WhiteSpaceTreatment whiteSpaceTreatment, org.axsl.common.value.LinefeedTreatment linefeedTreatment, int linefeedTreatmentIndex) Returns the char at a given index after linefeed-treatment is applied.
int	linefeedTreatmentLength(org.axsl.common.value.WhiteSpaceTreatment whiteSpaceTreatment, org.axsl.common.value.LinefeedTreatment linefeedTreatment) Returns the number of chars in this object after linefeed-treatment is applied.
abstract 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.
int	textTransformLength(org.axsl.common.value.WhiteSpaceTreatment whiteSpaceTreatment, org.axsl.common.value.LinefeedTreatment linefeedTreatment, org.axsl.common.value.TextTransform textTransform) Returns the number of chars in this object after text-transform is applied.
char	whiteSpaceCollapseCharAt(org.axsl.common.value.WhiteSpaceTreatment whiteSpaceTreatment, org.axsl.common.value.LinefeedTreatment linefeedTreatment, org.axsl.common.value.TextTransform textTransform, boolean isWhiteSpaceCollapse, int whiteSpaceCollapseIndex) Returns the char at a given index after white-space-collapse is applied.
int	whiteSpaceCollapseLength(org.axsl.common.value.WhiteSpaceTreatment whiteSpaceTreatment, org.axsl.common.value.LinefeedTreatment linefeedTreatment, org.axsl.common.value.TextTransform textTransform, boolean isWhiteSpaceCollapse) Returns the number of chars in this object after white-space-collapse is applied.
char	whiteSpaceTreatmentCharAt(org.axsl.common.value.WhiteSpaceTreatment whiteSpaceTreatment, int whiteSpaceTreatmentIndex) Returns the char at a given index after white-space-treatment is applied.
int	whiteSpaceTreatmentLength(org.axsl.common.value.WhiteSpaceTreatment whiteSpaceTreatment) Returns the number of chars in this object after white-space-treatment is applied.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.CharSequence

charAt, length, subSequence, toString

Constructor Detail

FoWordSequenceContent

public FoWordSequenceContent()

Method Detail

whiteSpaceTreatmentLength

public int whiteSpaceTreatmentLength(org.axsl.common.value.WhiteSpaceTreatment whiteSpaceTreatment)

Returns the number of chars in this object after white-space-treatment is applied.

Parameters:

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

Returns:

The number of chars in this object after white-space-treatment is applied.

whiteSpaceTreatmentCharAt

public char whiteSpaceTreatmentCharAt(org.axsl.common.value.WhiteSpaceTreatment whiteSpaceTreatment,
                                      int whiteSpaceTreatmentIndex)

Returns the char at a given index after white-space-treatment is applied.

Parameters:

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

whiteSpaceTreatmentIndex - The index into the chars in this instance, after white-space-treatment is applied.

Returns:

The char at a given index after white-space-treatment is applied.

linefeedTreatmentLength

public int linefeedTreatmentLength(org.axsl.common.value.WhiteSpaceTreatment whiteSpaceTreatment,
                                   org.axsl.common.value.LinefeedTreatment linefeedTreatment)

Returns the number of chars in this object after linefeed-treatment is applied. The linefeed-treatment is applied after white-space-treatment, so this method shows the effect of both of those properties.

Parameters:

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

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

Returns:

The number of chars in this object after linefeed-treatment is applied.

linefeedTreatmentCharAt

public char linefeedTreatmentCharAt(org.axsl.common.value.WhiteSpaceTreatment whiteSpaceTreatment,
                                    org.axsl.common.value.LinefeedTreatment linefeedTreatment,
                                    int linefeedTreatmentIndex)

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

Parameters:

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

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

linefeedTreatmentIndex - The index into the chars in this instance, after linefeed-treatment is applied.

Returns:

The char at a given index after white-space-treatment is applied.

textTransformLength

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

Returns the number of chars in this object 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.

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.

Returns:

The number of chars in this object after text-transform is applied.

textTransformCharAt

public abstract 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. 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.

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.

whiteSpaceCollapseLength

public int whiteSpaceCollapseLength(org.axsl.common.value.WhiteSpaceTreatment whiteSpaceTreatment,
                                    org.axsl.common.value.LinefeedTreatment linefeedTreatment,
                                    org.axsl.common.value.TextTransform textTransform,
                                    boolean isWhiteSpaceCollapse)

Returns the number of chars in this object after white-space-collapse is applied. The white-space-collapse is applied after text-transform is applied, which is applied after linefeed-treatment, which is applied after white-space-treatment, so this method shows the effect of all of those properties.

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.

isWhiteSpaceCollapse - The white-space-collapse to be used in evaluation.

Returns:

The number of chars in this object after white-space-collapse is applied.

whiteSpaceCollapseCharAt

public char whiteSpaceCollapseCharAt(org.axsl.common.value.WhiteSpaceTreatment whiteSpaceTreatment,
                                     org.axsl.common.value.LinefeedTreatment linefeedTreatment,
                                     org.axsl.common.value.TextTransform textTransform,
                                     boolean isWhiteSpaceCollapse,
                                     int whiteSpaceCollapseIndex)

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

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.

isWhiteSpaceCollapse - The white-space-collapse to be used in evaluation.

whiteSpaceCollapseIndex - The index into the chars in this instance, after white-space-collapse is applied.

Returns:

The char at a given index after white-space-collapse is applied.