org.foray.fotree.value
Class DtRectangle

java.lang.Object
  org.foray.fotree.value.Expr
      org.foray.fotree.value.ExprAdditive
          org.foray.fotree.value.ExprMultiplicative
              org.foray.fotree.value.ExprUnary
                  org.foray.fotree.value.ExprPrimary
                      org.foray.fotree.value.Datatype
                          org.foray.fotree.value.DtShape
                              org.foray.fotree.value.DtRectangle

All Implemented Interfaces:

PropertyValue

public class DtRectangle
extends DtShape

A rectangle datatype in XSL. This datatype is not specifically listed among the datatypes in the XSL-FO Standard 1.0, at Section 5.11. However, it is described at Section 7.20.1, and in the CSS 2.1 Specification at 11.1.2 and other places.

Field Summary

Fields inherited from class org.foray.fotree.value.Expr

OPERATION_ADD, OPERATION_DIVIDE, OPERATION_MOD, OPERATION_MULTIPLY, OPERATION_NEGATION, OPERATION_SUBTRACT, UNIT_POWER_AREA, UNIT_POWER_LENGTH, UNIT_POWER_NON_NUMERIC, UNIT_POWER_NUMERIC

Constructor Summary

DtRectangle(PropertyValue topOffset, PropertyValue rightOffset, PropertyValue bottomOffset, PropertyValue leftOffset)
Constructor.

Method Summary

boolean	canEvalColor() Indicates whether this property value has the ability to express itself as a Color.
boolean	canEvalInteger() Indicates whether this property value has the ability to express itself as an integer Numeric item.
boolean	canEvalKeyword() Indicates whether this property value can evaluate to a keyword.
boolean	canEvalLength() Indicates whether this expression can be evaluated to a unit power = 1 (length) or not.
boolean	canEvalNumeric() Indicates whether this property value has the ability to express itself as a Numeric item.
boolean	canEvalPercentage() Indicates whether this property value can evaluate to a percentage.
Shape	computeShape(Shape inputShape, int pointSize) Computes the shape described by this.
Color	evalColor() Return the color value of "this".
int	evalInteger() Return this value as an int.
PvKeyword	evalKeyword() Returns the keyword value of this property value.
int	evalLength(int pointSize) Evaluates the expression to a unit power of 1 (length).
double	evalNumeric() Return the raw numeric value of "this", without regard to unit power.
float	evalPercentage() Returns the percentage value of this property value.
int	getBottomOffset(int pointSize, int percentBase) Returns the bottom offset component of this rectangle.
int	getLeftOffset(int pointSize, int percentBase) Returns the left offset component of this rectangle.
int	getRightOffset(int pointSize, int percentBase) Returns the right offset component of this rectangle.
int	getTopOffset(int pointSize, int percentBase) Returns the top offset component of this rectangle.
byte	getUnitPower() Each numeric has a "unit power".
boolean	lengthRequiresFontSize() Indicates whether the computation of the length will require an accurate font-size parameter.
static DtRectangle	makeRectangleDT(String input) Factory method for creating a RectangleDT from a String input.

Methods inherited from class org.foray.fotree.value.DtShape

makeShapeDT

Methods inherited from class org.foray.fotree.value.Datatype

convertValueToFoValue

Methods inherited from class org.foray.fotree.value.Expr

evalColorException, evalIntegerException, evalKeywordException, evalLengthException, evalNumericException, evalPercentageException

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DtRectangle

public DtRectangle(PropertyValue topOffset,
                   PropertyValue rightOffset,
                   PropertyValue bottomOffset,
                   PropertyValue leftOffset)
            throws PropertyException

Constructor.

Parameters:

topOffset - The top offset component of the rectangle.

rightOffset - The right offset component of the rectangle.

bottomOffset - The bottom offset component of the rectangle.

leftOffset - The left offset component of the rectangle.

Throws:

PropertyException - If any offset value is invalid.

Method Detail

getTopOffset

public int getTopOffset(int pointSize,
                        int percentBase)

Returns the top offset component of this rectangle.

Parameters:

pointSize - The font size.

percentBase - The percent base used for length calculations, if any.

Returns:

The top offset component of this rectangle.

getRightOffset

public int getRightOffset(int pointSize,
                          int percentBase)

Returns the right offset component of this rectangle.

Parameters:

pointSize - The font size.

percentBase - The percent base used for length calculations, if any.

Returns:

The right offset component of this rectangle.

getBottomOffset

public int getBottomOffset(int pointSize,
                           int percentBase)

Returns the bottom offset component of this rectangle.

Parameters:

pointSize - The font size.

percentBase - The percent base used for length calculations, if any.

Returns:

The bottom offset component of this rectangle.

getLeftOffset

public int getLeftOffset(int pointSize,
                         int percentBase)

Returns the left offset component of this rectangle.

Parameters:

pointSize - The font size.

percentBase - The percent base used for length calculations, if any.

Returns:

The left offset component of this rectangle.

makeRectangleDT

public static DtRectangle makeRectangleDT(String input)

Factory method for creating a RectangleDT from a String input.

Parameters:

input - The String from which a RectangleDT should be constructed.

Returns:

The RectangleDT instance constructed, or null if input is not valid.

canEvalNumeric

public boolean canEvalNumeric()

Description copied from interface: PropertyValue

Indicates whether this property value has the ability to express itself as a Numeric item.

Returns:

True iff this property value is a numeric.

evalNumeric

public double evalNumeric()

Description copied from interface: PropertyValue

Return the raw numeric value of "this", without regard to unit power.

Returns:

A double representation of the value of "this". Type "double" is assumed to be the lowest-common-denominator of all numeric values.

canEvalLength

public boolean canEvalLength()

Description copied from interface: PropertyValue

Indicates whether this expression can be evaluated to a unit power = 1 (length) or not.

Returns:

True if the expression can be evaluated to a unit power of 1 (length).

getUnitPower

public byte getUnitPower()

Description copied from interface: PropertyValue

Each numeric has a "unit power". This number refers to the number of spatial dimensions in which the number operates. So, a number that has no relationship to space or refers to a point, has a length power of 0. A number that refers to length has a length power of 1 (1 dimension). Although there are none yet in XSL-FO, a number that referred to area (e.g. square inches) would, we suppose, have a length power of 2, and one referring to volume (e.g. cubic feet) would, we suppose have a length power of 3.

Returns:

The number of spatial dimensions in which this numeric item operates. For XSL-FO items, this should be either Expr.UNIT_POWER_NUMERIC or Expr.UNIT_POWER_LENGTH.

evalLength

public int evalLength(int pointSize)

Description copied from interface: PropertyValue

Evaluates the expression to a unit power of 1 (length).

Parameters:

pointSize - The point size, in millipoints, of the font. This is used in calculations that are relative to the point size. In cases where the computation of the font-size is expensive, check PropertyValue.lengthRequiresFontSize() first. If that method returns false, zero or some other constant can safely be passed, as it will be ignored anyway.

Returns:

The unit power 1 value (length) of this expression if the expression can be so evaluated, or Integer.MIN_VALUE otherwise. The value is expressed in millipoints.

canEvalColor

public boolean canEvalColor()

Description copied from interface: PropertyValue

Indicates whether this property value has the ability to express itself as a Color.

Returns:

True iff this property value is a color.

evalColor

public Color evalColor()

Description copied from interface: PropertyValue

Return the color value of "this".

Returns:

The color representation of the value of "this".

lengthRequiresFontSize

public boolean lengthRequiresFontSize()

Description copied from interface: PropertyValue

Indicates whether the computation of the length will require an accurate font-size parameter.

Returns:

True iff the computation of the length will require an accurate font-size parameter.

canEvalInteger

public boolean canEvalInteger()

Description copied from interface: PropertyValue

Indicates whether this property value has the ability to express itself as an integer Numeric item.

Returns:

True iff this property value is an integer.

evalInteger

public int evalInteger()

Description copied from interface: PropertyValue

Return this value as an int. This method should only be executed on instances where PropertyValue.canEvalInteger() returns true. Doing so on other instances may result in an IllegalStateException.

Returns:

This value as an int.

canEvalKeyword

public boolean canEvalKeyword()

Description copied from interface: PropertyValue

Indicates whether this property value can evaluate to a keyword.

Returns:

True iff this property value can evaluate to a keyword.

evalKeyword

public PvKeyword evalKeyword()

Description copied from interface: PropertyValue

Returns the keyword value of this property value. This method should only be executed on instances where PropertyValue.canEvalKeyword() returns true. Doing so on other instances may result in an IllegalStateException.

Returns:

The keyword value of this property value.

canEvalPercentage

public boolean canEvalPercentage()

Description copied from interface: PropertyValue

Indicates whether this property value can evaluate to a percentage.

Returns:

True iff this property value can evaluate to a percentage.

evalPercentage

public float evalPercentage()

Description copied from interface: PropertyValue

Returns the percentage value of this property value. This method should only be executed on instances where PropertyValue.canEvalPercentage() returns true. Doing so on other instances may result in an IllegalStateException.

Returns:

The percentage value of this property value.

computeShape

public Shape computeShape(Shape inputShape,
                          int pointSize)

Description copied from class: DtShape

Computes the shape described by this.

Specified by:

computeShape in class DtShape

Parameters:

inputShape - The shape to which the computed (returned) shape is relative. All encapsulated dimensions are expressed in millipoints. CSS and XSL-FO shapes are defined as offsets to other shapes, and the exact dimensions of those shapes are not necessarily known as the data item is parsed, so the actual shape must be passed in here.

pointSize - The font size.

Returns:

The computed shape defined by this. All dimensions are in millipoints, regardless of the implementation of Shape that is used.