org.foray.fotree.fo.prop
Class PdZIndex

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

public class PdZIndex
extends AbstractFoProperty

The "z-index" property in XSL-FO.

See Also:

"XSL-FO Recommendation 1.1, Section 7.30.18."

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

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

Method Summary

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, FObj fobj) Returns the value of this property.
boolean	getValueIsAuto(org.axsl.fo.FoContext context, FObj fobj) Indicates whether the value of this property is "auto".
static boolean	getValueIsAutoNoInstance() Returns the default for whether this value is "auto" or not.
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

Constructor Detail

PdZIndex

public PdZIndex(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. User programs should check getValueIsAuto(FoContext, FObj) first, so that this value can be ignored.

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.

getValueNoInstance

public static int getValueNoInstance()

Returns the default (initial) value for this property.

Returns:

The initial value for this property.

getValueIsAuto

public boolean getValueIsAuto(org.axsl.fo.FoContext context,
                              FObj fobj)

Indicates whether the value of this property is "auto".

Parameters:

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

fobj - The FO for which this value is needed.

Returns:

True iff this property value is "auto".

getValueIsAutoNoInstance

public static boolean getValueIsAutoNoInstance()

Returns the default for whether this value is "auto" or not.

Returns:

True always, as the default value of "z-index" is auto.

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.