fop 0.94

org.apache.fop.fo.properties
Class NumberProperty

java.lang.Object
  extended by org.apache.fop.fo.properties.Property
      extended by org.apache.fop.fo.properties.NumberProperty
All Implemented Interfaces:
Numeric
Direct Known Subclasses:
EnumNumber

public class NumberProperty
extends Property
implements Numeric

Class for handling numeric properties


Nested Class Summary
static class NumberProperty.Maker
          Inner class for making NumberProperty objects
 
Field Summary
 
Fields inherited from class org.apache.fop.fo.properties.Property
log
 
Constructor Summary
protected NumberProperty(double num)
          Constructor for double input
protected NumberProperty(int num)
          Constructor for integer input
protected NumberProperty(java.lang.Number num)
          Constructor for Number input
 
Method Summary
 boolean equals(java.lang.Object o)
          
 java.awt.Color getColor(FOUserAgent foUserAgent)
          Convert NumberProperty to a Color.
 int getDimension()
          Plain number always has a dimension of 0.
static NumberProperty getInstance(double num)
          Returns the canonical NumberProperty instance corresponding to the given double
static NumberProperty getInstance(int num)
          Returns the canonical NumberProperty instance corresponding to the given int
static NumberProperty getInstance(java.lang.Number num)
          Returns the canonical NumberProperty instance corresponding to the given Number
 Length getLength()
          This method expects to be overridden by subclasses
 java.lang.Number getNumber()
          This method expects to be overridden by subclasses
 Numeric getNumeric()
          Convert NumberProperty to Numeric object
 double getNumericValue()
          Return the value of this Numeric.
 double getNumericValue(PercentBaseContext context)
          Return the value of this Numeric.
 java.lang.Object getObject()
          This method expects to be overridden by subclasses
 int getValue()
          Returns the value of this numeric as an int.
 int getValue(PercentBaseContext context)
          Return the value
 int hashCode()
          
 boolean isAbsolute()
          Return true because all numbers are absolute.
 
Methods inherited from class org.apache.fop.fo.properties.Property
getCharacter, getCondLength, getEnum, getKeep, getLengthPair, getLengthRange, getList, getNCname, getSpace, getSpecifiedValue, getString, isAuto, setSpecifiedValue, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.fop.datatypes.Numeric
getEnum
 

Constructor Detail

NumberProperty

protected NumberProperty(java.lang.Number num)
Constructor for Number input

Parameters:
num - Number object value for property

NumberProperty

protected NumberProperty(double num)
Constructor for double input

Parameters:
num - double numeric value for property

NumberProperty

protected NumberProperty(int num)
Constructor for integer input

Parameters:
num - integer numeric value for property
Method Detail

getInstance

public static NumberProperty getInstance(java.lang.Number num)
Returns the canonical NumberProperty instance corresponding to the given Number

Parameters:
num - the base Number
Returns:
the canonical NumberProperty

getInstance

public static NumberProperty getInstance(double num)
Returns the canonical NumberProperty instance corresponding to the given double

Parameters:
num - the base double value
Returns:
the canonical NumberProperty

getInstance

public static NumberProperty getInstance(int num)
Returns the canonical NumberProperty instance corresponding to the given int

Parameters:
num - the base int value
Returns:
the canonical NumberProperty

getDimension

public int getDimension()
Plain number always has a dimension of 0.

Specified by:
getDimension in interface Numeric
Returns:
a dimension of 0.
See Also:
Numeric.getDimension()

getNumericValue

public double getNumericValue()
Return the value of this Numeric.

Specified by:
getNumericValue in interface Numeric
Returns:
The value as a double.
See Also:
Numeric.getNumericValue()

getNumericValue

public double getNumericValue(PercentBaseContext context)
Return the value of this Numeric.

Specified by:
getNumericValue in interface Numeric
Parameters:
context - Evaluation context
Returns:
The value as a double.
See Also:
Numeric.getNumericValue(PercentBaseContext)

getValue

public int getValue()
Description copied from interface: Numeric
Returns the value of this numeric as an int.

Specified by:
getValue in interface Numeric
Returns:
the value as an integer.
See Also:
Numeric.getValue()

getValue

public int getValue(PercentBaseContext context)
Return the value

Specified by:
getValue in interface Numeric
Parameters:
context - Evaluation context
Returns:
The value as an int.
See Also:
Numeric.getValue(PercentBaseContext)

isAbsolute

public boolean isAbsolute()
Return true because all numbers are absolute.

Specified by:
isAbsolute in interface Numeric
Returns:
true.
See Also:
Numeric.isAbsolute()

getNumber

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

Overrides:
getNumber in class Property
Returns:
this.number cast as a Number

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.number cast as an Object

getNumeric

public Numeric getNumeric()
Convert NumberProperty to Numeric object

Overrides:
getNumeric in class Property
Returns:
Numeric object corresponding to this

getLength

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

Overrides:
getLength in class Property
Returns:
Length property value
See Also:
Property.getLength()

getColor

public java.awt.Color getColor(FOUserAgent foUserAgent)
Convert NumberProperty to a Color. Not sure why this is needed.

Overrides:
getColor in class Property
Parameters:
foUserAgent - FOUserAgent
Returns:
Color that corresponds to black

hashCode

public int hashCode()

Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:
equals in class java.lang.Object

fop 0.94

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