org.foray.fotree.fo.prop
Class AbstractRelativeSpace

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

Direct Known Subclasses:

PdSpaceAfter, PdSpaceBefore, PdSpaceEnd, PdSpaceStart

public abstract class AbstractRelativeSpace
extends AbstractFoProperty

Abstract superclass for the "space-before", "space-after", "space-start", and "space-end" properties.

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

AbstractRelativeSpace(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.
org.axsl.common.value.Conditionality	getConditionality() Returns the conditionality component of this property.
static org.axsl.common.value.Conditionality	getConditionalityNoInstance() Returns the default (initial) value for the conditionality component of this property.
int	getPrecedence() Returns the precedence component of this property.
static short	getPrecedenceNoInstance() Returns the default (initial) value for the precedence component of this property.
protected abstract org.axsl.common.value.RelativeCompass	getRelativeCompass() Returns the relative compass direction 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 the numeric component of 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

AbstractRelativeSpace

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

getRelativeCompass

protected abstract org.axsl.common.value.RelativeCompass getRelativeCompass()

Returns the relative compass direction for this property.

Returns:

The relative compass direction for this property.

getConditionality

public org.axsl.common.value.Conditionality getConditionality()

Returns the conditionality component of this property.

Returns:

The conditionality component.

getPrecedence

public int getPrecedence()

Returns the precedence component of this property.

Returns:

The precedence component.

getValueNoInstance

public static int getValueNoInstance()

Returns the default (initial) value for the numeric component of this property.

Returns:

The initial value of the numeric component of this property.

getConditionalityNoInstance

public static org.axsl.common.value.Conditionality getConditionalityNoInstance()

Returns the default (initial) value for the conditionality component of this property.

Returns:

The initial value of the conditionality component of this property.

getPrecedenceNoInstance

public static short getPrecedenceNoInstance()

Returns the default (initial) value for the precedence component of this property.

Returns:

The initial value of the precedence component of 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 not valid.

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.