org.foray.fotree.fo.prop
Class AbstractBorderWidth

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

Direct Known Subclasses:

PdBorderAfterWidth, PdBorderBeforeWidth, PdBorderBottomWidth, PdBorderEndWidth, PdBorderLeftWidth, PdBorderRightWidth, PdBorderStartWidth, PdBorderTopWidth

public abstract class AbstractBorderWidth
extends AbstractFoProperty

Abstract superclass for the "border-before-width", "border-after-width", "border-start-width", "border-end-width", "border-top-width", "border-bottom-width", "border-left-width", and "border-right-width" properties in XSL-FO.

Field Summary

protected 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

	AbstractBorderWidth(FObj fobj, String propertyFullName, String attributeValue) Constructor.
protected	AbstractBorderWidth(PropertyValue value) Special constructor to be used when some other class has done the parsing.

Method Summary

protected abstract org.axsl.common.value.RelativeCompass	getRelativeCompass(org.axsl.fo.FoContext context, FObj fobj) 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 short	getValueNoInstance() Returns the default (initial) value for this property.
protected boolean	isOuterEdge(org.axsl.fo.FoContext context, FObj fobj) Indicates whether the context is on the outer edge of its parent reference area.
static FoProperty	rawPropertyType(org.axsl.common.value.Compass direction) Converts a raw direction 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

Field Detail

VALID_KEYWORDS

protected static final FoValue[] VALID_KEYWORDS

Array of valid keywords.

Constructor Detail

AbstractBorderWidth

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

AbstractBorderWidth

protected AbstractBorderWidth(PropertyValue value)

Special constructor to be used when some other class has done the parsing. Specifically, this is used by classes that handle shorthand properties.

Parameters:

value - The 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(org.axsl.fo.FoContext context,
                                                                            FObj fobj)

Return the relative compass direction 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 relative compass direction for this property.

getValueNoInstance

public static short getValueNoInstance()

Returns the default (initial) value for this property.

Returns:

The initial value for this property.

rawPropertyType

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

Converts a raw direction into its related property.

Parameters:

direction - One of the directional constants.

Returns:

The property related to direction.

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.

isOuterEdge

protected boolean isOuterEdge(org.axsl.fo.FoContext context,
                              FObj fobj)

Indicates whether the context is on the outer edge of its parent reference area.

Parameters:

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

fobj - The FO for which this property exists.

Returns:

True iff the context is on the outer edge of its parent reference area.