de.dante.extex.typesetter.type.node
Class WhatsItWriteNode

java.lang.Object
  extended byde.dante.extex.typesetter.type.node.AbstractNode
      extended byde.dante.extex.typesetter.type.node.WhatsItNode
          extended byde.dante.extex.typesetter.type.node.WhatsItWriteNode
All Implemented Interfaces:
Node, java.io.Serializable

public class WhatsItWriteNode
extends WhatsItNode

This WhatsIt node writes some expanded tokens to an out file on shipping.

Version:
$Revision: 1.13 $
Author:
Gerd Neugebauer
See Also:
Serialized Form

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Fields inherited from class de.dante.extex.typesetter.type.node.AbstractNode
NO_CHARS
 
Constructor Summary
WhatsItWriteNode(java.lang.String key, Tokens tokens, TokenSource source, TokensWriter writer)
          Creates a new object.
 
Method Summary
 Node atShipping(Context context, Typesetter typesetter, NodeVisitor visitor, boolean inHMode)
          This method performs any actions which are required to be executed at the time of shipping the node to the Page.
 
Methods inherited from class de.dante.extex.typesetter.type.node.WhatsItNode
toString, visit
 
Methods inherited from class de.dante.extex.typesetter.type.node.AbstractNode
addDepthTo, addHeightTo, addWidthTo, advanceDepth, advanceHeight, advanceWidth, computeAdjustment, countChars, getChars, getDepth, getHeight, getLocalizer, getVerticalSize, getWidth, maxDepth, maxHeight, maxWidth, setDepth, setHeight, setWidth, spreadHeight, spreadWidth, toString, toText, toText
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

protected static final long serialVersionUID
The constant serialVersionUID contains the id for serialization.

See Also:
Constant Field Values
Constructor Detail

WhatsItWriteNode

public WhatsItWriteNode(java.lang.String key,
                        Tokens tokens,
                        TokenSource source,
                        TokensWriter writer)
Creates a new object.

Parameters:
key - the key for the OutFile
tokens - the tokens to write (after expansion)
source - the interpreter for expansion
writer - the target writer
Method Detail

atShipping

public Node atShipping(Context context,
                       Typesetter typesetter,
                       NodeVisitor visitor,
                       boolean inHMode)
                throws GeneralException
This method performs any actions which are required to be executed at the time of shipping the node to the Page. In the case of this node this means that the tokens are expanded and written to an output writer.

Specified by:
atShipping in interface Node
Overrides:
atShipping in class AbstractNode
Parameters:
context - the interpreter context
typesetter - the typesetter
visitor - the node visitor to be invoked when the node is hit. Note that each node in the output page is visited this way. Thus there is no need to implement a node traversal for the NodeList types
inHMode - true iff the container is a horizontal list. Otherwise the container is a vertical list
Returns:
null since the node should be deleted
Throws:
GeneralException - in case of an IO error
See Also:
Node.atShipping( de.dante.extex.interpreter.context.Context, de.dante.extex.typesetter.Typesetter, de.dante.extex.typesetter.type.NodeVisitor, boolean)