org.foray.fotree.fo.prop
Class PdBackgroundPosition

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

public class PdBackgroundPosition
extends AbstractFoProperty

The "background-position" shorthand property in XSL-FO.

See Also:

"XSL-FO Recommendation 1.1, Section 7.31.2."

Field Summary

static FoValue[]

VALID_KEYWORDS Array of valid keywords.

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

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

PdBackgroundPosition(PropertyValue value)
Constructor for the case where the property value is already known.

Method Summary

FoProperty	getPropertyType() Returns the type of this property.
int	getShorthandValue(org.axsl.fo.FoContext context, FObj fobj, org.axsl.common.value.AbsoluteAxis axis, int paddingRectangleDimension, int backgroundImageDimension) Returns the value of this property for the case that this property is a shorthand.
protected FoValue[]	getValidKeywords() Returns the valid keywords for this property.
int	getValue(org.axsl.fo.FoContext context, FObj fobj, org.axsl.common.value.AbsoluteAxis axis, int paddingRectangleDimension, int backgroundImageDimension) Returns the value of this property.
static int	getValueNoInstance() 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

VALID_KEYWORDS

public static final FoValue[] VALID_KEYWORDS

Array of valid keywords.

Constructor Detail

PdBackgroundPosition

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

PdBackgroundPosition

public PdBackgroundPosition(PropertyValue value)
                     throws PropertyException

Constructor for the case where the property value is already known.

Parameters:

value - The property value.

Throws:

PropertyException - For an invalid property value.

Method Detail

getValue

public int getValue(org.axsl.fo.FoContext context,
                    FObj fobj,
                    org.axsl.common.value.AbsoluteAxis axis,
                    int paddingRectangleDimension,
                    int backgroundImageDimension)

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.

axis - The axis for which the value is needed.

paddingRectangleDimension - The padding-rectangle size, in millipoints, on the axis corresponding to axis.

backgroundImageDimension - The background-image size, in millipoints, on the axis corresponding to axis.

Returns:

The value of this property.

getShorthandValue

public int getShorthandValue(org.axsl.fo.FoContext context,
                             FObj fobj,
                             org.axsl.common.value.AbsoluteAxis axis,
                             int paddingRectangleDimension,
                             int backgroundImageDimension)

Returns the value of this property for the case that this property is a shorthand.

Parameters:

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

fobj - The FO for which this value is needed.

axis - The axis for which the value is needed.

paddingRectangleDimension - The padding-rectangle size, in millipoints, on the axis corresponding to axis.

backgroundImageDimension - The background-image size, in millipoints, on the axis corresponding to axis.

Returns:

The value of this property.

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.

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.