de.dante.extex.interpreter.type.glue
Interface FixedGlue

All Known Implementing Classes:
Glue

public interface FixedGlue

This interface describes the features of a Glue which do not modify the value.

Version:
$Revision: 1.12 $
Author:
Gerd Neugebauer

Field Summary
static int NORMAL_ORDER
          The constant NORMAL_ORDER contains the value for the normal – immutable – order.
static FixedGlue S_S
          The constant SS contains the glue to insert for this primitive.
static FixedGlue ZERO
          The constant ZERO contains the value of width 0pt without any stretchablity or shrinkability.
 
Method Summary
 Glue copy()
          Make a copy of this object.
 boolean eq(FixedGlue glue)
          Test that the given Glue is equal to a given one.
 FixedDimen getLength()
          Getter for the length.
 FixedGlueComponent getShrink()
          Getter for shrink.
 FixedGlueComponent getStretch()
          Getter for stretch.
 boolean ne(FixedGlue glue)
          Test that the given Glue is differnt from a given one.
 java.lang.String toString()
          Provide a string representation of this instance.
 Tokens toToks(TokenFactory factory)
          Determine the printable representation of the object and return it as a list of Tokens.
 

Field Detail

NORMAL_ORDER

public static final int NORMAL_ORDER
The constant NORMAL_ORDER contains the value for the normal – immutable – order.

See Also:
Constant Field Values

ZERO

public static final FixedGlue ZERO
The constant ZERO contains the value of width 0pt without any stretchablity or shrinkability.


S_S

public static final FixedGlue S_S
The constant SS contains the glue to insert for this primitive.

Method Detail

copy

public Glue copy()
Make a copy of this object.

Returns:
a new instance with the same internal values

eq

public boolean eq(FixedGlue glue)
Test that the given Glue is equal to a given one.

Parameters:
glue - the glue to compare with
Returns:
true iff they are different

getLength

public FixedDimen getLength()
Getter for the length. Note that the value returned is independent from the original object. Changing its value does not affect the length of the glue.

Returns:
the natural length

getShrink

public FixedGlueComponent getShrink()
Getter for shrink. Note that the value returned is independent from the original object. Changing its value does not affect the shrink of the glue.

Returns:
the shrink.

getStretch

public FixedGlueComponent getStretch()
Getter for stretch. Note that the value returned is independent from the original object. Changing its value does not affect the stretch of the glue.

Returns:
the stretch.

ne

public boolean ne(FixedGlue glue)
Test that the given Glue is differnt from a given one.

Parameters:
glue - the glue to compare with
Returns:
true iff they are different

toString

public java.lang.String toString()
Provide a string representation of this instance.

Returns:
the string representation of this glue
See Also:
"TeX – The Program [178,177]"

toToks

public Tokens toToks(TokenFactory factory)
              throws GeneralException
Determine the printable representation of the object and return it as a list of Tokens.

Parameters:
factory - the token factory ton get new tokens from
Returns:
the string representation of this glue
Throws:
GeneralException - in case of an error
See Also:
"TeX – The Program [178,177]"