org.extex.typesetter
Class Mode

java.lang.Object
  org.extex.typesetter.Mode

public abstract class Mode
extends java.lang.Object

This class provides type-safe constants for the modes of a typesetter.

Version:

$Revision$

Author:

Gerd Neugebauer

Field Summary

static Mode	DISPLAYMATH The constant DISPLAYMATH contains the display math mode of the typesetter.
static Mode	HORIZONTAL The constant HORIZONTAL contains the horizontal mode of the typesetter.
static Mode	INNER_VERTICAL The constant INNER_VERTICAL contains the inner vertical mode of the typesetter.
static Mode	MATH The constant MATH contains the math mode of the typesetter.
static Mode	RESTRICTED_HORIZONTAL The constant RESTRICTED_HORIZONTAL contains the restricted horizontal mode of the typesetter.
static Mode	VERTICAL The constant VERTICAL contains the vertical mode of the typesetter.

Constructor Summary

protected

Mode(java.lang.String theTag) Creates a new object.

Method Summary

protected Localizer	getLocalizer() Getter for localizer.
boolean	isHmode() Check for a horizontal mode.
boolean	isMath() Check for a math mode.
boolean	isVmode() Check for a vertical mode.
java.lang.String	toString() Getter for the string representation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DISPLAYMATH

public static final Mode DISPLAYMATH

The constant DISPLAYMATH contains the display math mode of the typesetter.

HORIZONTAL

public static final Mode HORIZONTAL

The constant HORIZONTAL contains the horizontal mode of the typesetter.

INNER_VERTICAL

public static final Mode INNER_VERTICAL

The constant INNER_VERTICAL contains the inner vertical mode of the typesetter.

MATH

public static final Mode MATH

The constant MATH contains the math mode of the typesetter.

RESTRICTED_HORIZONTAL

public static final Mode RESTRICTED_HORIZONTAL

The constant RESTRICTED_HORIZONTAL contains the restricted horizontal mode of the typesetter.

VERTICAL

public static final Mode VERTICAL

The constant VERTICAL contains the vertical mode of the typesetter.

Constructor Detail

Mode

protected Mode(java.lang.String theTag)

Creates a new object.

This constructor is private since only a limited number of modes should be usable. Those are provided by the static constants in this class.

Parameters:

theTag - the tag of the mode

Method Detail

getLocalizer

protected Localizer getLocalizer()

Getter for localizer.

Returns:

the localizer.

isHmode

public boolean isHmode()

Check for a horizontal mode.

Returns:

true iff the mode is one of the horizontal modes

isMath

public boolean isMath()

Check for a math mode.

Returns:

true iff the mode is one of the math modes

isVmode

public boolean isVmode()

Check for a vertical mode.

Returns:

true iff the mode is one of the vertical modes

toString

public java.lang.String toString()

Getter for the string representation.

Overrides:

toString in class java.lang.Object

Returns:

the string representation