Style Intelligence v12.0

inetsoft.report.lens
Class DefaultSectionLens

java.lang.Object
  extended by inetsoft.report.lens.DefaultSectionLens
All Implemented Interfaces:
GroupableLayout, SectionLens, Serializable, Cloneable

public class DefaultSectionLens
extends Object
implements SectionLens, GroupableLayout

DefaultSectionLens is a default implementation of the SectionLens interface. It can be used to create a section lens for adding a section to a report. Since sections are normally created using the report designer, this classes is only used if a section needs to be created dynamically through API.

See Also:
Serialized Form

Nested Class Summary
static class DefaultSectionLens.SectionCellBindingInfo
          Section binding info.
 
Nested classes/interfaces inherited from interface inetsoft.report.SectionLens
SectionLens.Visitor
 
Field Summary
 
Fields inherited from interface inetsoft.report.SectionLens
CONTENT, FOOTER, HEADER
 
Constructor Summary
DefaultSectionLens()
          Create an empty section.
DefaultSectionLens(ReportSheet report)
          Create an empty section.
DefaultSectionLens(SectionBand header, SectionBand content, SectionBand footer)
          Create a plain section.
DefaultSectionLens(SectionBand header, SectionLens content, SectionBand footer)
          Create a nested section.
 
Method Summary
 Object clone()
          Clone this section.
 List getBandInfos()
          Get all bands infomations.
 CellBindingInfo getCellInfo(SectionBand band, String eid)
          Get a cell infomation.
 List getCellInfos(boolean all)
          Get all cell infomations for the layout.
 Object getSectionContent()
          Get the content of the section content.
 SectionBand[] getSectionFooter()
          Get the section footer frame.
 SectionBand[] getSectionHeader()
          Get the section header frame.
 void setSectionContent(SectionBand band)
          Set the section content band.
 void setSectionContent(SectionBand[] bands)
          Set the section content band.
 void setSectionContent(SectionLens nested)
          Set the section content band.
 void setSectionFooter(SectionBand band)
          Set the section footer band.
 void setSectionFooter(SectionBand[] bands)
          Set the section footer band.
 void setSectionHeader(SectionBand band)
          Set the section header band.
 void setSectionHeader(SectionBand[] bands)
          Set the section header band.
 String toString()
           
 void visit(SectionLens.Visitor visitor)
          Visit all bands in the section.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DefaultSectionLens

public DefaultSectionLens()
Create an empty section.


DefaultSectionLens

public DefaultSectionLens(ReportSheet report)
Create an empty section.


DefaultSectionLens

public DefaultSectionLens(SectionBand header,
                          SectionBand content,
                          SectionBand footer)
Create a plain section.


DefaultSectionLens

public DefaultSectionLens(SectionBand header,
                          SectionLens content,
                          SectionBand footer)
Create a nested section.

Method Detail

getSectionHeader

public SectionBand[] getSectionHeader()
Get the section header frame. If the section does not have a header frame, return null.

Specified by:
getSectionHeader in interface SectionLens
Returns:
array of header bands.

setSectionHeader

public void setSectionHeader(SectionBand band)
Set the section header band.


setSectionHeader

public void setSectionHeader(SectionBand[] bands)
Set the section header band.


getSectionContent

public 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.

Specified by:
getSectionContent in interface SectionLens
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.

setSectionContent

public void setSectionContent(SectionBand band)
Set the section content band.


setSectionContent

public void setSectionContent(SectionBand[] bands)
Set the section content band.


setSectionContent

public void setSectionContent(SectionLens nested)
Set the section content band.


getSectionFooter

public SectionBand[] getSectionFooter()
Get the section footer frame. If the section does not have a footer frame, return null.

Specified by:
getSectionFooter in interface SectionLens
Returns:
array of footer bands.

setSectionFooter

public void setSectionFooter(SectionBand band)
Set the section footer band.


setSectionFooter

public void setSectionFooter(SectionBand[] bands)
Set the section footer band.


visit

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

Specified by:
visit in interface SectionLens

clone

public Object clone()
Description copied from interface: SectionLens
Clone this section.

Specified by:
clone in interface SectionLens
Overrides:
clone in class Object

toString

public String toString()
Overrides:
toString in class Object

getBandInfos

public List getBandInfos()
Get all bands infomations.

Specified by:
getBandInfos in interface GroupableLayout

getCellInfos

public List getCellInfos(boolean all)
Get all cell infomations for the layout.

Specified by:
getCellInfos in interface GroupableLayout

getCellInfo

public CellBindingInfo getCellInfo(SectionBand band,
                                   String eid)
Get a cell infomation.


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