org.foray.fotree.value
Class DtBorderWidth

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

All Implemented Interfaces:

PropertyValue

public final class DtBorderWidth
extends Datatype

Pseudo-datatype for border-width, which is defined at XSL-FO Recommendation 1.1, Section 7.8.21.

See Also:

"XSL-FO Recommendation 1.1, Section 7.8.21."

Field Summary

static short	BORDER_WIDTH_MEDIUM The size, in millipoints, of a "medium" border (1000 millipoints).
static short	BORDER_WIDTH_THICK The size, in millipoints, of a "thick" border (2000 millipoints).
static short	BORDER_WIDTH_THIN The size, in millipoints, of a "thin" border (500 millipoints).
static FoValue[]	VALID_KEYWORDS Array of valid keywords, including the word "inherit".

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

DtBorderWidth(PropertyValue value)
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.
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.
byte	getUnitPower() Each numeric has a "unit power".
int	getValue(int pointSize) Returns this border-width's length, in millipoints.
static boolean	isBorderWidth(PropertyValue value) Indicates whether a given property value qualifies as a border-width property.
boolean	lengthRequiresFontSize() Indicates whether the computation of the length will require an accurate font-size parameter.

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

Field Detail

BORDER_WIDTH_THIN

public static final short BORDER_WIDTH_THIN

The size, in millipoints, of a "thin" border (500 millipoints). This value is not specified in the standard, but depends on the user agent.

See Also:

Constant Field Values

BORDER_WIDTH_MEDIUM

public static final short BORDER_WIDTH_MEDIUM

The size, in millipoints, of a "medium" border (1000 millipoints). This value is not specified in the standard, but depends on the user agent.

See Also:

Constant Field Values

BORDER_WIDTH_THICK

public static final short BORDER_WIDTH_THICK

The size, in millipoints, of a "thick" border (2000 millipoints). This value is not specified in the standard, but depends on the user agent.

See Also:

Constant Field Values

VALID_KEYWORDS

public static final FoValue[] VALID_KEYWORDS

Array of valid keywords, including the word "inherit".

Constructor Detail

DtBorderWidth

public DtBorderWidth(PropertyValue value)
              throws PropertyException

Constructor.

Parameters:

value - The value of this border width.

Throws:

PropertyException - If value is not a valid border width. Check isBorderWidth(PropertyValue) first to avoid this exception.

See Also:

isBorderWidth(PropertyValue)

Method Detail

getValue

public int getValue(int pointSize)

Returns this border-width's length, in millipoints.

Parameters:

pointSize - The font-size, needed for some length computations.

Returns:

This border-width's length.

isBorderWidth

public static boolean isBorderWidth(PropertyValue value)

Indicates whether a given property value qualifies as a border-width property.

Parameters:

value - The property value to be tested.

Returns:

True iff the property qualifies as a border-width property.

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.

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.

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

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.

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.

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

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.