org.foray.fotree.fo.prop
Class AbstractRelativeDimension

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

Direct Known Subclasses:

PdBlockProgressionDimension, PdInlineProgressionDimension

public abstract class AbstractRelativeDimension
extends AbstractFoProperty

Abstract superclass for inline-progression-dimension and block-progression-dimension.

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

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

Method Summary

boolean	addComponent(FObj fobj, String propertyFullName, String attributeValue) Adds a component value to the compound value.
protected abstract org.axsl.common.value.RelativeAxis	getRelativeAxis() Returns the relative axis for this property.
protected FoValue[]	getValidKeywords() Returns the valid keywords for this property.
int	getValue(org.axsl.fo.FoContext context, LengthRange subProperty, FObj fobj) Returns the value of this property.
static int	getValueNoInstance() Returns the default (initial) value for this property.
boolean	isAuto(FObj fobj) Indicates whether this property's value is "auto".
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

AbstractRelativeDimension

public AbstractRelativeDimension(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 int getValue(org.axsl.fo.FoContext context,
                    LengthRange subProperty,
                    FObj fobj)

Returns the value of this property.

Parameters:

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

subProperty - The length-range for the property needed (MINIMUM, OPTIMUM, OR MAXIMUM).

fobj - The FO for which this value is needed.

Returns:

The value of this property.

getRelativeAxis

protected abstract org.axsl.common.value.RelativeAxis getRelativeAxis()

Returns the relative axis for this property.

Returns:

The relative axis.

getValueNoInstance

public static int getValueNoInstance()

Returns the default (initial) value for this property.

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.

addComponent

public boolean addComponent(FObj fobj,
                            String propertyFullName,
                            String attributeValue)
                     throws PropertyException

Adds a component value to the compound value.

Parameters:

fobj - The FObj to which this property belongs.

propertyFullName - The full name of the property, including both the base and the sub-property name.

attributeValue - The value of the component.

Returns:

True if the component was successfully added, false if the pre-existing value is not the correct type.

Throws:

PropertyException - if the input is invalid.

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.

isAuto

public boolean isAuto(FObj fobj)

Indicates whether this property's value is "auto".

Parameters:

fobj - The FObj to which this property belongs.

Returns:

True iff this property's value is "auto".