Style Intelligence v12.0

inetsoft.report
Interface SectionElement

All Superinterfaces:
Cloneable, ReportElement, Serializable

public interface SectionElement
extends ReportElement

A section is composed of a header, footer, and section content. Section content may be a simple band, or nested with header and footer. A section is normally used to present a table or grouping. Section band is repeated for each table row.

Since each element in a section band is positioned at a fixed location, section can also be used as a container. This may be useful for reports or section of reports where elements positions must be accurately controlled.


Field Summary
 
Fields inherited from interface inetsoft.report.ReportElement
AGGREGATE, AUTOSIZE, GROW, LOCAL_QUERY, QUERY, XNODEPATH
 
Method Summary
 void addFormat(Class type, Format format)
          Add a format to a data type.
 void addPresenter(Class type, Presenter presenter)
          Add a presenter to a data type.
 ReportElement getElement(String id)
          Find an element in the section with the specified ID.
 ReportElement[] getElements()
          Find all elements in the section.
 Format getFormat(Class type)
          Get the format object registered for this class or one of it's super classes.
 Presenter getPresenter(Class type)
          Get the presenter object registered for this class or one of it's super classes.
 ReportSheet getReport()
          Find the report.
 SectionLens getSection()
          Get the section lens.
 TableLens getTable()
          Get the table lens.
 boolean isAdhocEnabled()
          Check if adhoc query is enabled on this element.
 void setAdhocEnabled(boolean enabled)
          Set whether adhoc query is enabled on this element.
 void setSection(SectionLens section)
          Set the section lens.
 void setTable(TableLens table)
          Set the table lens.
 
Methods inherited from interface inetsoft.report.ReportElement
clone, getAlignment, getBackground, getCSSClass, getFont, getForeground, getFullName, getID, getIndent, getOnClick, getPreferredSize, getProperty, getPropertyNames, getScript, getSpacing, getTarget, getType, getUserObject, isHideOnPrint, isKeepWithNext, isVisible, setAlignment, setBackground, setContext, setCSSClass, setFont, setForeground, setFullName, setHideOnPrint, setID, setIndent, setKeepWithNext, setOnClick, setProperty, setScript, setSpacing, setTarget, setUserObject, setVisible
 

Method Detail

getSection

SectionLens getSection()
Get the section lens.


setSection

void setSection(SectionLens section)
Set the section lens. A section lens specifies the elements in a section, and their properties and binding. It does not contain the actual data.


getTable

TableLens getTable()
Get the table lens.


setTable

void setTable(TableLens table)
Set the table lens. The table lens is used to get data to be presented by section fields. The table can be a simple table lens, or a grouped table. If a grouped table is used, the section lens must have the same nesting level as the grouping columns.


getElement

ReportElement getElement(String id)
Find an element in the section with the specified ID.

Parameters:
id - element id.

getElements

ReportElement[] getElements()
Find all elements in the section.


getReport

ReportSheet getReport()
Find the report.


getPresenter

Presenter getPresenter(Class type)
Get the presenter object registered for this class or one of it's super classes.

Parameters:
type - class to search for.
Returns:
the presenter for this object.

addPresenter

void addPresenter(Class type,
                  Presenter presenter)
Add a presenter to a data type.

Parameters:
type - data type the presenter is for.
presenter - presenter for the data type.

getFormat

Format getFormat(Class type)
Get the format object registered for this class or one of it's super classes.

Parameters:
type - class to search for.
Returns:
the format for this object.

addFormat

void addFormat(Class type,
               Format format)
Add a format to a data type.

Parameters:
type - data type the format is for.
format - format for the data type.

isAdhocEnabled

boolean isAdhocEnabled()
Check if adhoc query is enabled on this element.


setAdhocEnabled

void setAdhocEnabled(boolean enabled)
Set whether adhoc query is enabled on this element.


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