Package org.apache.fop.fo

Class XMLWhiteSpaceHandler

java.lang.Object

org.apache.fop.fo.XMLWhiteSpaceHandler

public class XMLWhiteSpaceHandler
extends java.lang.Object

Class encapsulating the functionality for white-space-handling during refinement stage. The handleWhiteSpace() methods are called during FOTree-building and marker-cloning:

• from FObjMixed.addChildNode()
• from FObjMixed.endOfNode()
• from FObjMixed.handleWhiteSpaceFor()

Each time one of the variants is called, white-space is handled for all FOText or Character nodes that were added:

• either prior to newChild (and after the previous non-text child node)
• or, if newChild is null, after the previous non-text child

The iteration always starts at firstTextNode, goes on until the last text-node is reached, and deals only with FOText or Character nodes.
Note: if the method is called from an inline's endOfNode(), there is too little context to decide whether trailing white-space may be removed, so the pending inline is stored in a List, together with an iterator for which the next() method returns the first in the trailing sequence of white- space characters. This List is processed again at the end of the ancestor block.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	XMLWhiteSpaceHandler.EOLchecker	Helper class, used during white-space handling to look ahead, and see if the next character is a linefeed (or if there will be an equivalent effect during layout, i.e.
private class	XMLWhiteSpaceHandler.PendingInline	Helper class to store unfinished inline nodes together with an iterator that starts at the first white-space character in the sequence of trailing white-space

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	afterLinefeed	True if the last char was a linefeed
private RecursiveCharIterator	charIter
private boolean	endOfBlock
private CharIterator	firstWhiteSpaceInSeq
private boolean	inWhiteSpace	True if we are in a run of white space
private int	linefeedTreatment
private java.util.Stack	nestedBlockStack
private boolean	nextChildIsBlockLevel
private int	nonWhiteSpaceCount	Counter, increased every time a non-white-space is encountered
private java.util.List	pendingInlines
private int	whiteSpaceCollapse
private int	whiteSpaceTreatment

Constructor Summary

Constructors

Constructor	Description
XMLWhiteSpaceHandler()

Method Summary

Modifier and Type	Method	Description
private void	addPendingInline()
private void	handlePendingInlines()
private void	handleWhiteSpace()
void	handleWhiteSpace(FObjMixed fo, FONode firstTextNode)	Handle white-space for the fo that is passed in, starting at firstTextNode (when a nested FO is encountered)
void	handleWhiteSpace(FObjMixed fo, FONode firstTextNode, FONode nextChild)	Handle white-space for the fo that is passed in, starting at firstTextNode
protected void	reset()	Reset the handler, release all references

Methods inherited from class java.lang.Object

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

Field Detail

inWhiteSpace

private boolean inWhiteSpace

True if we are in a run of white space

afterLinefeed

private boolean afterLinefeed

True if the last char was a linefeed

nonWhiteSpaceCount

private int nonWhiteSpaceCount

Counter, increased every time a non-white-space is encountered

linefeedTreatment

private int linefeedTreatment

whiteSpaceTreatment

private int whiteSpaceTreatment

whiteSpaceCollapse

private int whiteSpaceCollapse

endOfBlock

private boolean endOfBlock

nextChildIsBlockLevel

private boolean nextChildIsBlockLevel

charIter

private RecursiveCharIterator charIter

pendingInlines

private java.util.List pendingInlines

nestedBlockStack

private java.util.Stack nestedBlockStack

firstWhiteSpaceInSeq

private CharIterator firstWhiteSpaceInSeq

Constructor Detail

XMLWhiteSpaceHandler

public XMLWhiteSpaceHandler()

Method Detail

handleWhiteSpace

public void handleWhiteSpace(FObjMixed fo,
                             FONode firstTextNode,
                             FONode nextChild)

Handle white-space for the fo that is passed in, starting at firstTextNode

Parameters:

fo - the FO for which to handle white-space

firstTextNode - the node at which to start

nextChild - the node that will be added to the list after firstTextNode

reset

protected final void reset()

Reset the handler, release all references

handleWhiteSpace

public void handleWhiteSpace(FObjMixed fo,
                             FONode firstTextNode)

Handle white-space for the fo that is passed in, starting at firstTextNode (when a nested FO is encountered)

Parameters:

fo - the FO for which to handle white-space

firstTextNode - the node at which to start

handleWhiteSpace

private void handleWhiteSpace()

addPendingInline

private void addPendingInline()

handlePendingInlines

private void handlePendingInlines()