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

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.primitives.hyphen.AbstractHyphenationCode
          extended byde.dante.extex.interpreter.primitives.hyphen.LeftHyphenmin
All Implemented Interfaces:
Advanceable, Code, CountConvertible, DimenConvertible, Divideable, Localizable, Multiplyable, java.io.Serializable, Theable

public class LeftHyphenmin
extends AbstractHyphenationCode
implements CountConvertible, DimenConvertible, Advanceable, Multiplyable, Divideable, Theable

This class provides an implementation for the primitive \lefthyphenmin.

The Primitive \lefthyphenmin

TODO missing documentation

Syntax

    ⟨lefthyphenmin⟩
      → \lefthyphenmin ⟨equals⟩ ⟨number⟩  

Example:

   \lefthyphenmin=3 
The value are stored in the HyphernationTable. Each HyphernationTable are based on \language and have its own \lefthyphenmin value (different to original TeX).

Version:
$Revision: 1.26 $
Author:
Gerd Neugebauer, Michael Niedermair
See Also:
Serialized Form

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
LeftHyphenmin(java.lang.String name)
          Creates a new object.
 
Method Summary
 void advance(Flags prefix, Context context, TokenSource source, Typesetter typesetter)
          This method is called when the macro \advance has been seen.
 long convertCount(Context context, TokenSource source, Typesetter typesetter)
          This method converts a register into a count.
 long convertDimen(Context context, TokenSource source, Typesetter typesetter)
          This method converts a register into a dimen.
 void divide(Flags prefix, Context context, TokenSource source, Typesetter typesetter)
          This method is called when the macro \divide has been seen.
 void execute(Flags prefix, Context context, TokenSource source, Typesetter typesetter)
          Scan for lefthyphenmin value and store it in the HyphernationTable with the language-number.
 void multiply(Flags prefix, Context context, TokenSource source, Typesetter typesetter)
          This method is called when the macro \multiply has been seen.
 Tokens the(Context context, TokenSource source, Typesetter typesetter)
          Return the Tokens to show the content with \the.
 
Methods inherited from class de.dante.extex.interpreter.primitives.hyphen.AbstractHyphenationCode
getHyphenationTable
 
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

LeftHyphenmin

public LeftHyphenmin(java.lang.String name)
Creates a new object.

Parameters:
name - the name for debugging
Method Detail

advance

public void advance(Flags prefix,
                    Context context,
                    TokenSource source,
                    Typesetter typesetter)
             throws InterpreterException
Description copied from interface: Advanceable
This method is called when the macro \advance has been seen. It performs the remaining tasks for the expansion.

Specified by:
advance in interface Advanceable
Parameters:
prefix - the prefix for the command
context - the processor context
source - the token source to parse
typesetter - the typesetter
Throws:
InterpreterException - in case of an error
See Also:
Advanceable.advance( de.dante.extex.interpreter.Flags, de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)

convertCount

public long convertCount(Context context,
                         TokenSource source,
                         Typesetter typesetter)
                  throws InterpreterException
Description copied from interface: CountConvertible
This method converts a register into a count. It might be necessary to read further tokens to determine which value to use. For instance an additional register number might be required. In this case the additional arguments Context and TokenSource can be used.

Specified by:
convertCount in interface CountConvertible
Parameters:
context - the interpreter context
source - the source for new tokens
typesetter - the typesetter to use for conversion
Returns:
the converted value
Throws:
InterpreterException - in case of an error
See Also:
CountConvertible.convertCount( de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)

convertDimen

public long convertDimen(Context context,
                         TokenSource source,
                         Typesetter typesetter)
                  throws InterpreterException
Description copied from interface: DimenConvertible
This method converts a register into a dimen. It might be necessary to read further tokens to determine which value to use. For instance an additional register number might be required. In this case the additional arguments Context and TokenSource can be used. The return value is the length in scaled points.

Specified by:
convertDimen in interface DimenConvertible
Parameters:
context - the interpreter context
source - the source for new tokens
typesetter - the typesetter to use for conversion
Returns:
the converted value in sp
Throws:
InterpreterException - in case of an error
See Also:
DimenConvertible.convertDimen( de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)

divide

public void divide(Flags prefix,
                   Context context,
                   TokenSource source,
                   Typesetter typesetter)
            throws InterpreterException
Description copied from interface: Divideable
This method is called when the macro \divide has been seen. It performs the remaining tasks for the expansion.

Specified by:
divide in interface Divideable
Parameters:
prefix - the prefix for the command
context - the processor context
source - the token source to parse
typesetter - the typesetter
Throws:
InterpreterException - in case of an error
See Also:
Divideable.divide( de.dante.extex.interpreter.Flags, de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)

execute

public void execute(Flags prefix,
                    Context context,
                    TokenSource source,
                    Typesetter typesetter)
             throws InterpreterException
Scan for lefthyphenmin value and store it in the HyphernationTable with the language-number.

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)

multiply

public void multiply(Flags prefix,
                     Context context,
                     TokenSource source,
                     Typesetter typesetter)
              throws InterpreterException
Description copied from interface: Multiplyable
This method is called when the macro \multiply has been seen. It performs the remaining tasks for the expansion.

Specified by:
multiply in interface Multiplyable
Parameters:
prefix - the prefix for the command
context - the processor context
source - the token source to parse
typesetter - the typesetter
Throws:
InterpreterException - in case of an error
See Also:
Multiplyable.multiply( de.dante.extex.interpreter.Flags, de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)

the

public Tokens the(Context context,
                  TokenSource source,
                  Typesetter typesetter)
           throws InterpreterException
Return the Tokens to show the content with \the.

Specified by:
the in interface Theable
Parameters:
context - the interpreter context
source - the source for further tokens to qualify the request
typesetter - the typesetter to use
Returns:
the description of the primitive as list of Tokens
Throws:
InterpreterException - in case of an error
See Also:
Theable.the( de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, Typesetter)