org.extex.unit.tex.typesetter.paragraph
Class Par

java.lang.Object
  extended by org.extex.interpreter.type.AbstractCode
      extended by org.extex.unit.tex.typesetter.paragraph.Par
All Implemented Interfaces:
java.io.Serializable, Code

public class Par
extends AbstractCode

This class provides an implementation for the primitive \par.

The Primitive \par

The primitive \par signals the end of a paragraph. If ExTeX is in a horizontal mode then the preceding material is typeset and the paragraph is added to the vertical list. ExTeX goes into a vertical mode afterwards.

If ExTeX is in a vertical mode then this primitive is simply ignored.

The scanner rules of TeX determine that the macro \par is inserted for any number of subsequent empty lines. This means that in a normal text there might be a lot of invocations of \par even if none of them is written explicitly.

Syntax

The formal description of this primitive is the following:
    ⟨par⟩
      → \par  

Examples

    abc \par  def 

The Dimen Parameter \parindent

The dimen parameter \parindent contains indentation to be applied for each paragraph.

Syntax

The formal description of this primitive is the following:
    ⟨parindent⟩
      → \parindent ⟨equals⟩ ⟨dimen⟩  

Examples

    \parindent=12em  

Version:
$Revision:4431 $
Author:
Gerd Neugebauer
See Also:
Serialized Form

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Par(CodeToken token)
          Creates a new object.
 
Method Summary
 void execute(Flags prefix, Context context, TokenSource source, Typesetter typesetter)
          This method takes the first token and executes it. The result is placed on the stack. This operation might have side effects. To execute a token it might be necessary to consume further tokens.
 
Methods inherited from class org.extex.interpreter.type.AbstractCode
getLocalizer, getName, getToken, isIf, isOuter, readResolve, toString, toText, toText
 
Methods inherited from class java.lang.Object
clone, 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

Par

public Par(CodeToken token)
Creates a new object.

Parameters:
token - the initial token for the primitive
Method Detail

execute

public void execute(Flags prefix,
                    Context context,
                    TokenSource source,
                    Typesetter typesetter)
             throws HelpingException,
                    TypesetterException
This method takes the first token and executes it. The result is placed on the stack. This operation might have side effects. To execute a token it might be necessary to consume further tokens.

Specified by:
execute in interface Code
Overrides:
execute in class AbstractCode
Parameters:
prefix - the prefix controlling the execution
context - the interpreter context
source - the token source
typesetter - the typesetter
Throws:
HelpingException - in case of an error
TypesetterException - in case of an error in the typesetter
See Also:
Code.execute( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)