org.foray.fotree.fo.prop
Class AbstractIndent

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

Direct Known Subclasses:

PdEndIndent, PdStartIndent

public abstract class AbstractIndent
extends AbstractFoProperty

Abstract superclass for the "start-indent" and "end-indent" XSL-FO properties. Note that "text-indent" is handled in the class PdTextIndent.

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

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

Method Summary

protected abstract org.axsl.common.value.RelativeCompass	getRelativeCompass() Return the relative compass direction for this property.
protected FoValue[]	getValidKeywords() Returns the valid keywords for this property.
int	getValue(org.axsl.fo.FoContext context, FObj fobj) Returns the value of this property.
static int	getValueNoInstance(org.axsl.fo.FoContext context, FObj fobj, org.axsl.common.value.RelativeCompass direction) Returns the default (initial) value for this property.
static FoProperty	rawAbsoluteCorrespondingPropertyType(FObj fobj, org.axsl.fo.FoContext context, org.axsl.common.value.RelativeCompass direction) Returns the property type for the corresponding absolute margin property.
static FoProperty	rawPropertyType(org.axsl.common.value.RelativeCompass direction) Converts a directional constant into its related 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

AbstractIndent

public AbstractIndent(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,
                    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.

getRelativeCompass

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

Return the relative compass direction for this property.

Returns:

The relative compass direction.

getValueNoInstance

public static int getValueNoInstance(org.axsl.fo.FoContext context,
                                     FObj fobj,
                                     org.axsl.common.value.RelativeCompass direction)

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.

direction - The direction for which this value is needed.

Returns:

The initial value for this property.

rawPropertyType

public static FoProperty rawPropertyType(org.axsl.common.value.RelativeCompass direction)

Converts a directional constant into its related property.

Parameters:

direction - One of the directional constants.

Returns:

The property related to direction.

rawAbsoluteCorrespondingPropertyType

public static FoProperty rawAbsoluteCorrespondingPropertyType(FObj fobj,
                                                              org.axsl.fo.FoContext context,
                                                              org.axsl.common.value.RelativeCompass direction)

Returns the property type for the corresponding absolute margin property. For example, in the lr-tb, a relative compass direction of "start" would return FoProperty.MARGIN_LEFT.

Parameters:

fobj - The FO for which this value is needed.

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

direction - Either RelativeCompass.START or RelativeCompass.END.

Returns:

The corresponding margin property, one of: FoProperty.MARGIN_TOP, FoProperty.MARGIN_BOTTOM, FoProperty.MARGIN_LEFT, or FoProperty.MARGIN_RIGHT.

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.