fop 0.95

org.apache.fop.fo.properties
Class LengthProperty

java.lang.Object
  extended by org.apache.fop.fo.properties.Property
      extended by org.apache.fop.fo.properties.LengthProperty
All Implemented Interfaces:
Length, Numeric
Direct Known Subclasses:
EnumLength, FixedLength, PercentLength, TableColLength

public abstract class LengthProperty
extends Property
implements Length, Numeric

Superclass for properties wrapping a Length value.


Nested Class Summary
static class LengthProperty.Maker
          Inner class for making instances of LengthProperty
 
Field Summary
 
Fields inherited from class org.apache.fop.fo.properties.Property
log
 
Constructor Summary
LengthProperty()
           
 
Method Summary
 int getDimension()
          Return the dimension of this numeric.
 Length getLength()
          This method expects to be overridden by subclasses
 Numeric getNumeric()
          This method expects to be overridden by subclasses
 java.lang.Object getObject()
          This method expects to be overridden by subclasses
 double getTableUnits()
          Return the number of table units which are included in this length specification.
 
Methods inherited from class org.apache.fop.fo.properties.Property
getCharacter, getColor, getCondLength, getEnum, getKeep, getLengthPair, getLengthRange, getList, getNCname, getNumber, getSpace, getSpecifiedValue, getString, isAuto, setSpecifiedValue, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.fop.datatypes.Length
getValue, getValue
 
Methods inherited from interface org.apache.fop.datatypes.Numeric
getEnum, getNumericValue, getNumericValue, isAbsolute
 

Constructor Detail

LengthProperty

public LengthProperty()
Method Detail

getTableUnits

public double getTableUnits()
Return the number of table units which are included in this length specification. This will always be 0 unless the property specification used the proportional-column-width() function (only only table column FOs).

If this value is not 0, the actual value of the Length cannot be known without looking at all of the columns in the table to determine the value of a "table-unit".

Returns:
The number of table units which are included in this length specification.

getDimension

public int getDimension()
Description copied from interface: Numeric
Return the dimension of this numeric. Plain numbers has a dimension of 0 and length has a dimension of 1. Other dimension can occur as a result of multiplications and divisions.

Specified by:
getDimension in interface Numeric
Returns:
the numeric dimension. Length always a dimension of 1

getNumeric

public Numeric getNumeric()
Description copied from class: Property
This method expects to be overridden by subclasses

Overrides:
getNumeric in class Property
Returns:
this.length cast as a Numeric

getLength

public Length getLength()
Description copied from class: Property
This method expects to be overridden by subclasses

Overrides:
getLength in class Property
Returns:
this.length

getObject

public java.lang.Object getObject()
Description copied from class: Property
This method expects to be overridden by subclasses

Overrides:
getObject in class Property
Returns:
this.length cast as an Object

fop 0.95

Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.