org.extex.typesetter
Interface Typesetter

All Superinterfaces:

ListMaker

All Known Implementing Classes:

NullTypesetterImpl, TypesetterImpl

public interface Typesetter
extends ListMaker

This interface describes the capabilities of a typesetter. The typesetter is a container for a stack of list makers which perform the task of assembling node lists of the appropriate type and structure. The typesetter acts as proxy. Most requests are simply forwarded to the current list maker.

Version:

$Revision: 4739 $

Author:

Gerd Neugebauer

See Also:

"TeX – The Program [211]"

clearShipoutMark

void clearShipoutMark()

Clear the internal state about ship-outs. The ship-out mark is reset to false.

See Also:

isShipoutMark()

ensureHorizontalMode

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

finish

void finish()
            throws TypesetterException,
                   ConfigurationException

Instructs the typesetter to perform any actions necessary for cleaning up everything at the end of processing. This should involve a ship-out of any material still left unprocessed.

Throws:

TypesetterException - in case of an error

ConfigurationException - in case of an configuration problem

getBackendDriver

BackendDriver getBackendDriver()

Getter for the back-end driver.

Returns:

the back-end driver

getListMaker

ListMaker getListMaker()

Getter for the current list maker.

Returns:

the top list maker or null if the stack is empty

getManager

ListManager getManager()

Getter for the manager of the list maker stack.

Returns:

the manager

getNodeFactory

NodeFactory getNodeFactory()

Getter for the NodeFactory.

Returns:

the node factory

isShipoutMark

boolean isShipoutMark()

Query the ship-out mark. The ship-out mark is an internal state which records whether or not the ship-out method has been called recently. This method can be used to get the current state. The method clearShipoutMark() can be used to reset the ship-out mark to false. Initially the ship-out mark is false.

Returns:

true iff there has been an invocation to the method shipout() since the last clearing

See Also:

clearShipoutMark()

push

void push(ListMaker listMaker)
          throws TypesetterException

Open a new list maker and put it in the top of the stack as current box.

Parameters:

listMaker - the list maker

Throws:

TypesetterException - in case of an error

setBackend

void setBackend(BackendDriver driver)

Setter for the back-end driver. The back-end driver is addressed whenever a complete page has to be shipped out.

Parameters:

driver - the new back-end driver

setNodeFactory

void setNodeFactory(NodeFactory nodeFactory)

Setter for the node factory.

Parameters:

nodeFactory - the node factory

setOptions

void setOptions(TypesetterOptions options)

Setter for the typesetter specific options.

Parameters:

options - the options to use

setOutputRoutine

void setOutputRoutine(OutputRoutine output)

Setter for the output routine.

Parameters:

output - the output routine

setPageBuilder

void setPageBuilder(PageBuilder pageBuilder)

Setter for the page builder.

Parameters:

pageBuilder - the page builder to set.

setParagraphBuilder

void setParagraphBuilder(ParagraphBuilder paragraphBuilder)

Setter for the paragraph builder.

Parameters:

paragraphBuilder - the paragraph builder to set.

shipout

void shipout(NodeList nodes)
             throws TypesetterException

Send a list of nodes to the document writer. As a side effect the ship-out mark is set.

Parameters:

nodes - the nodes to send to the typesetter

Throws:

TypesetterException - in case of an error

See Also:

clearShipoutMark()

showlists

void showlists(java.lang.StringBuffer sb,
               long depth,
               long breadth)

This method produces a diagnostic representation of the current lists in a StringBuffer.

Parameters:

sb - the target string buffer

depth - the depth for the display

breadth - the breadth of the display

pushListMaker

ListMaker pushListMaker(ListMakerType type,
                        Locator locator)
                        throws java.lang.UnsupportedOperationException,
                               TypesetterException

Push a list maker onto the stack and return the old value.

Parameters:

type - the type of the list maker

locator - the locator

Returns:

the new list maker

Throws:

java.lang.UnsupportedOperationException - in case that the type is now known

TypesetterException - in case of an error in the typesetter