Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

jbreport.core
Class Document  view Document download Document.java

java.lang.Object
  extended byjbreport.core.AbstractReportElement
      extended byjbreport.core.ReportSectionImpl
          extended byjbreport.core.Document
All Implemented Interfaces:
java.lang.Cloneable, jbreport.ReportElement, jbreport.ReportSection, Traversable, XMLAware

class Document
extends ReportSectionImpl

Represents a complete document that can be rendered to produce a valid output result. This would be the equivalent of an html page, acrobat document, etc.

Version:
$Revision: 1.1 $

Field Summary
private  boolean dataLoaded
          Has the data been loaded already?
 
Fields inherited from class jbreport.core.ReportSectionImpl
 
Fields inherited from class jbreport.core.AbstractReportElement
attrType, cdata, className, elementType, factory, name, xmlHandler
 
Fields inherited from interface jbreport.ReportSection
HTMLRenderer
 
Fields inherited from interface jbreport.ReportElement
DEEP, SHALLOW
 
Constructor Summary
(package private) Document()
           
 
Method Summary
 void accept(ReportVisitor visitor, ReportVisitorState state)
          This defines the operation that the Traversable instance must perform at each node in the traversal.
 void loadData()
          This will initiate the loading of the data into the report.
 
Methods inherited from class jbreport.core.ReportSectionImpl
addRenderer, copy, getBody, getBoundParamValue, getFooter, getHeader, render, setBody, setBoundParamValue, setFooter, setHeader, updateData, xmlEnd, xmlEndChild, xmlInitialize
 
Methods inherited from class jbreport.core.AbstractReportElement
assert, assertNotNull, boundParameters, breakEventNotify, clone, copy, getElement, getFactory, getList, getName, getParent, getRepository, getString, getStylesheet, getType, inOrderIterator, inOrderTraverse, postOrderIterator, postOrderTraverse, preLoadData, preOrderIterator, preOrderTraverse, setParent, setString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface jbreport.ReportElement
boundParameters, copy, getElement, getFactory, getList, getName, getParent, getRepository, getString, getStylesheet, getType, setParent, setString
 

Field Detail

dataLoaded

private boolean dataLoaded
Has the data been loaded already?

Constructor Detail

Document

Document()
Method Detail

accept

public void accept(ReportVisitor visitor,
                   ReportVisitorState state)
            throws jbreport.ReportException
Description copied from interface: Traversable
This defines the operation that the Traversable instance must perform at each node in the traversal. It should be coded such that it calls an appropriate method on the ReportVisitor instance. Should an appropriate method not exist, one should be coded.

The accept method should not recurse into its children, it is the contract of the iterator to perform that function.

eg:- For node type Section the method on this node should be as follows.

   public void accept(ReportVisitor visitor, ReportVisitorState state) 
      throws ReportException {
      visitor.visitSection(this, state);
   }

Specified by:
accept in interface Traversable
Overrides:
accept in class ReportSectionImpl

loadData

public void loadData()
              throws jbreport.ReportException
Description copied from interface: jbreport.ReportElement
This will initiate the loading of the data into the report.

Specified by:
loadData in interface jbreport.ReportElement
Overrides:
loadData in class ReportSectionImpl