de.dante.extex.interpreter.primitives.typesetter.box
Class Hrule

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.primitives.typesetter.box.Hrule
All Implemented Interfaces:
BoxOrRule, Code, Localizable, RuleConvertible, java.io.Serializable

public class Hrule
extends AbstractCode
implements RuleConvertible

This class provides an implementation for the primitive \hrule.

The Primitive \hrule

This primitive produces a horizontal rule. This is a rectangular area of specified dimensions. If not overwritten the width and depth are 0pt and the height is 0.4 pt (26214 sp).

Syntax

The formal description of this primitive is the following:
    ⟨hrule⟩
        → \hrule ⟨rule specification⟩

    ⟨rule specification⟩
        → ⟨optional spaces⟩
         |  ⟨rule dimension⟩ ⟨rule specification⟩

    ⟨rule dimension⟩
        → width ⟨dimen⟩
         |  height ⟨dimen⟩
         |  depth ⟨dimen⟩   

The color from the typographic context is taken as foreground color for the rule. The default color is black.

Examples

    \hrule  
    \hrule width 2pt  
    \hrule width 2pt depth 3mm height \dimen4  

Version:
$Revision: 1.16 $
Author:
Gerd Neugebauer
See Also:
Serialized Form

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Hrule(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.
 RuleNode getRule(Context context, TokenSource source, Typesetter typesetter)
          Getter for the content as Rule.
 
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

Hrule

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

Parameters:
name - the name for debugging
Method Detail

execute

public void execute(Flags prefix,
                    Context context,
                    TokenSource source,
                    Typesetter typesetter)
             throws InterpreterException
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
Parameters:
prefix - the prefix controlling the execution
context - the interpreter context
source - the token source
typesetter - the typesetter
Throws:
InterpreterException - in case of an error
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), "TeX – The Program [463]"

getRule

public RuleNode getRule(Context context,
                        TokenSource source,
                        Typesetter typesetter)
                 throws InterpreterException
Description copied from interface: RuleConvertible
Getter for the content as Rule.

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