org.extex.core.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: 4726 $
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 for 0pt plus 1fil minus 1fil.
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 different from a given one.
 java.lang.String toString()
          Provide a string representation of this instance.
 

Field Detail

NORMAL_ORDER

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

See Also:
Constant Field Values

ZERO

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


S_S

static final FixedGlue S_S
The constant SS contains the glue for 0pt plus 1fil minus 1fil.

Method Detail

copy

Glue copy()
Make a copy of this object.

Returns:
a new instance with the same internal values

eq

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

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

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

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

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

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

toString

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

Overrides:
toString in class java.lang.Object
Returns:
the string representation of this glue
See Also:
"TeX – The Program [178,177]"