Save This Page
Home » pentaho-reporting-engine-classic-0.8.10 » org.jfree.report.modules.output.table » html » [javadoc | source]
org.jfree.report.modules.output.table.html
public class: HtmlProducer [javadoc | source]
java.lang.Object
   org.jfree.report.modules.output.table.base.TableProducer
      org.jfree.report.modules.output.table.html.HtmlProducer
The TableProducer is responsible for creating the produced Table. After the writer has finished the band layout process, the layouted bands are forwarded into the TableProducer. The TableProducer coordinates the cell creation process and collects the generated TableCellData. The raw CellData objects are later transformed into a TableGridLayout.

The generated HTML code is cached and written after the last cell was created, to insert the StyleSheet into the html header.

Field Summary
public static final  String GENERATE_XHTML    The configuration key that defines whether to generate XHTML code. 
public static final  String ENCODING    the fileencoding for the main html file. 
public static final  String ENCODING_DEFAULT    a default value for the fileencoding of the main html file. 
public static final  String BODY_FRAGMENT    The property key to define whether to build a html body fragment. 
Fields inherited from org.jfree.report.modules.output.table.base.TableProducer:
TITLE,  AUTHOR,  CREATOR
Constructor:
 public HtmlProducer(HtmlLayoutInfo layoutInfo,
    boolean strict) 
    Creates a new HTMLProducer. This producer uses the precomputed layout to generate the output.
    Parameters:
    layoutInfo - the precomputed table layout information used to create the report.
    strict - a flag whether to use the strict layout mode.
 public HtmlProducer(HtmlFilesystem filesystem,
    HtmlLayoutInfo layoutInfo) 
    Creates a new HTMLProducer. This producer will perform the layouting but will not produce any output.
    Parameters:
    filesystem - the filesystem used to store the generated content.
    layoutInfo - the layout info used to store the generated layoutinformation.
Method from org.jfree.report.modules.output.table.html.HtmlProducer Summary:
beginPage,   close,   commit,   configure,   createHtmlBackgroundStyle,   endPage,   getCellDataFactory,   getEncoding,   getEntityParser,   getHtmlLayoutInfo,   isCreateBodyFragment,   isGenerateXHTML,   isOpen,   open,   setCreateBodyFragment
Methods from org.jfree.report.modules.output.table.base.TableProducer:
addCell,   beginPage,   clearCells,   clearCellsBounds,   close,   commit,   configure,   createCellBounds,   createJoinedCellBackground,   endPage,   getCellDataFactory,   getGridBoundsCollection,   getPage,   getProperty,   getProperty,   getPropertyNames,   isDummy,   isGlobalLayout,   isLayoutContainsContent,   isOpen,   isStrictLayout,   layoutGrid,   open,   processBand,   setProperty
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.jfree.report.modules.output.table.html.HtmlProducer Detail:
 public  void beginPage(String name) 
    Start a new page, start a new table.
 public  void close() 
    Closes the target and writes all generated content into the root stream of the filesystem after generating the StyleSheet information.
 public  void commit() 
    End the printing of an section and creates the html content for that section.
 public  void configure(Properties configuration) 
    Configures the table producer by reading the configuration settings from the given map.
 protected String createHtmlBackgroundStyle(TableCellBackground bg) 
    Merges the backgrounds and creates the StyleSheet information for the cell background.
 public  void endPage() 
    End the page and closes the generated table of the page.
 public TableCellDataFactory getCellDataFactory() 
    Gets the TableProducer implementation of this TableProducer.
 public String getEncoding() 
    Gets the defined file encoding for the main html file.
 public static CharacterEntityParser getEntityParser() 
    Gets the character entity parser for HTML content. The CharacterEntity parser translates known characters into predefined entities.
 protected HtmlLayoutInfo getHtmlLayoutInfo() 
    Returns the html layout info instance used to compute the layout.
 public boolean isCreateBodyFragment() 
    Checks, whether to create a html body fragment. This fragment contains no html header an generates no global CSS section.
 protected boolean isGenerateXHTML() 
    Checks, whether this target should generate XHTML instead of HTML4 code.
 public boolean isOpen() 
    Returns true, if the TableProducer is open. Only open producers are able to write TableCells or to create TableCellData from Elements.
 public  void open() 
    Starts the report writing and prepares the cached output stream.
 public  void setCreateBodyFragment(boolean createBodyFragment) 
    Defines, whether to create a html body fragment. This fragment contains no html header an generates no global CSS section.