de.dante.extex.typesetter.paragraphBuilder.impl
Class ParagraphBuilderImpl

java.lang.Object
  extended byde.dante.extex.typesetter.paragraphBuilder.impl.ParagraphBuilderImpl
All Implemented Interfaces:
LogEnabled, ParagraphBuilder

public class ParagraphBuilderImpl
extends java.lang.Object
implements ParagraphBuilder, LogEnabled

This class provides a paragraph builder.

The Parameter \emergencystretch

TODO missing documentation

The Parameter \exhyphenpenalty

TODO missing documentation

The Parameter \hangafter

TODO missing documentation

The Parameter \hangindent

TODO missing documentation

The Parameter \hsize

The parameter \hsize contains the horizontal size of the paragraph to be build. See also \parshape, \hangindent, and \hangafter.

The Parameter \hyphenpenalty

The parameter \hyphenpenalty contains the penalty inserted whenever a hyphenation is applied. Thus paragraphs with less hyphenations are preferred over those with more hyphenations.

The Parameter \leftskip

The parameter \leftskip contains the glue which is inserted at the left side of each line in the paragraph. The default is 0 pt.

This parameter can be used to flash the line to the left side or center the line. Those effects can be achieved in combination with the parameter \rightskip.

The Parameter \parfillskip

The parameter \parfillskip contains the glue which is added at the end of each paragraph.

The Parameter \parskip

The parameter \parskip contains the glue which is added to the vertical list before the beginnng of each paragraph.

The Parameter \pretolerance

TODO missing documentation

The Parameter \rightskip

The parameter \rightskip contains the glue which is inserted at the right side of each line in the paragraph. The defult is 0 pt.

This parameter can be used to flash the line to the right side or center the line. Those effects can be achieved in combination with the parameter \leftskip.

The Parameter \tolerance

TODO missing documentation

The Parameter \tracingparagraphs

TODO missing documentation

Extension

Treat segments of a paragraph separated by forced breaks separately.

Version:
$Revision: 1.35 $
Author:
Gerd Neugebauer

Constructor Summary
ParagraphBuilderImpl()
          Creates a new object.
 
Method Summary
 NodeList build(HorizontalListNode nodes)
          Break a horizontal list into lines.
 void enableLogging(java.util.logging.Logger theLogger)
          Setter for the logger.
 void setNodefactory(NodeFactory factory)
          Setter for the node factory.
 void setOptions(TypesetterOptions options)
          Setter for options.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ParagraphBuilderImpl

public ParagraphBuilderImpl()
Creates a new object.

Method Detail

build

public NodeList build(HorizontalListNode nodes)
               throws HyphenationException
Description copied from interface: ParagraphBuilder
Break a horizontal list into lines. The horizontal list passed in might be modified under way.

Specified by:
build in interface ParagraphBuilder
Parameters:
nodes - the horizontal node list containing all nodes for the paragraph
Returns:
the VerticalListNode containing the hboxes of the lines
Throws:
HyphenationException
See Also:
ParagraphBuilder.build( de.dante.extex.typesetter.type.node.HorizontalListNode)

enableLogging

public void enableLogging(java.util.logging.Logger theLogger)
Description copied from interface: LogEnabled
Setter for the logger.

Specified by:
enableLogging in interface LogEnabled
Parameters:
theLogger - the logger to use
See Also:
LogEnabled.enableLogging( java.util.logging.Logger)

setNodefactory

public void setNodefactory(NodeFactory factory)
Description copied from interface: ParagraphBuilder
Setter for the node factory.

Specified by:
setNodefactory in interface ParagraphBuilder
Parameters:
factory - the node factory
See Also:
ParagraphBuilder.setNodefactory( de.dante.extex.typesetter.type.node.factory.NodeFactory)

setOptions

public void setOptions(TypesetterOptions options)
Description copied from interface: ParagraphBuilder
Setter for options.

Specified by:
setOptions in interface ParagraphBuilder
Parameters:
options - the options to set.
See Also:
ParagraphBuilder.setOptions( de.dante.extex.typesetter.TypesetterOptions)