org.foray.fotree.fo.prop
Class PdLineHeight

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

public class PdLineHeight
extends AbstractFoProperty

The "line-height" property in XSL-FO.

See Also:

"XSL-FO Recommendation 1.1, Section 7.16.4."

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

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

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

Method Summary

boolean	addComponent(FObj fobj, String propertyFullName, String attributeValue) Add a component to this compound property.
org.axsl.common.value.Conditionality	getConditionality(org.axsl.fo.FoContext context, FObj fobj) Returns the conditionality component of this property.
static org.axsl.common.value.Conditionality	getConditionalityNoInstance(org.axsl.fo.FoContext context, FObj fobj) Returns the default (initial) value for the conditionality component of this property.
int	getPrecedence(org.axsl.fo.FoContext context, FObj fobj) Returns the precedence component of this property.
static int	getPrecedenceNoInstance(org.axsl.fo.FoContext context, FObj fobj) Returns the default (initial) value for the precedence component of this property.
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, LengthRange rangeID, FObj fobj) Returns the value for this property.
float	getValueMultiplier(org.axsl.fo.FoContext context, FObj fobj) Returns the value multiplier specified by this property.
static float	getValueMultiplierNoInstance(org.axsl.fo.FoContext context, FObj fobj) Returns the default (initial) value for the multiplier component of this property.
static int	getValueNoInstance(org.axsl.fo.FoContext context, FObj fobj) Returns the initial (default) 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

PdLineHeight

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

PdLineHeight

public PdLineHeight(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,
                    LengthRange rangeID,
                    FObj fobj)

Returns the value for this property.

Parameters:

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

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

getValueMultiplier

public float getValueMultiplier(org.axsl.fo.FoContext context,
                                FObj fobj)

Returns the value multiplier specified by 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 multiplier specified.

getValueNoInstance

public static int getValueNoInstance(org.axsl.fo.FoContext context,
                                     FObj fobj)

Returns the initial (default) 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.

Returns:

The initial value of this property.

getValueMultiplierNoInstance

public static float getValueMultiplierNoInstance(org.axsl.fo.FoContext context,
                                                 FObj fobj)

Returns the default (initial) value for the multiplier component 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 initial value for the multiplier component of this property.

getPrecedence

public int getPrecedence(org.axsl.fo.FoContext context,
                         FObj fobj)

Returns the precedence component 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 precedence component.

getPrecedenceNoInstance

public static int getPrecedenceNoInstance(org.axsl.fo.FoContext context,
                                          FObj fobj)

Returns the default (initial) value for the precedence component 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 initial value for the precedence component of this property.

getConditionality

public org.axsl.common.value.Conditionality getConditionality(org.axsl.fo.FoContext context,
                                                              FObj fobj)

Returns the conditionality component 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 conditionality component.

getConditionalityNoInstance

public static org.axsl.common.value.Conditionality getConditionalityNoInstance(org.axsl.fo.FoContext context,
                                                                               FObj fobj)

Returns the default (initial) value for the conditionality component 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 initial value of the conditionality 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

Add a component to this compound property.

Parameters:

fobj - The FObj to which this property belongs.

propertyFullName - The full name of the property.

attributeValue - The unparsed attribute value.

Returns:

True iff the component was successfully added.

Throws:

PropertyException - For an invalid property value.

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.