org.extex.typesetter.listMaker
Class HorizontalListMaker

java.lang.Object
  org.extex.typesetter.listMaker.AbstractListMaker
      org.extex.typesetter.listMaker.HorizontalListMaker

All Implemented Interfaces:

ListMaker, TokenDelegateListMaker

Direct Known Subclasses:

MathListMaker, RestrictedHorizontalListMaker

public class HorizontalListMaker
extends AbstractListMaker

Maker for a horizontal list.

After par(), the line breaking and hyphenation are applied.

Version:

$Revision: 5837 $

Author:

Gerd Neugebauer, Michael Niedermair

Constructor Summary

HorizontalListMaker(ListManager manager, Locator locator)
Creates a new object.

Method Summary

void	add(FixedGlue g) Add a glue node to the list.
void	add(Node c) Add an arbitrary node to the internal list of nodes gathered so far.
void	addAndAdjust(NodeList list, TypesetterOptions options) Add a node list to the current list maker and adjust the spacing between the elements of the list.
void	addSpace(TypesettingContext context, FixedCount sfCount) Add a space node to the list.
void	afterParagraph(ParagraphObserver observer) Register an observer to be invoked at the end of the paragraph.
NodeList	complete(TypesetterOptions context) Close the node list.
void	cr(Context context, TypesettingContext tc, UnicodeChar uc) Process a carriage return.
Node	getLastNode() Access the last node on the list.
Mode	getMode() Getter for the current mode.
protected HorizontalListNode	getNodes() Getter for nodes.
long	getSpacefactor() Getter for the space factor.
boolean	letter(UnicodeChar symbol, TypesettingContext tc, Context context, TokenSource source, Locator locator) Add a letter to the current list or treat it in some other appropriate way.
void	par() Emit a new paragraph.
void	removeLastNode() Removes the last node from the list.
protected void	setNodes(HorizontalListNode nodes) Setter for nodes.
void	setSpacefactor(FixedCount f) Setter for the space factor.
void	showlist(java.lang.StringBuffer sb, long l, long m) Print the status for \showlists.
java.lang.String	toString() Get the string representation of this object for debugging purposes.

Methods inherited from class org.extex.typesetter.listMaker.AbstractListMaker

getLocalizer, getLocator, getManager, getMyLocalizer, getPrevDepth, leftBrace, mathShift, rightBrace, setPrevDepth, subscriptMark, superscriptMark, tab

Methods inherited from class java.lang.Object

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

Constructor Detail

HorizontalListMaker

public HorizontalListMaker(ListManager manager,
                           Locator locator)

Creates a new object.

Parameters:

manager - the manager to ask for global changes

locator - the locator

Method Detail

add

public void add(Node c)
         throws TypesetterException,
                ConfigurationException

Add an arbitrary node to the internal list of nodes gathered so far. The node should not be one of the special nodes treated by methods of their own.

Parameters:

c - the node to add

Throws:

TypesetterException - in case of an error

ConfigurationException - in case of a configuration error

See Also:

ListMaker.add( org.extex.typesetter.type.Node)

addAndAdjust

public void addAndAdjust(NodeList list,
                         TypesetterOptions options)
                  throws TypesetterException

Add a node list to the current list maker and adjust the spacing between the elements of the list.

Parameters:

list - the list

options - the options to use

Throws:

TypesetterException - in case of an error

See Also:

ListMaker.addAndAdjust( org.extex.typesetter.type.NodeList, org.extex.typesetter.TypesetterOptions)

add

public void add(FixedGlue g)
         throws TypesetterException

Add a glue node to the list.

Parameters:

g - the glue to add

Throws:

TypesetterException - in case of an error

See Also:

ListMaker.add( org.extex.core.glue.FixedGlue)

addSpace

public void addSpace(TypesettingContext context,
                     FixedCount sfCount)
              throws TypesetterException,
                     ConfigurationException

Add a space node to the list.

Parameters:

context - the typesetting context for the space

sfCount - the space factor to use for this space or null to indicate that the default space factor should be used.

Throws:

TypesetterException - in case of an error

ConfigurationException - in case of a configuration error

See Also:

ListMaker.addSpace( org.extex.typesetter.tc.TypesettingContext, FixedCount)

afterParagraph

public void afterParagraph(ParagraphObserver observer)

Register an observer to be invoked at the end of the paragraph.

Parameters:

observer - the observer to register

See Also:

ListMaker.afterParagraph( org.extex.typesetter.ParagraphObserver)

complete

public NodeList complete(TypesetterOptions context)
                  throws TypesetterException,
                         ConfigurationException

Close the node list. This means that everything is done to ship the closed node list to the document writer. Nevertheless the invoking application might decide not to modify the node list and continue processing. In the other case some nodes might be taken from the node list returned by this method. Then the processing has to continue with the reduced node list.

Parameters:

context - the typesetter options mapping a fragment of the interpreter context

Returns:

the node list enclosed in this instance

Throws:

TypesetterException - in case of an error

ConfigurationException - in case of a configuration error

See Also:

ListMaker.complete(TypesetterOptions)

cr

public void cr(Context context,
               TypesettingContext tc,
               UnicodeChar uc)
        throws TypesetterException

Process a carriage return.

Parameters:

context - the interpreter context

tc - the typesetting context

uc - the character

Throws:

TypesetterException - in case of an error

See Also:

TokenDelegateListMaker.cr( org.extex.interpreter.context.Context, org.extex.typesetter.tc.TypesettingContext, org.extex.core.UnicodeChar)

getLastNode

public Node getLastNode()

Access the last node on the list.

Returns:

the last node in the current list or null if the list is empty

See Also:

ListMaker.getLastNode()

getMode

public Mode getMode()

Getter for the current mode.

Specified by:

getMode in interface ListMaker

Specified by:

getMode in class AbstractListMaker

Returns:

the mode which is one of the values defined in Mode.

See Also:

ListMaker.getMode()

getNodes

protected HorizontalListNode getNodes()

Getter for nodes.

Returns:

the nodes.

getSpacefactor

public long getSpacefactor()

Getter for the space factor.

Specified by:

getSpacefactor in interface ListMaker

Overrides:

getSpacefactor in class AbstractListMaker

Returns:

the space factor

See Also:

ListMaker.getSpacefactor()

letter

public boolean letter(UnicodeChar symbol,
                      TypesettingContext tc,
                      Context context,
                      TokenSource source,
                      Locator locator)
               throws TypesetterException

Add a letter to the current list or treat it in some other appropriate way.

Parameters:

symbol - the character

tc - the typesetting context

context - the interpreter context

source - the source for new tokens

locator - the locator

Returns:

true iff the character has been discarded because it is not defined in the current font.

Throws:

TypesetterException - in case of an error

See Also:

TokenDelegateListMaker.letter( org.extex.core.UnicodeChar, org.extex.typesetter.tc.TypesettingContext, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.core.Locator), "The TeXbook [p.76]"

par

public void par()
         throws TypesetterException,
                ConfigurationException

Emit a new paragraph. This might be a noop under certain circumstances.

Throws:

TypesetterException - in case of an error

ConfigurationException - in case of a configuration error

See Also:

ListMaker.par()

removeLastNode

public void removeLastNode()

Removes the last node from the list. If the list is empty then nothing is done.

See Also:

ListMaker.removeLastNode()

setNodes

protected void setNodes(HorizontalListNode nodes)

Setter for nodes.

Parameters:

nodes - the nodes to set.

setSpacefactor

public void setSpacefactor(FixedCount f)
                    throws TypesetterUnsupportedException,
                           InvalidSpacefactorException

Setter for the space factor.

Specified by:

setSpacefactor in interface ListMaker

Overrides:

setSpacefactor in class AbstractListMaker

Parameters:

f - the space factor to set

Throws:

TypesetterUnsupportedException - in case of an error

InvalidSpacefactorException - in case of an invalid space factor

See Also:

ListMaker.setSpacefactor( org.extex.core.count.FixedCount)

showlist

public void showlist(java.lang.StringBuffer sb,
                     long l,
                     long m)

Print the status for \showlists.

Parameters:

sb - the target buffer

l - the depth of the list display

m - the breadth of the list display

See Also:

ListMaker.showlist( java.lang.StringBuffer, long, long)

toString

public java.lang.String toString()

Get the string representation of this object for debugging purposes.

Overrides:

toString in class AbstractListMaker

Returns:

the string representation

See Also:

Object.toString()