org.extex.typesetter.type.node
Class AbstractExpandableNode

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

All Implemented Interfaces:

java.io.Serializable, Node, OrientedNode

Direct Known Subclasses:

AbstractLeadersNode, GlueNode

public abstract class AbstractExpandableNode
extends AbstractNode
implements OrientedNode

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:

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

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

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

Method Summary

void	addDepthTo(WideGlue glue) Add the flexible depth of the current node to the given glue.
void	addHeightTo(WideGlue glue) Add the flexible height of the current node to the given glue.
void	addWidthTo(WideGlue glue) Add the flexible width of the current node to the given glue.
FixedGlue	getSize() Getter for size.
boolean	isHorizontal() Getter for horizontal.
void	setSize(FixedGlue skip) Setter for the size
void	spreadHeight(FixedDimen height, FixedGlueComponent sum) Adjust the height of a flexible node.
void	spreadWidth(FixedDimen width, FixedGlueComponent sum) Adjust the width of the flexible node.

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, toString, toText, 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

atShipping, countChars, getChars, getDepth, getHeight, getNaturalDepth, getNaturalHeight, getNaturalWidth, getVerticalSize, getWidth, setDepth, setHeight, setWidth, toString, toText, visit

Field Detail

serialVersionUID

protected static final long serialVersionUID

The constant serialVersionUID contains the id for serialization.

See Also:

Constant Field Values

Constructor Detail

AbstractExpandableNode

public AbstractExpandableNode(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

AbstractExpandableNode

public AbstractExpandableNode(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

addDepthTo

public void addDepthTo(WideGlue glue)

Add the flexible depth of the current node to the given glue.

Specified by:

addDepthTo in interface Node

Overrides:

addDepthTo in class AbstractNode

Parameters:

glue - the glue to add to.

See Also:

Node.addDepthTo( org.extex.core.glue.WideGlue)

addHeightTo

public void addHeightTo(WideGlue glue)

Add the flexible height of the current node to the given glue.

Specified by:

addHeightTo in interface Node

Overrides:

addHeightTo in class AbstractNode

Parameters:

glue - the glue to add to.

See Also:

Node.addHeightTo( org.extex.core.glue.WideGlue)

addWidthTo

public void addWidthTo(WideGlue glue)

Add the flexible width of the current node to the given glue.

Specified by:

addWidthTo in interface Node

Overrides:

addWidthTo in class AbstractNode

Parameters:

glue - the glue to add to.

See Also:

Node.addWidthTo( org.extex.core.glue.WideGlue)

getSize

public FixedGlue getSize()

Getter for size.

Returns:

the size

isHorizontal

public boolean isHorizontal()

Getter for horizontal.

Specified by:

isHorizontal in interface OrientedNode

Returns:

the horizontal

setSize

public void setSize(FixedGlue skip)

Setter for the size

Parameters:

skip - the new value

spreadHeight

public void spreadHeight(FixedDimen height,
                         FixedGlueComponent sum)

Adjust the height of a flexible node.

Specified by:

spreadHeight in interface Node

Overrides:

spreadHeight in class AbstractNode

Parameters:

height - the desired height

sum - the total sum of the glues

See Also:

AbstractNode.spreadHeight( org.extex.core.dimen.FixedDimen, FixedGlueComponent)

spreadWidth

public void spreadWidth(FixedDimen width,
                        FixedGlueComponent sum)

Adjust the width of the flexible node.

Specified by:

spreadWidth in interface Node

Overrides:

spreadWidth in class AbstractNode

Parameters:

width - the desired with

sum - the total sum of the glues

See Also:

Node.spreadWidth( org.extex.core.dimen.FixedDimen, org.extex.core.glue.FixedGlueComponent)