org.foray.fotree.fo.prop
Class PdVolume

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

public class PdVolume
extends AbstractFoProperty

The "volume" property in XSL-FO.

See Also:

"XSL-FO Recommendation 1.1, Section 7.7.18."

Field Summary

static double	VOLUME_LOUD The numeric equivalent of "loud".
static double	VOLUME_MEDIUM The numeric equivalent of "medium".
static double	VOLUME_SILENT The numeric equivalent of "silent".
static double	VOLUME_SOFT The numeric equivalent of "soft".
static double	VOLUME_X_LOUD The numeric equivalent of "extra-loud".
static double	VOLUME_X_SOFT The numeric equivalent of "extra-soft".

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

PdVolume(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

VOLUME_SILENT

public static final double VOLUME_SILENT

The numeric equivalent of "silent".

See Also:

Constant Field Values

VOLUME_X_SOFT

public static final double VOLUME_X_SOFT

The numeric equivalent of "extra-soft".

See Also:

Constant Field Values

VOLUME_SOFT

public static final double VOLUME_SOFT

The numeric equivalent of "soft".

See Also:

Constant Field Values

VOLUME_MEDIUM

public static final double VOLUME_MEDIUM

The numeric equivalent of "medium".

See Also:

Constant Field Values

VOLUME_LOUD

public static final double VOLUME_LOUD

The numeric equivalent of "loud".

See Also:

Constant Field Values

VOLUME_X_LOUD

public static final double VOLUME_X_LOUD

The numeric equivalent of "extra-loud".

See Also:

Constant Field Values

Constructor Detail

PdVolume

public PdVolume(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.