XMLElement (Fop API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Home

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.fop.fo
Class XMLElement

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

public class XMLElement
extends XMLObj

class representing svg:svg pseudo flow object.

Nested Class Summary
`static class`	`XMLElement.Maker` inner class for making XML objects.

Field Summary

Fields inherited from class org.apache.fop.fo.XMLObj

doc, element, ns, tagName

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
`XMLElement(FObj parent, PropertyList propertyList, java.lang.String tag, java.lang.String systemId, int line, int column)` constructs an XML object (called by Maker).

Method Summary
`java.lang.String`	`getName()` returns the name of the formatting object
`java.lang.String`	`getNameSpace()`
`int`	`layout(Area area)` layout this formatting object.
`static FObj.Maker`	`maker(java.lang.String tag)` returns the maker for this object.

Methods inherited from class org.apache.fop.fo.XMLObj

addCharacters, addChild, addGraphic, buildTopLevel, createBasicDocument, forceStartOffset, forceWidth, getMarkerSnapshot, removeID, resetMarker, rollback, setIsInTableCell, setLinkSet, setWritingMode

Methods inherited from class org.apache.fop.fo.FObj

addMarker, end, generatesReferenceAreas, getContentWidth, getProperty, makePropertyManager

Methods inherited from class org.apache.fop.fo.FONode

getLinkSet, getParent, mayPrecedeMarker, removeAreas, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XMLElement

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

constructs an XML object (called by Maker).
Parameters:: parent - the parent formatting object; propertyList - the explicit properties of this object

Method Detail

maker

public static FObj.Maker maker(java.lang.String tag)

returns the maker for this object.

Returns:: the maker for XML objects

getName

public java.lang.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

layout this formatting object.

Overrides:: layout in class XMLObj

Parameters:: area - the area to layout the object into
Returns:: the status of the layout
Throws:: FOPException

getNameSpace

public java.lang.String getNameSpace()

Specified by:: getNameSpace in class XMLObj