org.foray.fotree.fo.prop
Class PdSpeechRate

java.lang.Object
  org.foray.fotree.Property
      org.foray.fotree.fo.AbstractFoProperty
          org.foray.fotree.fo.prop.PdSpeechRate

public class PdSpeechRate
extends AbstractFoProperty

The "speech-rate" property in XSL-FO.

See Also:

"XSL-FO Recommendation 1.1, Section 7.7.15."

Field Summary

static short	SPEECH_RATE_FAST The numeric equivalent, in words-per-minute, of "fast".
static short	SPEECH_RATE_MEDIUM The numeric equivalent, in words-per-minute, of "medium".
static short	SPEECH_RATE_RELATIVE_INCREMENT The incremental amount, in words-per-minute, by which relative adjustments should be made.
static short	SPEECH_RATE_SLOW The numeric equivalent, in words-per-minute, of "slow".
static short	SPEECH_RATE_X_FAST The numeric equivalent, in words-per-minute, of "extra-fast".
static short	SPEECH_RATE_X_SLOW The numeric equivalent, in words-per-minute, of "extra-slow".

Fields inherited from class org.foray.fotree.fo.AbstractFoProperty

VALID_KEYWORDS_INHERIT_ONLY

Fields inherited from class org.foray.fotree.Property

PRECEDENCE_FORCE

Constructor Summary

PdSpeechRate(FObj fobj, String propertyFullName, String attributeValue)
Constructor.

Method Summary

FoProperty	getPropertyType() Returns the type of this property.
protected FoValue[]	getValidKeywords() Returns the valid keywords for this property.
double	getValue(org.axsl.fo.FoContext context, FObj fobj) Returns the value of this property.
static double	getValueNoInstance(org.axsl.fo.FoContext context, FObj fobj) Returns the default (initial) value for this property.
PropertyValue	value() Returns the value for this property.

Methods inherited from class org.foray.fotree.fo.AbstractFoProperty

canEvalBorderStyle, canEvalUri, checkKeywords, convertValueToFoValue, evalBorderStyle, evalUri, isKeywordInherit, standardParse, standardParse

Methods inherited from class org.foray.fotree.Property

convertNumericToInteger, convertValueToLength, getBasePropertyName, getKeywordIndex, getKeywordInSet, getSubPropertyName, invalidPropertyName, keywordInSet, unexpectedInitialValueArgument, unexpectedRetrieval, unexpectedValue, unexpectedValue

Methods inherited from class java.lang.Object

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

Field Detail

SPEECH_RATE_X_SLOW

public static final short SPEECH_RATE_X_SLOW

The numeric equivalent, in words-per-minute, of "extra-slow".

See Also:

Constant Field Values

SPEECH_RATE_SLOW

public static final short SPEECH_RATE_SLOW

The numeric equivalent, in words-per-minute, of "slow".

See Also:

Constant Field Values

SPEECH_RATE_MEDIUM

public static final short SPEECH_RATE_MEDIUM

The numeric equivalent, in words-per-minute, of "medium".

See Also:

Constant Field Values

SPEECH_RATE_FAST

public static final short SPEECH_RATE_FAST

The numeric equivalent, in words-per-minute, of "fast".

See Also:

Constant Field Values

SPEECH_RATE_X_FAST

public static final short SPEECH_RATE_X_FAST

The numeric equivalent, in words-per-minute, of "extra-fast".

See Also:

Constant Field Values

SPEECH_RATE_RELATIVE_INCREMENT

public static final short SPEECH_RATE_RELATIVE_INCREMENT

The incremental amount, in words-per-minute, by which relative adjustments should be made.

See Also:

Constant Field Values

Constructor Detail

PdSpeechRate

public PdSpeechRate(FObj fobj,
                    String propertyFullName,
                    String attributeValue)
             throws PropertyException

Constructor.

Parameters:

fobj - The FObj to which this property belongs.

propertyFullName - The full name of the property.

attributeValue - The unparsed property value.

Throws:

PropertyException - For an invalid property value.

Method Detail

getValue

public double getValue(org.axsl.fo.FoContext context,
                       FObj fobj)

Returns the value of this property.

Parameters:

context - An object that knows how to resolve FO context issues.

fobj - The FO for which this value is needed.

Returns:

The value of this property.

getValueNoInstance

public static double getValueNoInstance(org.axsl.fo.FoContext context,
                                        FObj fobj)

Returns the default (initial) value for this property.

Parameters:

context - An object that knows how to resolve FO context issues.

fobj - The FO for which this value is needed.

Returns:

The initial value for this property.

getValidKeywords

protected FoValue[] getValidKeywords()

Description copied from class: AbstractFoProperty

Returns the valid keywords for this property.

Specified by:

getValidKeywords in class AbstractFoProperty

Returns:

The valid keywords for this property.

value

public PropertyValue value()

Description copied from class: Property

Returns the value for this property.

Specified by:

value in class Property

Returns:

The value for this property.

getPropertyType

public FoProperty getPropertyType()

Description copied from class: AbstractFoProperty

Returns the type of this property.

Specified by:

getPropertyType in class AbstractFoProperty

Returns:

The type of this property.