de.dante.extex.typesetter.listMaker
Interface ListManager

All Known Implementing Classes:
TypesetterImpl

public interface ListManager

Interface for the Manager of a list maker.

Version:
$Revision: 1.13 $
Author:
Gerd Neugebauer, Michael Niedermair

Method Summary
 NodeList buildParagraph(HorizontalListNode nodes)
          Invoke the paragraph builder on a list of nodes.
 void endParagraph()
          End the current paragraph.
 ListMaker ensureHorizontalMode(Locator locator)
          Switch to horizontal mode if necessary.
 NodeFactory getNodeFactory()
          Getter for the char node factory.
 TypesetterOptions getOptions()
          Getter for the options object.
 ListMaker pop()
          Discard the top of the stack of list makers.
 void push(ListMaker listMaker)
          Push a new element to the stack of list makers.
 void setSpacefactor(FixedCount spaceFactor)
          Setter for the space factor
 

Method Detail

buildParagraph

public NodeList buildParagraph(HorizontalListNode nodes)
                        throws TypesetterException
Invoke the paragraph builder on a list of nodes.

Parameters:
nodes - the nodes to make a paragraph from
Returns:
the vertical node list containing the lines of the paragraph
Throws:
TypesetterException - in case of an error

endParagraph

public void endParagraph()
                  throws TypesetterException,
                         ConfigurationException
End the current paragraph.

Throws:
TypesetterException - in case of an error
ConfigurationException - in case of an configuration problem

ensureHorizontalMode

public ListMaker ensureHorizontalMode(Locator locator)
                               throws TypesetterException
Switch to horizontal mode if necessary. If the current mode is a horizontal mode then nothing is done.

Parameters:
locator - the locator
Returns:
the horizontal list maker
Throws:
TypesetterException - in case of an error

getNodeFactory

public NodeFactory getNodeFactory()
Getter for the char node factory.

Returns:
the char node factory

getOptions

public TypesetterOptions getOptions()
Getter for the options object.

Returns:
the options

pop

public ListMaker pop()
              throws TypesetterException
Discard the top of the stack of list makers.

Returns:
the list maker popped from the stack
Throws:
TypesetterException - in case of an error

push

public void push(ListMaker listMaker)
          throws TypesetterException
Push a new element to the stack of list makers.

Parameters:
listMaker - the new element to push
Throws:
TypesetterException - in case of an error

setSpacefactor

public void setSpacefactor(FixedCount spaceFactor)
                    throws TypesetterUnsupportedException,
                           InvalidSpacefactorException
Setter for the space factor

Parameters:
spaceFactor - the space factor
Throws:
TypesetterUnsupportedException - in case of an error
InvalidSpacefactorException - in case of an invalid space factor