de.dante.extex.interpreter.primitives.conditional
Class Ifhmode

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.primitives.conditional.AbstractIf
          extended byde.dante.extex.interpreter.primitives.conditional.Ifhmode
All Implemented Interfaces:
Code, ExpandableCode, Localizable, java.io.Serializable

public class Ifhmode
extends AbstractIf

This class provides an implementation for the primitive \ifhmode.

The Primitive \ifhmode

The primitive does not take any further arguments. The conditional is true iff the typesetter is in a horizontal mode. This is either the restricted horizontal vertical mode or the horizontal mode.

Syntax

The formal description of this primitive is the following:
    ⟨ifhmode⟩
      → \ifhmode ⟨true text⟩ \fi
      | \ifhmode ⟨true text⟩ \else ⟨false text⟩ \fi 

Examples

    \ifhmode abc \fi  

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

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Ifhmode(java.lang.String name)
          Creates a new object.
 
Method Summary
protected  boolean conditional(Context context, TokenSource source, Typesetter typesetter)
          This method computes the boolean value of the conditional.
 
Methods inherited from class de.dante.extex.interpreter.primitives.conditional.AbstractIf
execute, expand, getMyLocalizer, isIf, skipToElseOrFi
 
Methods inherited from class de.dante.extex.interpreter.type.AbstractCode
enableLocalization, getLocalizer, getName, 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

Ifhmode

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

Parameters:
name - the name for debugging
Method Detail

conditional

protected boolean conditional(Context context,
                              TokenSource source,
                              Typesetter typesetter)
Description copied from class: AbstractIf
This method computes the boolean value of the conditional. If the result is true then the then branch is expanded and the else branch is skipped. Otherwise the then branch is skipped and the else branch is expanded.

Specified by:
conditional in class AbstractIf
Parameters:
context - the interpreter context
source - the source for new tokens
typesetter - the typesetter
Returns:
the boolean value
See Also:
AbstractIf.conditional( de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)