de.dante.extex.interpreter.primitives.hyphen
Class Hyphen

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.primitives.hyphen.Hyphen
All Implemented Interfaces:
Code, Localizable, java.io.Serializable

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: 1.8 $
Author:
Gerd Neugebauer
See Also:
Serialized Form

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Hyphen(java.lang.String name)
          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.
 
Methods inherited from class de.dante.extex.interpreter.type.AbstractCode
enableLocalization, getLocalizer, getName, isIf, isOuter, printable, printableControlSequence, readResolve, setName, toString
 
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(java.lang.String name)
Creates a new object.

Parameters:
name - the name for tracing and debugging
Method Detail

execute

public void execute(Flags prefix,
                    Context context,
                    TokenSource source,
                    Typesetter typesetter)
             throws InterpreterException
Description copied from interface: Code
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
Throws:
InterpreterException
See Also:
Code.execute( de.dante.extex.interpreter.Flags, de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)