TypesetterOptions

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

de.dante.extex.typesetter
Interface TypesetterOptions

All Known Implementing Classes:: ContextImpl

public interface TypesetterOptions

This interface describes the possibilities of the typesetter to access its options.

Version:: $Revision: 1.12 $
Author:: Gerd Neugebauer

Method Summary
`FixedCount`	`getCountOption(java.lang.String name)` Getter for a count register.
`FixedDimen`	`getDimenOption(java.lang.String name)` Getter for a dimen register.
`Font`	`getFont(java.lang.String name)` Getter for a current font register.
`FixedGlue`	`getGlueOption(java.lang.String name)` Getter for a glue register.
`UnicodeChar`	`getLccode(UnicodeChar uc)` Getter for the lccode mapping of upper case characters to their lower case equivalent.
`Muskip`	`getMuskip(java.lang.String name)` Getter for a muskip register.
`java.lang.String`	`getNamespace()` Getter for the current name space.
`ParagraphShape`	`getParshape()` Getter fot the paragraph shape.
`TokenFactory`	`getTokenFactory()` Getter for the token factory.
`TypesettingContext`	`getTypesettingContext()` Getter for the typesetting context.
`TypesettingContextFactory`	`getTypesettingContextFactory()` Getter for the typesetting context factory.
`void`	`setCountOption(java.lang.String name, long value)` Setter for a count register.
`void`	`setParshape(ParagraphShape shape)` Setter for the paragraph shape.

Method Detail

getCountOption

public FixedCount getCountOption(java.lang.String name)

Getter for a count register.

Parameters:: name - the name of the register
Returns:: the content of the count register

getDimenOption

public FixedDimen getDimenOption(java.lang.String name)

Getter for a dimen register.

Parameters:: name - the name of the register
Returns:: the content of the dimen register

getFont

public Font getFont(java.lang.String name)

Getter for a current font register.

Parameters:: name - the name or the number of the register
Returns:: the named font register or null if none is set

getGlueOption

public FixedGlue getGlueOption(java.lang.String name)

Getter for a glue register.

Parameters:: name - the name of the register
Returns:: the content of the glue register

getMuskip

public Muskip getMuskip(java.lang.String name)

Getter for a muskip register.

Parameters:: name - the name of the register
Returns:: te muskip register value

getLccode

public UnicodeChar getLccode(UnicodeChar uc)

Getter for the lccode mapping of upper case characters to their lower case equivalent.

Parameters:: uc - the upper case character
Returns:: the lower case equivalent or null if none exists

getNamespace

public java.lang.String getNamespace()

Getter for the current name space.

Returns:: the current namespace

getParshape

public ParagraphShape getParshape()

Getter fot the paragraph shape.

Returns:: the paragraph shape or null if no special shape is present

getTokenFactory

public TokenFactory getTokenFactory()

Getter for the token factory. The token factory can be used to get new tokens of some kind.

Returns:: the token factory

getTypesettingContext

public TypesettingContext getTypesettingContext()

Getter for the typesetting context.

Returns:: the typesetting context

getTypesettingContextFactory

public TypesettingContextFactory getTypesettingContextFactory()

Getter for the typesetting context factory.

Returns:: the typesetting context factory

setParshape

public void setParshape(ParagraphShape shape)

Setter for the paragraph shape.

Parameters:: shape - the new paragraph shape

setCountOption

public void setCountOption(java.lang.String name,
                           long value)
                    throws GeneralException

Setter for a count register.

Parameters:: name - the name of the register; value - the value
Throws:: GeneralException - in case of an error