org.foray.fotree.fo.prop
Class PdInitialPageNumber

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

public class PdInitialPageNumber
extends AbstractFoProperty

The "initial-page-number" property in XSL-FO.

See Also:

"XSL-FO Recommendation 1.1, Section 7.27.7."

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

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

Method Summary

FoProperty	getPropertyType() Returns the type of this property.
FoValue	getRawValue(FObj fobj) Returns the raw value for this property.
static FoValue	getRawValueNoInstance() Returns the default (initial) value for this property.
protected FoValue[]	getValidKeywords() Returns the valid keywords for this property.
int	getValue(org.axsl.fo.FoContext context, FObj fobj, int lastPageNumberUsed) Returns the value of this property.
static int	getValueNoInstance(int lastPageNumberUsed) 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

PdInitialPageNumber

public PdInitialPageNumber(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,
                    int lastPageNumberUsed)

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.

lastPageNumberUsed - The value of the last page number that was generated in the previous page-sequence.

Returns:

The value of this property.

getRawValue

public FoValue getRawValue(FObj fobj)

Returns the raw value for this property.

Parameters:

fobj - The FO for which this value is needed.

Returns:

The initial value for this property.

getValueNoInstance

public static int getValueNoInstance(int lastPageNumberUsed)

Returns the default (initial) value for this property.

Parameters:

lastPageNumberUsed - The value of the last page number that was generated in the previous page-sequence.

Returns:

The initial value for this property.

getRawValueNoInstance

public static FoValue getRawValueNoInstance()

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.