org.extex.unit.tex.file.nodes
Class WhatsItOpenNode

java.lang.Object
  org.extex.typesetter.type.node.AbstractNode
      org.extex.typesetter.type.node.WhatsItNode
          org.extex.unit.tex.file.nodes.WhatsItOpenNode

All Implemented Interfaces:

java.io.Serializable, Node

public class WhatsItOpenNode
extends WhatsItNode

This WhatsIt node which opens an out file at shipping.

Version:

$Revision: 6416 $

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 org.extex.typesetter.type.node.AbstractNode

NO_CHARS

Constructor Summary

WhatsItOpenNode(java.lang.String theKey, OutFile outFile, java.lang.String encoding, TokenStreamFactory factory)
Creates a new object.

Method Summary

Node

atShipping(PageContext context, Typesetter typesetter, FixedDimen posX, FixedDimen posY) This method performs any action which are required to executed at the time of shipping the node to the DocumentWriter. It is a NOOP in the abstract base class and should be overwritten by sub-classes if required.

Methods inherited from class org.extex.typesetter.type.node.WhatsItNode

toString, visit

Methods inherited from class org.extex.typesetter.type.node.AbstractNode

addDepthTo, addHeightTo, addWidthTo, advanceNaturalDepth, advanceNaturalHeight, advanceNaturalWidth, clone, computeAdjustment, countChars, getChars, getDepth, getHeight, getLocalizer, getNaturalDepth, getNaturalHeight, getNaturalWidth, getVerticalSize, getWidth, maxDepth, maxHeight, maxWidth, setDepth, setHeight, setWidth, spreadHeight, spreadWidth, toString, toText, toText

Methods inherited from class java.lang.Object

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

WhatsItOpenNode

public WhatsItOpenNode(java.lang.String theKey,
                       OutFile outFile,
                       java.lang.String encoding,
                       TokenStreamFactory factory)

Creates a new object.

Parameters:

theKey - the key of the file to open

outFile - the out file to open

encoding - the proposed encoding if can be null to propose nothing

factory - the token stream factory

Method Detail

atShipping

public Node atShipping(PageContext context,
                       Typesetter typesetter,
                       FixedDimen posX,
                       FixedDimen posY)
                throws GeneralException

This method performs any action which are required to executed at the time of shipping the node to the DocumentWriter. It is a NOOP in the abstract base class and should be overwritten by sub-classes if required.

Specified by:

atShipping in interface Node

Overrides:

atShipping in class AbstractNode

Parameters:

context - the interpreter context encapsulated as page context

typesetter - the typesetter

posX - the horizontal position on the page

posY - the vertical position on the page

Returns:

the node to be used instead of the current one in the output list. If the value is null then the node is deleted. If the value is the node itself then it is preserved.

Throws:

GeneralException - in case of an error

See Also:

AbstractNode.atShipping( org.extex.typesetter.PageContext, org.extex.typesetter.Typesetter, org.extex.core.dimen.FixedDimen, org.extex.core.dimen.FixedDimen)