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

java.lang.Object
  extended by org.extex.interpreter.type.AbstractCode
      extended by org.extex.unit.tex.typesetter.box.AbstractBoxPrimitive
          extended by org.extex.unit.tex.typesetter.box.Hbox
All Implemented Interfaces:
java.io.Serializable, Boxable, BoxOrRule, Code

public class Hbox
extends AbstractBoxPrimitive

This class provides an implementation for the primitive \hbox.

The Primitive \hbox

The primitive \hbox takes arguments enclosed in braces and typesets this contents in horizontal mode. If a width is given then the horizontal box is spread to this width. Otherwise the horizontal box has the natural width of its contents.

The contents of the tokens register \everyhbox is inserted at the beginning of the horizontal material of the box.

Syntax

The formal description of this primitive is the following:
    ⟨hbox⟩
      → \hbox ⟨box specification⟩ { ⟨horizontal material⟩ }

    ⟨box specification⟩
      →
       |  to ⟨rule dimension⟩
       |  spread ⟨rule dimension⟩  

Examples

    \hbox{abc}  
    \hbox to 120pt{abc}  
    \hbox spread 12pt{abc}  

The Tokens Parameter \everyhbox

The tokens parameter is used in /hbox. The tokens contained are inserted at the beginning of the horizontal material of the horizontal box.

Syntax

The formal description of this primitive is the following:
    ⟨everyhbox⟩
      → \everyhbox ⟨equals⟩ ⟨tokens⟩  

Examples

    \everyhbox{\message{Hi there}}  

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
Hbox(CodeToken token)
          Creates a new object.
 
Method Summary
 Box getBox(Context context, TokenSource source, Typesetter typesetter, Token insert)
          Getter for the content as Box.
 
Methods inherited from class org.extex.unit.tex.typesetter.box.AbstractBoxPrimitive
execute
 
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

Hbox

public Hbox(CodeToken token)
Creates a new object.

Parameters:
token - the initial token for the primitive
Method Detail

getBox

public Box getBox(Context context,
                  TokenSource source,
                  Typesetter typesetter,
                  Token insert)
           throws HelpingException,
                  TypesetterException
Getter for the content as Box.

Parameters:
context - the interpreter context
source - the source for new tokens
typesetter - the typesetter to use
insert - the token to insert either at the beginning of the box or after the box has been gathered. If it is null then nothing is inserted
Returns:
an appropriate Box
Throws:
HelpingException - in case of an error
TypesetterException - in case of an error in the typesetter
See Also:
Boxable.getBox( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter, org.extex.scanner.type.token.Token)