org.extex.typesetter.type.node
Class GlueNode

java.lang.Object
  org.extex.typesetter.type.node.AbstractNode
      org.extex.typesetter.type.node.AbstractExpandableNode
          org.extex.typesetter.type.node.GlueNode

All Implemented Interfaces:

java.io.Serializable, Discardable, Node, SkipNode, OrientedNode

Direct Known Subclasses:

SpaceNode

public class GlueNode
extends AbstractExpandableNode
implements SkipNode, Discardable

This node represents a TeX "glue" node.

For the document writer it acts like a kerning node. The width contains the distance to add.

The stretchability is adjusted by the typesetter and the width is adjusted accordingly.

Version:

$Revision: 4739 $

Author:

Gerd Neugebauer, Michael Niedermair

See Also:

"TeX – The Program [149]", 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

GlueNode(FixedDimen size, boolean horizontal)
Creates a new object.

GlueNode(FixedGlue size, boolean horizontal)
Creates a new object.

Method Summary

void	toString(java.lang.StringBuffer sb, java.lang.String prefix, int breadth, int depth) This method puts the printable representation into the string buffer.
void	toText(java.lang.StringBuffer sb, java.lang.String prefix) This method puts the printable representation into the string buffer.
java.lang.Object	visit(NodeVisitor visitor, java.lang.Object value) This method provides an entry point for the visitor pattern.

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

addDepthTo, addHeightTo, addWidthTo, getSize, isHorizontal, setSize, spreadHeight, spreadWidth

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

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

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.extex.typesetter.type.Node

addDepthTo, addHeightTo, addWidthTo, atShipping, countChars, getChars, getDepth, getHeight, getNaturalDepth, getNaturalHeight, getNaturalWidth, getVerticalSize, getWidth, setDepth, setHeight, setWidth, spreadHeight, spreadWidth

Field Detail

serialVersionUID

protected static final long serialVersionUID

The constant serialVersionUID contains the id for serialization.

See Also:

Constant Field Values

Constructor Detail

GlueNode

public GlueNode(FixedDimen size,
                boolean horizontal)

Creates a new object. The size is used to determine the width in horizontal mode and the height in vertical mode.

Parameters:

size - the actual size

horizontal - indicator that the glue is used in horizontal mode

GlueNode

public GlueNode(FixedGlue size,
                boolean horizontal)

Creates a new object. The size is used to determine the width in horizontal mode and the height in vertical mode.

Parameters:

size - the actual size

horizontal - indicator that the glue is used in horizontal mode

Method Detail

toString

public void toString(java.lang.StringBuffer sb,
                     java.lang.String prefix,
                     int breadth,
                     int depth)

This method puts the printable representation into the string buffer. This is meant to produce a short form only as it is used in error messages to the user.

Specified by:

toString in interface Node

Overrides:

toString in class AbstractNode

Parameters:

sb - the output string buffer

prefix - the prefix string inserted at the beginning of each line

breadth - the breadth (ignored)

depth - the depth (ignored)

See Also:

"TeX – The Program [189]", Node.toString( java.lang.StringBuffer, java.lang.String, int, int)

toText

public void toText(java.lang.StringBuffer sb,
                   java.lang.String prefix)

This method puts the printable representation into the string buffer. This is meant to produce a short form only as it is used in error messages to the user.

Specified by:

toText in interface Node

Overrides:

toText in class AbstractNode

Parameters:

sb - the output string buffer

prefix - the prefix string inserted at the beginning of each line

See Also:

Node.toText(java.lang.StringBuffer, java.lang.String)

visit

public java.lang.Object visit(NodeVisitor visitor,
                              java.lang.Object value)
                       throws GeneralException

This method provides an entry point for the visitor pattern.

Specified by:

visit in interface Node

Parameters:

visitor - the visitor to apply

value - the argument for the visitor

Returns:

the result of the method invocation of the visitor

Throws:

GeneralException - in case of an error

See Also:

Node.visit( org.extex.typesetter.type.NodeVisitor, java.lang.Object)