org.extex.typesetter.type.node
Class RuleNode

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

All Implemented Interfaces:

java.io.Serializable, Node, OrientedNode

public class RuleNode
extends AbstractNode
implements OrientedNode

The rule node represents a rectangular area on the page filled with some color.

Version:

$Revision: 4739 $

Author:

Gerd Neugebauer, Michael Niedermair

See Also:

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

RuleNode(FixedDimen width, FixedDimen height, FixedDimen depth, TypesettingContext theContext, boolean horizontal)
Creates a new object.

Method Summary

TypesettingContext	getTypesettingContext() Getter for the typesetting context.
boolean	isHorizontal() Getter for horizontal.
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, countChars, getChars, 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

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

RuleNode

public RuleNode(FixedDimen width,
                FixedDimen height,
                FixedDimen depth,
                TypesettingContext theContext,
                boolean horizontal)

Creates a new object.

Parameters:

width - the width of the rule

height - the height of the rule

depth - the depth of the rule

theContext - the typesetting context

horizontal - the indicator that this is a horizontal rule; otherwise it is a vertical rule

See Also:

"TeX – The Program [139]"

Method Detail

getTypesettingContext

public TypesettingContext getTypesettingContext()

Getter for the typesetting context.

Returns:

the typesetting context.

isHorizontal

public boolean isHorizontal()

Getter for horizontal.

Specified by:

isHorizontal in interface OrientedNode

Returns:

the horizontal

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

depth - the depth

See Also:

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