ReportSection

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> [ jbreport overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

jbreport
Interface ReportSection

All Superinterfaces:: ReportElement

public interface ReportSection
extends ReportElement

This defines a logical group of elements inside a report.

Version:: $Revision: 1.1.1.1 $

Field Summary

static java.lang.String HTMLRenderer
          This constant is used to fetch an HTML renderer from the package

Fields inherited from interface jbreport.ReportElement

DEEP, SHALLOW

Method Summary

void addRenderer(java.lang.String rendererType, java.io.PrintWriter output)
          Add another renderer that will be used during traversal of the report.

ReportElement getBody()
          Returns the body element of this section

ReportElement getFooter()
          Returns the footer element of this section

ReportElement getHeader()
          Returns the header element of this section.

void render()
          Render the report using the given renderers.

void setBody(ReportElement elem)
          Adds a body element to this element.

void setBoundParamValue(java.lang.String paramName, java.lang.String value)
          This will create a binding that will be used during report creation to substitute a variable with the given parameter.

void setFooter(ReportElement elem)
          Adds a footer element to this element.

void setHeader(ReportElement elem)
          Adds a header element to this element.

Methods inherited from interface jbreport.ReportElement

boundParameters, copy, copy, getBoundParamValue, getElement, getFactory, getList, getName, getParent, getRepository, getString, getStylesheet, getType, loadData, setParent, setString, xmlEnd, xmlEndChild, xmlInitialize

Field Detail

HTMLRenderer

public static final java.lang.String HTMLRenderer

This constant is used to fetch an HTML renderer from the package

See Also:: Constant Field Values

Method Detail

addRenderer

public void addRenderer(java.lang.String rendererType,
                        java.io.PrintWriter output)

Add another renderer that will be used during traversal of the report.

setBoundParamValue

public void setBoundParamValue(java.lang.String paramName,
                               java.lang.String value)

This will create a binding that will be used during report creation to substitute a variable with the given parameter.

render

public void render()
            throws ReportException

Render the report using the given renderers.

setHeader

public void setHeader(ReportElement elem)

Adds a header element to this element. Some element types might not allow children.

getHeader

public ReportElement getHeader()

Returns the header element of this section.

setBody

public void setBody(ReportElement elem)

Adds a body element to this element. Some element types might not allow children.

getBody

public ReportElement getBody()

Returns the body element of this section

setFooter

public void setFooter(ReportElement elem)

Adds a footer element to this element. Some element types might not allow children.

getFooter

public ReportElement getFooter()

Returns the footer element of this section