|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Typesetter
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.
Method Summary | |
---|---|
void |
clearShipoutMark()
Clear the internal state about ship-outs. |
ListMaker |
ensureHorizontalMode(Locator locator)
Switch to horizontal mode if necessary. |
void |
finish()
Instructs the typesetter to perform any actions necessary for cleaning up everything at the end of processing. |
BackendDriver |
getBackendDriver()
Getter for the back-end driver. |
ListMaker |
getListMaker()
Getter for the current list maker. |
ListManager |
getManager()
Getter for the manager of the list maker stack. |
NodeFactory |
getNodeFactory()
Getter for the NodeFactory. |
boolean |
isShipoutMark()
Query the ship-out mark. |
void |
push(ListMaker listMaker)
Open a new list maker and put it in the top of the stack as current box. |
ListMaker |
pushListMaker(ListMakerType type,
Locator locator)
Push a list maker onto the stack and return the old value. |
void |
setBackend(BackendDriver driver)
Setter for the back-end driver. |
void |
setNodeFactory(NodeFactory nodeFactory)
Setter for the node factory. |
void |
setOptions(TypesetterOptions options)
Setter for the typesetter specific options. |
void |
setOutputRoutine(OutputRoutine output)
Setter for the output routine. |
void |
setPageBuilder(PageBuilder pageBuilder)
Setter for the page builder. |
void |
setParagraphBuilder(ParagraphBuilder paragraphBuilder)
Setter for the paragraph builder. |
void |
shipout(NodeList nodes)
Send a list of nodes to the document writer. |
void |
showlists(java.lang.StringBuffer sb,
long depth,
long breadth)
This method produces a diagnostic representation of the current lists in a StringBuffer. |
Methods inherited from interface org.extex.typesetter.ListMaker |
---|
add, add, addAndAdjust, addSpace, afterParagraph, complete, getLastNode, getLocator, getMode, getPrevDepth, getSpacefactor, leftBrace, par, removeLastNode, rightBrace, setPrevDepth, setSpacefactor, showlist |
Method Detail |
---|
void clearShipoutMark()
false
.
isShipoutMark()
ListMaker ensureHorizontalMode(Locator locator) throws TypesetterException
locator
- the locator
TypesetterException
- in case of an errorvoid finish() throws TypesetterException, ConfigurationException
TypesetterException
- in case of an error
ConfigurationException
- in case of an configuration problemBackendDriver getBackendDriver()
ListMaker getListMaker()
null
if the stack is emptyListManager getManager()
NodeFactory getNodeFactory()
boolean isShipoutMark()
clearShipoutMark()
can be used to reset the
ship-out mark to false
. Initially the ship-out mark is
false
.
true
iff there has been an invocation to the
method shipout()
since the last
clearingclearShipoutMark()
void push(ListMaker listMaker) throws TypesetterException
listMaker
- the list maker
TypesetterException
- in case of an errorvoid setBackend(BackendDriver driver)
driver
- the new back-end drivervoid setNodeFactory(NodeFactory nodeFactory)
nodeFactory
- the node factoryvoid setOptions(TypesetterOptions options)
options
- the options to usevoid setOutputRoutine(OutputRoutine output)
output
- the output routinevoid setPageBuilder(PageBuilder pageBuilder)
pageBuilder
- the page builder to set.void setParagraphBuilder(ParagraphBuilder paragraphBuilder)
paragraphBuilder
- the paragraph builder to set.void shipout(NodeList nodes) throws TypesetterException
nodes
- the nodes to send to the typesetter
TypesetterException
- in case of an errorclearShipoutMark()
void showlists(java.lang.StringBuffer sb, long depth, long breadth)
sb
- the target string bufferdepth
- the depth for the displaybreadth
- the breadth of the displayListMaker pushListMaker(ListMakerType type, Locator locator) throws java.lang.UnsupportedOperationException, TypesetterException
type
- the type of the list makerlocator
- the locator
java.lang.UnsupportedOperationException
- in case that the type is now known
TypesetterException
- in case of an error in the typesetter
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |