BodyStartFunction (Apache FOP 2.8 API)

java.lang.Object

org.apache.fop.fo.expr.FunctionBase

org.apache.fop.fo.expr.BodyStartFunction

All Implemented Interfaces:: Function

public class BodyStartFunction extends FunctionBase

Class corresponding to the body-start Property Value function. See Sec. 5.10.4 of the XSL-FO spec.

Constructor Summary

Constructors

Constructor

Description

BodyStartFunction()
Method Summary

Modifier and Type

Method

Description

Property

eval(Property[] args, PropertyInfo pInfo)

Evaluate the function

int

getRequiredArgsCount()

Methods inherited from class org.apache.fop.fo.expr.FunctionBase
getOptionalArgDefault, getOptionalArgsCount, getPercentBase, getPropertyName, hasVariableArgs

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- BodyStartFunction
  
  public BodyStartFunction()
Method Details
- getRequiredArgsCount
  
  public int getRequiredArgsCount()
  
  Returns:
  
  the number of required (non-optional) arguments that must be specified in the argument list
- eval
  
  public Property eval(Property[] args, PropertyInfo pInfo) throws PropertyException
  
  Evaluate the function
  
  Parameters:
  
  args - an array of Properties that should be evaluated
  
  pInfo - property information instance that applies to property being evaluated
  
  Returns:
  
  the Property satisfying the function
  
  Throws:
  
  PropertyException - for problems when evaluating the function