|
fop 0.90alpha1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.fop.render.AbstractRenderer | +--org.apache.fop.render.PrintRenderer | +--org.apache.fop.render.xml.XMLRenderer
Renderer that renders areas to XML for debugging purposes. This creates an xml that contains the information of the area tree. It does not output any state or derived information. The output can be used to build a new area tree (@see AreaTreeBuilder) which can be rendered to any renderer.
Field Summary | |
protected org.xml.sax.helpers.AttributesImpl |
atts
AttributesImpl instance that can be used during XML generation. |
static java.lang.String |
CDATA
CDATA type |
static org.xml.sax.Attributes |
EMPTY_ATTS
An empty Attributes object used when no attributes are needed. |
protected javax.xml.transform.sax.TransformerHandler |
handler
TransformerHandler that the generated XML is written to |
static java.lang.String |
NS
Main namespace in use. |
protected java.io.OutputStream |
out
The OutputStream to write the generated XML to. |
static java.lang.String |
XML_MIME_TYPE
XML MIME type |
Fields inherited from class org.apache.fop.render.PrintRenderer |
fontInfo, fontList |
Fields inherited from class org.apache.fop.render.AbstractRenderer |
containingBPPosition, containingIPPosition, currentBPPosition, currentIPPosition, log, userAgent |
Fields inherited from interface org.apache.fop.render.Renderer |
ROLE |
Constructor Summary | |
XMLRenderer()
Creates a new XML renderer. |
Method Summary | |
protected void |
addAreaAttributes(Area area)
Adds the general Area attributes. |
protected void |
addAttribute(java.lang.String name,
int value)
Adds a new attribute to the protected member variable "atts". |
protected void |
addAttribute(java.lang.String name,
java.awt.geom.Rectangle2D rect)
Adds a new attribute to the protected member variable "atts". |
protected void |
addAttribute(java.lang.String name,
java.lang.String value)
Adds a new attribute to the protected member variable "atts". |
protected void |
addTraitAttributes(Area area)
Adds attributes from traits of an Area. |
protected void |
characters(java.lang.String text)
Sends plain text to the XML |
protected void |
comment(java.lang.String comment)
Writes a comment to the generated XML. |
protected void |
endElement(java.lang.String tagName)
Ends an element. |
java.lang.String |
getMimeType()
Get the MIME type of the renderer. |
protected void |
handleSAXException(org.xml.sax.SAXException saxe)
Handles SAXExceptions. |
protected void |
renderBeforeFloat(BeforeFloat bf)
Renders a before float area. |
protected void |
renderBlock(Block block)
Renders a block area. |
protected void |
renderCharacter(Character ch)
Render the given Character. |
void |
renderContainer(Container cont)
Tells the renderer to render an inline container. |
protected void |
renderFlow(NormalFlow flow)
Renders a flow reference area. |
protected void |
renderFootnote(Footnote footnote)
Renders a footnote |
void |
renderForeignObject(ForeignObject fo,
java.awt.geom.Rectangle2D pos)
Renders an fo:foreing-object. |
void |
renderImage(Image image,
java.awt.geom.Rectangle2D pos)
Renders an image area. |
protected void |
renderInlineBlockParent(InlineBlockParent ibp)
Render the given InlineBlockParent. |
protected void |
renderInlineParent(InlineParent ip)
Render the given InlineParent. |
protected void |
renderInlineSpace(Space space)
Render the given Space. |
protected void |
renderLeader(Leader area)
Render the given Leader. |
protected void |
renderLineArea(LineArea line)
Renders a line area. |
protected void |
renderMainReference(MainReference mr)
Renders the main reference area. |
void |
renderPage(PageViewport page)
Tells the renderer to render a particular page. |
protected void |
renderRegionViewport(RegionViewport port)
Renders a region viewport. |
protected void |
renderSpace(SpaceArea space)
Render the given SpaceArea. |
protected void |
renderText(TextArea text)
Render the given TextArea. |
protected void |
renderViewport(Viewport viewport)
Render the given Viewport. |
protected void |
renderWord(WordArea word)
Render the given WordArea. |
void |
setTransformerHandler(javax.xml.transform.sax.TransformerHandler handler)
Sets an outside TransformerHandler to use instead of the default one create in this class in startRenderer(). |
void |
setUserAgent(FOUserAgent agent)
Set the User Agent. |
protected void |
startElement(java.lang.String tagName)
Starts a new element (without attributes). |
protected void |
startElement(java.lang.String tagName,
org.xml.sax.Attributes atts)
Starts a new element. |
void |
startPageSequence(LineArea seqTitle)
Tells the renderer that a new page sequence starts. |
void |
startRenderer(java.io.OutputStream outputStream)
Initiates the rendering phase. |
void |
stopRenderer()
Signals the end of the rendering phase. |
Methods inherited from class org.apache.fop.render.PrintRenderer |
lightenColor, setupFontInfo |
Methods inherited from class org.apache.fop.render.AbstractRenderer |
configure, convertTitleToString, endVParea, getGraphics2DAdapter, handleBlockTraits, handleRegionTraits, preparePage, processOffDocumentItem, renderBlocks, renderBlockViewport, renderBodyRegion, renderInlineArea, renderPageAreas, renderRegion, renderXML, startVParea, supportsOutOfOrder |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String XML_MIME_TYPE
public static final java.lang.String NS
public static final java.lang.String CDATA
public static final org.xml.sax.Attributes EMPTY_ATTS
protected javax.xml.transform.sax.TransformerHandler handler
protected org.xml.sax.helpers.AttributesImpl atts
protected java.io.OutputStream out
Constructor Detail |
public XMLRenderer()
Method Detail |
public void setUserAgent(FOUserAgent agent)
Renderer
setUserAgent
in class AbstractRenderer
Renderer.setUserAgent(FOUserAgent)
public void setTransformerHandler(javax.xml.transform.sax.TransformerHandler handler)
handler
- Overriding TransformerHandlerprotected void handleSAXException(org.xml.sax.SAXException saxe)
saxe
- the SAXException to handleprotected void comment(java.lang.String comment)
comment
- the commentprotected void startElement(java.lang.String tagName)
tagName
- tag name of the elementprotected void startElement(java.lang.String tagName, org.xml.sax.Attributes atts)
tagName
- tag name of the elementatts
- attributes to addprotected void endElement(java.lang.String tagName)
tagName
- tag name of the elementprotected void characters(java.lang.String text)
text
- the textprotected void addAttribute(java.lang.String name, java.lang.String value)
name
- name of the attributevalue
- value of the attributeprotected void addAttribute(java.lang.String name, int value)
name
- name of the attributevalue
- value of the attributeprotected void addAttribute(java.lang.String name, java.awt.geom.Rectangle2D rect)
name
- name of the attributerect
- a Rectangle2D to format and use as attribute valueprotected void addAreaAttributes(Area area)
area
- Area to extract attributes fromprotected void addTraitAttributes(Area area)
area
- Area to extract traits frompublic void startRenderer(java.io.OutputStream outputStream) throws java.io.IOException
Renderer
startRenderer
in class AbstractRenderer
Renderer.startRenderer(OutputStream)
public void stopRenderer() throws java.io.IOException
Renderer
stopRenderer
in class AbstractRenderer
Renderer.stopRenderer()
public void renderPage(PageViewport page) throws java.io.IOException, FOPException
Renderer
renderPage
in class AbstractRenderer
Renderer.renderPage(PageViewport)
public void startPageSequence(LineArea seqTitle)
Renderer
startPageSequence
in class AbstractRenderer
Renderer.startPageSequence(LineArea)
protected void renderRegionViewport(RegionViewport port)
AbstractRenderer
The region may clip the area and it establishes a position from where the region is placed.
renderRegionViewport
in class AbstractRenderer
AbstractRenderer.renderRegionViewport(RegionViewport)
protected void renderBeforeFloat(BeforeFloat bf)
AbstractRenderer
renderBeforeFloat
in class AbstractRenderer
AbstractRenderer.renderBeforeFloat(BeforeFloat)
protected void renderFootnote(Footnote footnote)
AbstractRenderer
renderFootnote
in class AbstractRenderer
AbstractRenderer.renderFootnote(Footnote)
protected void renderMainReference(MainReference mr)
AbstractRenderer
The main reference area contains a list of spans that are stacked on the page. The spans contain a list of normal flow reference areas that are positioned into columns.
renderMainReference
in class AbstractRenderer
AbstractRenderer.renderMainReference(MainReference)
protected void renderFlow(NormalFlow flow)
AbstractRenderer
renderFlow
in class AbstractRenderer
AbstractRenderer.renderFlow(NormalFlow)
protected void renderBlock(Block block)
AbstractRenderer
renderBlock
in class AbstractRenderer
AbstractRenderer.renderBlock(Block)
protected void renderLineArea(LineArea line)
AbstractRenderer
A line area may have grouped styling for its children such as underline, background.
renderLineArea
in class AbstractRenderer
AbstractRenderer.renderLineArea(LineArea)
protected void renderViewport(Viewport viewport)
AbstractRenderer
renderViewport
in class AbstractRenderer
AbstractRenderer.renderViewport(Viewport)
public void renderImage(Image image, java.awt.geom.Rectangle2D pos)
AbstractRenderer
renderImage
in class AbstractRenderer
AbstractRenderer
public void renderContainer(Container cont)
AbstractRenderer
renderContainer
in class AbstractRenderer
AbstractRenderer.renderContainer(Container)
public void renderForeignObject(ForeignObject fo, java.awt.geom.Rectangle2D pos)
renderForeignObject
in class AbstractRenderer
fo
- the foreign objectpos
- the position of the foreign objectAbstractRenderer.renderForeignObject(ForeignObject, Rectangle2D)
protected void renderCharacter(Character ch)
AbstractRenderer
renderCharacter
in class AbstractRenderer
AbstractRenderer.renderCharacter(Character)
protected void renderInlineSpace(Space space)
AbstractRenderer
renderInlineSpace
in class AbstractRenderer
AbstractRenderer.renderInlineSpace(Space)
protected void renderText(TextArea text)
AbstractRenderer
renderText
in class AbstractRenderer
AbstractRenderer.renderText(TextArea)
protected void renderWord(WordArea word)
AbstractRenderer
renderWord
in class AbstractRenderer
AbstractRenderer.renderWord(WordArea)
protected void renderSpace(SpaceArea space)
AbstractRenderer
renderSpace
in class AbstractRenderer
AbstractRenderer.renderSpace(SpaceArea)
protected void renderInlineParent(InlineParent ip)
AbstractRenderer
renderInlineParent
in class AbstractRenderer
AbstractRenderer.renderInlineParent(InlineParent)
protected void renderInlineBlockParent(InlineBlockParent ibp)
AbstractRenderer
renderInlineBlockParent
in class AbstractRenderer
AbstractRenderer.renderInlineBlockParent(InlineBlockParent)
protected void renderLeader(Leader area)
AbstractRenderer
renderLeader
in class AbstractRenderer
AbstractRenderer.renderLeader(Leader)
public java.lang.String getMimeType()
AbstractRenderer
getMimeType
in class AbstractRenderer
AbstractRenderer.getMimeType()
|
fop 0.90alpha1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |