org.apache.fop.fo.flow
Class Leader

java.lang.Object
  extended byorg.apache.fop.fo.FONode
      extended byorg.apache.fop.fo.FObj
          extended byorg.apache.fop.fo.FObjMixed
              extended byorg.apache.fop.fo.flow.Leader

public class Leader
extends FObjMixed

Implements fo:leader; main property of leader leader-pattern. The following patterns are treated: rule, space, dots. The pattern use-content is ignored, i.e. it still must be implemented.


Nested Class Summary
static class Leader.Maker
           
 
Field Summary
 
Fields inherited from class org.apache.fop.fo.FObjMixed
textState
 
Fields inherited from class org.apache.fop.fo.FObj
column, line, properties, propMgr, systemId
 
Fields inherited from class org.apache.fop.fo.FONode
areaClass, areasGenerated, BREAK_AFTER, children, forcedStartOffset, forcedWidth, isInTableCell, linkSet, log, marker, parent, START
 
Constructor Summary
Leader(FObj parent, PropertyList propertyList, String systemId, int line, int column)
           
 
Method Summary
 int addLeader(BlockArea ba, FontState fontState, float red, float green, float blue, int leaderPattern, int leaderLengthMinimum, int leaderLengthOptimum, int leaderLengthMaximum, int ruleThickness, int ruleStyle, int leaderPatternWidth, int leaderAlignment)
          adds a leader to current line area of containing block area the actual leader area is created in the line area
 String getName()
          returns the name of the formatting object
 int layout(Area area)
          generates the area or areas for this formatting object and adds these to the area.
static FObj.Maker maker()
           
 
Methods inherited from class org.apache.fop.fo.FObjMixed
addCharacters, addChild, end, getTextState
 
Methods inherited from class org.apache.fop.fo.FObj
addMarker, generatesReferenceAreas, getContentWidth, getProperty, makePropertyManager, removeID, setWritingMode
 
Methods inherited from class org.apache.fop.fo.FONode
forceStartOffset, forceWidth, getLinkSet, getMarkerSnapshot, getParent, mayPrecedeMarker, removeAreas, resetMarker, rollback, setIsInTableCell, setLinkSet, setLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Leader

public Leader(FObj parent,
              PropertyList propertyList,
              String systemId,
              int line,
              int column)
       throws FOPException
Method Detail

maker

public static FObj.Maker maker()

getName

public String getName()
Description copied from class: FObj
returns the name of the formatting object

Specified by:
getName in class FObj
Returns:
the name of this formatting objects

layout

public int layout(Area area)
           throws FOPException
Description copied from class: FObj
generates the area or areas for this formatting object and adds these to the area. This method should always be overridden by all sub classes

Overrides:
layout in class FObjMixed
Throws:
FOPException

addLeader

public int addLeader(BlockArea ba,
                     FontState fontState,
                     float red,
                     float green,
                     float blue,
                     int leaderPattern,
                     int leaderLengthMinimum,
                     int leaderLengthOptimum,
                     int leaderLengthMaximum,
                     int ruleThickness,
                     int ruleStyle,
                     int leaderPatternWidth,
                     int leaderAlignment)
adds a leader to current line area of containing block area the actual leader area is created in the line area

Returns:
int +1 for success and -1 for none


Copyright ? 1999-2003 Apache Software Foundation. All Rights Reserved.