org.extex.unit.tex.hyphen
Class Hyphen

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.unit.tex.hyphen.Hyphen

All Implemented Interfaces:

java.io.Serializable, Code

public class Hyphen
extends AbstractCode

This class provides an implementation for the primitive \-.

The Primitive \-

The primitive \- inserts a soft hyphenation into the current list. The effect is that the current position is considered as point to insert a hyphenation mark and break the line here.

TeX has another mechanism for describing conditional text insertions when line breaking appears at a certain place. Those are associated with the primitive \discretionary. In this context the primitive \- is an abbreviation for \discretionary{-}{}{}.

Syntax

The formal description of this primitive is the following:

    ⟨hyphen⟩
       → \-  

Examples

    abc\-def  

Version:

$Revision: 4732 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

Field Summary

protected static long

serialVersionUID The constant serialVersionUID contains the id for serialization.

Constructor Summary

Hyphen(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

Hyphen

public Hyphen(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)