org.foray.fotree.fo.prop
Class AbstractAudioDial

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

Direct Known Subclasses:

PdPitchRange, PdRichness, PdStress

public abstract class AbstractAudioDial
extends AbstractFoProperty

Abstract superclass for the "pitch-range", "stress", and "richness" XSL-FO properties. The class was so named because these settings are all similar to an analog dial on an electronic assembly, with a counterclockwise stop at 0, a clockwise stop at 100, and middle "click" setting at 50.

Field Summary

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

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

Method Summary

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, FoProperty propertyType) 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, getPropertyType, 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

Constructor Detail

AbstractAudioDial

public AbstractAudioDial(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,
                                        FoProperty propertyType)

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.

propertyType - The specific property for which the default 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.