org.foray.fotree.fo.prop
Class PdBorderSeparation

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

public class PdBorderSeparation
extends AbstractFoProperty

The "border-separation" property in XSL-FO.

See Also:

"XSL-FO Recommendation 1.1, Section 7.28.5."

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

PdBorderSeparation(FObj fobj, String propertyFullName, String attributeValue)
Constructor for the case that the property value must be parsed.

PdBorderSeparation(PropertyValue propertyValue)
Constructor for the case that the property value is known, useful when this is part of a shorthand property type.

Method Summary

boolean	addComponent(FObj fobj, String propertyFullName, String attributeValue) Adds a component value to the compound value.
FoProperty	getPropertyType() Returns the type of this property.
protected FoValue[]	getValidKeywords() Returns the valid keywords for this property.
int	getValue(org.axsl.fo.FoContext context, org.axsl.common.value.RelativeAxis axis, FObj fobj) Returns the value of this property.
static int	getValueNoInstance(org.axsl.fo.FoContext context, org.axsl.common.value.RelativeAxis axis, FObj fobj) 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

Constructor Detail

PdBorderSeparation

public PdBorderSeparation(FObj fobj,
                          String propertyFullName,
                          String attributeValue)
                   throws PropertyException

Constructor for the case that the property value must be parsed.

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.

PdBorderSeparation

public PdBorderSeparation(PropertyValue propertyValue)
                   throws PropertyException

Constructor for the case that the property value is known, useful when this is part of a shorthand property type.

Parameters:

propertyValue - The already-parsed property value.

Throws:

PropertyException - For an invalid property value.

Method Detail

getValue

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

Returns the value of this property.

Parameters:

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

axis - The axis for which the value is needed.

fobj - The FO for which this value is needed.

Returns:

The value of this property.

getValueNoInstance

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

Returns the default (initial) value for this property.

Parameters:

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

axis - The axis for which the value is needed.

fobj - The FO for which this value is needed.

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 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.

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.