org.apache.fop.fo.flow
Class Character

java.lang.Object
  extended by org.apache.fop.fo.FONode
      extended by org.apache.fop.fo.FObj
          extended by org.apache.fop.fo.flow.Character

public class Character
extends FObj

this class represents the flow object 'fo:character'. Its use is defined by the spec: "The fo:character flow object represents a character that is mapped to a glyph for presentation. It is an atomic unit to the formatter. When the result tree is interpreted as a tree of formatting objects, a character in the result tree is treated as if it were an empty element of type fo:character with a character attribute equal to the Unicode representation of the character. The semantics of an "auto" value for character properties, which is typically their initial value, are based on the Unicode codepoint. Overrides may be specified in an implementation-specific manner." (6.6.3)


Nested Class Summary
static class Character.Maker
           
 
Field Summary
static int DOESNOT_FIT
           
static int OK
           
 
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
Character(FObj parent, PropertyList propertyList, String systemId, int line, int column)
           
 
Method Summary
 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.FObj
addCharacters, addMarker, end, generatesReferenceAreas, getContentWidth, getProperty, makePropertyManager, removeID, setWritingMode
 
Methods inherited from class org.apache.fop.fo.FONode
addChild, 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
 

Field Detail

OK

public static final int OK
See Also:
Constant Field Values

DOESNOT_FIT

public static final int DOESNOT_FIT
See Also:
Constant Field Values
Constructor Detail

Character

public Character(FObj parent,
                 PropertyList propertyList,
                 String systemId,
                 int line,
                 int column)
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 FObj
Throws:
FOPException


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