org.extex.core.dimen
Interface FixedDimen

All Known Implementing Classes:
Dimen, DimenConstant

public interface FixedDimen

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

Version:
$Revision: 4399 $
Author:
Gerd Neugebauer

Method Summary
 FixedDimen copy()
          Create a copy of this instance with the same order and value.
 boolean eq(FixedDimen d)
          Compares the current instance with another GlueComponent for equality.
 boolean ge(FixedDimen d)
          Compares the current instance with another GlueComponent.
 long getValue()
          Getter for the value in scaled points (sp).
 boolean gt(FixedDimen d)
          Compares the current instance with another GlueComponent.
 boolean le(FixedDimen d)
          Compares the current instance with another GlueComponent.
 boolean lt(FixedDimen d)
          Compares the current instance with another GlueComponent.
 boolean ne(FixedDimen d)
          Compares the current instance with another GlueComponent for equality.
 java.lang.String toString()
          Determine the printable representation of the object.
 void toString(java.lang.StringBuffer sb)
          Determine the printable representation of the object and append it to the given StringBuffer.
 

Method Detail

copy

FixedDimen copy()
Create a copy of this instance with the same order and value.

Returns:
a new copy of this instance

eq

boolean eq(FixedDimen d)
Compares the current instance with another GlueComponent for equality.

Parameters:
d - the other GlueComponent to compare to. If this parameter is null then the comparison fails.
Returns:
true iff |this| == |d|

ge

boolean ge(FixedDimen d)
Compares the current instance with another GlueComponent.

Parameters:
d - the other GlueComponent to compare to
Returns:
true iff this is greater or equal to d

getValue

long getValue()
Getter for the value in scaled points (sp).

Returns:
the value in internal units of scaled points (sp)

gt

boolean gt(FixedDimen d)
Compares the current instance with another GlueComponent.

Parameters:
d - the other GlueComponent to compare to
Returns:
true iff |this| > |d|

le

boolean le(FixedDimen d)
Compares the current instance with another GlueComponent.

Parameters:
d - the other GlueComponent to compare to
Returns:
true iff this is less or equal to d

lt

boolean lt(FixedDimen d)
Compares the current instance with another GlueComponent.

Parameters:
d - the other GlueComponent to compare to
Returns:
true iff |this| < |d|

ne

boolean ne(FixedDimen d)
Compares the current instance with another GlueComponent for equality.

Parameters:
d - the other GlueComponent to compare to. If this parameter is null then the comparison fails.
Returns:
false iff |this| == |d|

toString

java.lang.String toString()
Determine the printable representation of the object.

Overrides:
toString in class java.lang.Object
Returns:
the printable representation
See Also:
toString(StringBuffer)

toString

void toString(java.lang.StringBuffer sb)
Determine the printable representation of the object and append it to the given StringBuffer.

Parameters:
sb - the output string buffer
See Also:
toString()