org.foray.fotree.fo.prop
Class AbstractCue

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

Direct Known Subclasses:

PdCue, PdCueAfter, PdCueBefore

public abstract class AbstractCue
extends AbstractFoProperty

Abstract superclass for the "cue-before" and "cue-after" properties, and the "cue" shorthand property. Note: The documentation for these properties and shorthand is mostly found in the CSS2 documentation.

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

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

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

Method Summary

String	getShorthandValue(org.axsl.fo.FoContext context, FObj fobj, FoProperty propertyType) Returns the value of this property for the case that this property is a shorthand.
protected FoValue[]	getValidKeywords() Returns the valid keywords for this property.
String	getValue(org.axsl.fo.FoContext context, FObj fobj, FoProperty propertyType) Returns the value of this property.
static String	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, 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

Constructor Detail

AbstractCue

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

AbstractCue

public AbstractCue(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 String getValue(org.axsl.fo.FoContext context,
                       FObj fobj,
                       FoProperty propertyType)

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.

propertyType - The enumerated property type.

Returns:

The value of this property.

getShorthandValue

public String getShorthandValue(org.axsl.fo.FoContext context,
                                FObj fobj,
                                FoProperty propertyType)

Returns the value of this property for the case that this property is a shorthand.

Parameters:

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

fobj - The FO for which this value is needed.

propertyType - The enumerated property type.

Returns:

The value of this property.

getValueNoInstance

public static String getValueNoInstance()

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.