Style Intelligence v12.0

inetsoft.report
Interface SectionLens

All Superinterfaces:
Cloneable, Serializable
All Known Implementing Classes:
DefaultSectionLens

public interface SectionLens
extends Serializable, Cloneable

A SectionLens represents a section element. A section can have a header band, footer band, and a content band. The content band is required, and the other two bands are optional. The content band can contain another section, which is called a nested section.

A section can be used to display the contents of a TableLens, in which case the section header corresponds to the table header, and is repeated at the top of each page. The section content corresponds to rows in the table, and is repeated for each row. The section footer corresponds to the group summary if the table is a grouped table.

A section can also be used to present fixed position elements, where the contents of the elements are statis or bound at runtime individually to each element. The header and footer normally don't apply in this situation.


Nested Class Summary
static interface SectionLens.Visitor
          Visitor to all bands in the section.
 
Field Summary
static String CONTENT
          Section content type.
static String FOOTER
          Section footer type.
static String HEADER
          Section header type.
 
Method Summary
 Object clone()
          Clone this section.
 Object getSectionContent()
          Get the content of the section content.
 SectionBand[] getSectionFooter()
          Get the section footer frame.
 SectionBand[] getSectionHeader()
          Get the section header frame.
 void visit(SectionLens.Visitor visitor)
          Visit all bands in the section.
 

Field Detail

HEADER

static final String HEADER
Section header type.

See Also:
Constant Field Values

CONTENT

static final String CONTENT
Section content type.

See Also:
Constant Field Values

FOOTER

static final String FOOTER
Section footer type.

See Also:
Constant Field Values
Method Detail

getSectionHeader

SectionBand[] getSectionHeader()
Get the section header frame. If the section does not have a header frame, return null. A section header can be a single section band, or an array or section band.

Returns:
array of header bands.

getSectionContent

Object getSectionContent()
Get the content of the section content. The content could be an array of SectionBand or a SectionLens. If a SectionLens is returned, the returned section is nested in this section.

Returns:
SectionLens if there is nested section and this is not the inner most section, or array of SectionBand if this is the inner most section.

getSectionFooter

SectionBand[] getSectionFooter()
Get the section footer frame. If the section does not have a footer frame, return null. A section footer can be a single section band, or an array or section band.

Returns:
array of footer bands.

clone

Object clone()
Clone this section.


visit

void visit(SectionLens.Visitor visitor)
Visit all bands in the section.


Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.