|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.extex.interpreter.type.AbstractCode
org.extex.interpreter.type.AbstractAssignment
org.extex.unit.tex.register.box.Ht
public class Ht
This class provides an implementation for the primitive
The primitive \ht refers to the height of a box register. It can
be used in various contexts.
The formal description of this primitive is the following:
\ht
.
The Primitive \ht
〈ht〉
→ \ht 〈box register name〉 〈equals〉 〈dimen〉
\ht42
\advance\dimen12 \ht0 \ht12=123pt
Field Summary | |
---|---|
protected static long |
serialVersionUID
The constant serialVersionUID contains the id for serialization. |
Constructor Summary | |
---|---|
Ht(CodeToken token)
Creates a new object. |
Method Summary | |
---|---|
void |
assign(Flags prefix,
Context context,
TokenSource source,
Typesetter typesetter)
The method assign is the core of the functionality of execute() . |
long |
convertCount(Context context,
TokenSource source,
Typesetter typesetter)
This method converts a register into a count. |
long |
convertDimen(Context context,
TokenSource source,
Typesetter typesetter)
This method converts a register into a dimen. |
void |
expand(Flags prefix,
Context context,
TokenSource source,
Typesetter typesetter)
This method takes the first token and expands it. |
Tokens |
the(Context context,
TokenSource source,
Typesetter typesetter)
This method is the getter for the description of the primitive. |
Methods inherited from class org.extex.interpreter.type.AbstractAssignment |
---|
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 |
---|
protected static final long serialVersionUID
Constructor Detail |
---|
public Ht(CodeToken token)
token
- the initial token for the primitiveMethod Detail |
---|
public void assign(Flags prefix, Context context, TokenSource source, Typesetter typesetter) throws HelpingException, TypesetterException
execute()
.
This method is preferable to execute() since the
execute() method provided in this class takes care of
\afterassignment and \globaldefs as well.
assign
in class AbstractAssignment
prefix
- the prefix controlling the executioncontext
- the interpreter contextsource
- the token sourcetypesetter
- the typesetter
HelpingException
- in case of an error
TypesetterException
- in case of an error in the typesetterAbstractAssignment.assign(
org.extex.interpreter.Flags, org.extex.interpreter.context.Context,
org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)
public long convertCount(Context context, TokenSource source, Typesetter typesetter) throws HelpingException, TypesetterException
convertCount
in interface CountConvertible
context
- the interpreter contextsource
- the source for new tokenstypesetter
- the typesetter to use for conversion
HelpingException
- in case of an error
TypesetterException
- in case of an error in the typesetterCountConvertible.convertCount(
org.extex.interpreter.context.Context,
org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)
public long convertDimen(Context context, TokenSource source, Typesetter typesetter) throws HelpingException, TypesetterException
convertDimen
in interface DimenConvertible
context
- the interpreter contextsource
- the source for new tokenstypesetter
- the typesetter to use for conversion
HelpingException
- in case of an error
TypesetterException
- in case of an error in the typesetterDimenConvertible.convertDimen(
org.extex.interpreter.context.Context,
org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)
public void expand(Flags prefix, Context context, TokenSource source, Typesetter typesetter) throws HelpingException, TypesetterException
expand
in interface ExpandableCode
prefix
- the prefix flags controlling the expansioncontext
- the interpreter contextsource
- the token sourcetypesetter
- the typesetter
HelpingException
- in case of an error
TypesetterException
- in case of an error in the typesetterExpandableCode.expand(
org.extex.interpreter.Flags, org.extex.interpreter.context.Context,
org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)
public Tokens the(Context context, TokenSource source, Typesetter typesetter) throws HelpingException, TypesetterException
the
in interface Theable
context
- the interpreter contextsource
- the source for further tokens to qualify the requesttypesetter
- the typesetter to use
HelpingException
- in case of an error
TypesetterException
- in case of an errorTheable.the(
org.extex.interpreter.context.Context,
org.extex.interpreter.TokenSource, Typesetter)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |