jimm.datavision.layout
Class XMLLE

java.lang.Object
  jimm.datavision.layout.LayoutEngine
      jimm.datavision.layout.SortedLayoutEngine
          jimm.datavision.layout.XMLLE

public class XMLLE
extends SortedLayoutEngine

An XML layout engine.

Author:

Jim Menard, jimm@io.com

Field Summary

protected java.lang.String	encoding
protected XMLWriter	iout

Fields inherited from class jimm.datavision.layout.SortedLayoutEngine

comp, sectionFields

Fields inherited from class jimm.datavision.layout.LayoutEngine

currentSection, newPage, out, pageHeight, pageHeightUsed, pageNumber, pageWidth, POINTS_PER_INCH, previousSectionArea, report, SECT_DETAIL, SECT_GROUP_FOOTER, SECT_GROUP_HEADER, SECT_PAGE_FOOTER, SECT_PAGE_HEADER, SECT_REPORT_FOOTER, SECT_REPORT_HEADER, wantsMoreData

Constructor Summary

XMLLE(XMLWriter out)
Constructor.

XMLLE(XMLWriter out, java.lang.String enc)
Constructor.

Method Summary

protected void	doEnd() Called by end as a chance to insert behavior when the report ends.
protected void	doOutputField(Field field) Called by outputField as a chance to insert behavior when a field is output.
protected void	doOutputImage(ImageField image) Called by outputImage as a chance to insert behavior when a image is output.
protected void	doOutputLine(Line l) Called by outputLine as a chance to insert behavior when a line is output.
protected void	doOutputSection(Section s) This override iterates over a list of fields that have been sorted by their y and x coordinates.
protected void	doStart() Called by start as a chance to insert behavior when the report starts.
protected void	doStartPage() Called by startPage as a chance to insert behavior when a new page starts.

Methods inherited from class jimm.datavision.layout.SortedLayoutEngine

buildSectionFields

Methods inherited from class jimm.datavision.layout.LayoutEngine

calcDetailHeight, calcPageFooterHeight, calcReportFooterHeight, calcSectionHeights, cancel, checkRemainingPageLength, closeOutput, currentSectionTypeAsString, detail, doEndPage, end, endPage, groupFooters, groupHeaders, outputField, outputImage, outputLine, outputSection, pageHeight, pageNumber, pageWidth, setReport, start, startPage, wantsMoreData

Methods inherited from class java.lang.Object

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

Field Detail

iout

protected XMLWriter iout

encoding

protected java.lang.String encoding

Constructor Detail

XMLLE

public XMLLE(XMLWriter out)

Constructor.

Parameters:

out - an indent writer

XMLLE

public XMLLE(XMLWriter out,
             java.lang.String enc)

Constructor. Optionally specify the encoding string to write to the XML file. This string is written as the XMLDecl encoding attribute. Use legal XML values like "UTF-8", not Java values like "UTF8".

Parameters:

out - an indent writer

enc - an XML encoding string; if null, uses Report.XML_ENCODING_ATTRIBUTE

Method Detail

doStart

protected void doStart()

Description copied from class: LayoutEngine

Called by start as a chance to insert behavior when the report starts.

Overrides:

doStart in class LayoutEngine

doEnd

protected void doEnd()

Description copied from class: LayoutEngine

Called by end as a chance to insert behavior when the report ends.

Overrides:

doEnd in class LayoutEngine

doStartPage

protected void doStartPage()

Description copied from class: LayoutEngine

Called by startPage as a chance to insert behavior when a new page starts.

Overrides:

doStartPage in class LayoutEngine

doOutputSection

protected void doOutputSection(Section s)

Description copied from class: SortedLayoutEngine

This override iterates over a list of fields that have been sorted by their y and x coordinates. Put another way, the fields are output top to bottom, left to right.

Overrides:

doOutputSection in class SortedLayoutEngine

Parameters:

s - a section

doOutputField

protected void doOutputField(Field field)

Description copied from class: LayoutEngine

Called by outputField as a chance to insert behavior when a field is output.

Specified by:

doOutputField in class LayoutEngine

Parameters:

field - a field

doOutputImage

protected void doOutputImage(ImageField image)

Description copied from class: LayoutEngine

Called by outputImage as a chance to insert behavior when a image is output.

Specified by:

doOutputImage in class LayoutEngine

Parameters:

image - an image field

doOutputLine

protected void doOutputLine(Line l)

Description copied from class: LayoutEngine

Called by outputLine as a chance to insert behavior when a line is output.

Specified by:

doOutputLine in class LayoutEngine

Parameters:

l - a line