org.extex.typesetter.type.node
Class CharNode

java.lang.Object
  org.extex.typesetter.type.node.AbstractNode
      org.extex.typesetter.type.node.CharNode

All Implemented Interfaces:

java.io.Serializable, Node

Direct Known Subclasses:

LigatureNode, VirtualCharNode

public class CharNode
extends AbstractNode

This is the Node which carries a single character.

Version:

$Revision: 4739 $

Author:

Gerd Neugebauer, Michael Niedermair

See Also:

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

CharNode(TypesettingContext context, UnicodeChar uc)
Creates a new object.

Method Summary

int	countChars() This method determines the number of characters contained in a node.
UnicodeChar	getCharacter() Getter for character.
CharNode[]	getChars() Getter for the array of characters enclosed in this node.
int	getSpaceFactor() Getter for the space factor.
TypesettingContext	getTypesettingContext() Getter for typesetting context.
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.AbstractNode

addDepthTo, addHeightTo, addWidthTo, advanceNaturalDepth, advanceNaturalHeight, advanceNaturalWidth, atShipping, clone, computeAdjustment, getDepth, getHeight, getLocalizer, getNaturalDepth, getNaturalHeight, getNaturalWidth, getVerticalSize, getWidth, maxDepth, maxHeight, maxWidth, setDepth, setHeight, setWidth, spreadHeight, spreadWidth, toString, 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

CharNode

public CharNode(TypesettingContext context,
                UnicodeChar uc)

Creates a new object.

Parameters:

context - the typesetting context

uc - the Unicode character

Method Detail

countChars

public int countChars()

This method determines the number of characters contained in a node.

Specified by:

countChars in interface Node

Overrides:

countChars in class AbstractNode

Returns:

the number of characters contained

See Also:

Node.countChars()

getCharacter

public UnicodeChar getCharacter()

Getter for character.

Returns:

the character.

getChars

public CharNode[] getChars()

Getter for the array of characters enclosed in this node.

Specified by:

getChars in interface Node

Overrides:

getChars in class AbstractNode

Returns:

the array of characters

See Also:

Node.getChars()

getSpaceFactor

public int getSpaceFactor()

Getter for the space factor.

Returns:

the space factor

getTypesettingContext

public TypesettingContext getTypesettingContext()

Getter for typesetting context.

Returns:

the typesetting context.

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 exhaustive form as it is used in tracing output to the log file.

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 of the nodes to display

depth - the depth of the nodes to display

See Also:

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

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

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)