org.extex.unit.tex.typesetter.box
Class Vrule

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.unit.tex.typesetter.box.Vrule

All Implemented Interfaces:

java.io.Serializable, BoxOrRule, RuleConvertible, Code

public class Vrule
extends AbstractCode
implements RuleConvertible

This class provides an implementation for the primitive \vrule.

The Primitive \vrule

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

Syntax

The formal description of this primitive is the following:

    ⟨vrule⟩
        → \vrule⟨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

    \vrule  

    \vrule height 2pt  

    \vrule width 2pt depth 3mm height \dimen4  

Version:

$Revision:4431 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

Field Summary

protected static long

serialVersionUID The constant serialVersionUID contains the id for serialization.

Constructor Summary

Vrule(CodeToken token)
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. 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.
RuleNode	getRule(Context context, TokenSource source, Typesetter typesetter) Getter for the content as Rule.

Methods inherited from class org.extex.interpreter.type.AbstractCode

getLocalizer, getName, getToken, isIf, isOuter, readResolve, toString, toText, toText

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

Vrule

public Vrule(CodeToken token)

Creates a new object.

Parameters:

token - the initial token for the primitive

Method Detail

execute

public void execute(Flags prefix,
                    Context context,
                    TokenSource source,
                    Typesetter typesetter)
             throws HelpingException,
                    TypesetterException

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:

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

See Also:

AbstractCode.execute( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

getRule

public RuleNode getRule(Context context,
                        TokenSource source,
                        Typesetter typesetter)
                 throws HelpingException,
                        TypesetterException

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:

ConfigurationException - in case of an configuration error

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

See Also:

RuleConvertible.getRule( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)