org.apache.fop.fo
Class XMLObj

java.lang.Object
  org.apache.fop.fo.FONode
      org.apache.fop.fo.FObj
          org.apache.fop.fo.XMLObj

Direct Known Subclasses:

SVGObj, UnknownXMLObj, XMLElement

public abstract class XMLObj

extends FObj

Since SVG objects are not layed out then this class checks that this element is not being layed out inside some incorrect element.

tagName

protected java.lang.String tagName

element

protected org.w3c.dom.Element element

doc

protected org.w3c.dom.Document doc

ns

protected static java.util.HashMap ns

XMLObj

public XMLObj(FObj parent,
              PropertyList propertyList,
              java.lang.String tag,
              java.lang.String systemId,
              int line,
              int column)

Parameters:

parent - the parent formatting object

propertyList - the explicit properties of this object

getNameSpace

public abstract java.lang.String getNameSpace()

addGraphic

public void addGraphic(org.w3c.dom.Document doc,
                       org.w3c.dom.Element parent)

buildTopLevel

public void buildTopLevel(org.w3c.dom.Document doc,
                          org.w3c.dom.Element svgRoot)

createBasicDocument

public org.w3c.dom.Document createBasicDocument()

addChild

protected void addChild(FONode child)

Overrides:

addChild in class FONode

addCharacters

protected void addCharacters(char[] data,
                             int start,
                             int length)

Description copied from class: FObj

adds characters (does nothing here)

Overrides:

addCharacters in class FObj

Parameters:

data - text

start - start position

length - length of the text

layout

public int layout(Area area)
           throws FOPException

layout this formatting object.

Overrides:

layout in class FObj

Parameters:

area - the area to layout the object into

Returns:

the status of the layout

Throws:

FOPException

removeID

public void removeID(IDReferences idReferences)

Description copied from class: FObj

removes property id

Overrides:

removeID in class FObj

Parameters:

idReferences - the id to remove

setIsInTableCell

public void setIsInTableCell()

These method overrides prevent problems with the different types.

Overrides:

setIsInTableCell in class FONode

forceStartOffset

public void forceStartOffset(int offset)

Overrides:

forceStartOffset in class FONode

forceWidth

public void forceWidth(int width)

Overrides:

forceWidth in class FONode

resetMarker

public void resetMarker()

Overrides:

resetMarker in class FONode

setLinkSet

public void setLinkSet(LinkSet linkSet)

Overrides:

setLinkSet in class FONode

getMarkerSnapshot

public java.util.ArrayList getMarkerSnapshot(java.util.ArrayList snapshot)

Description copied from class: FONode

At the start of a new span area layout may be partway through a nested FO, and balancing requires rollback to this known point. The snapshot records exactly where layout is at.

Overrides:

getMarkerSnapshot in class FONode

Parameters:

snapshot - a ArrayList of markers (Integer)

Returns:

the updated ArrayList of markers (Integers)

rollback

public void rollback(java.util.ArrayList snapshot)

Description copied from class: FONode

When balancing occurs, the flow layout() method restarts at the point specified by the current marker snapshot, which is retrieved and restored using this method.

Overrides:

rollback in class FONode

Parameters:

snapshot - the ArrayList of saved markers (Integers)

setWritingMode

protected void setWritingMode()

Description copied from class: FObj

Set writing mode for this FO. Find nearest ancestor, including self, which generates reference areas and use the value of its writing-mode property. If no such ancestor is found, use the value on the root FO.

Overrides:

setWritingMode in class FObj