com.crystaldecisions.sdk.occa.report.definition
Interface ISection

All Superinterfaces:
IClone
All Known Implementing Classes:
Section

public interface ISection
extends IClone

This interface is used to get and set information and formatting for a section of the report. Report areas contain at least one section. Each section within an area can be formatted differently. This object holds on to a report object, then releases the report object when it is destroyed.

Report objects can only be added to a section. Boxes and lines can cross section boundaries, but other objects cannot. When you want to add a report object, you do so by adding it to a section using the appropriate controller.


Method Summary
 ISectionFormat getFormat()
          Returns the section format.
 int getHeight()
          Returns the height of the section.
 AreaSectionKind getKind()
          Returns AreaSectionKind that identifies the kind of section.
 java.lang.String getName()
          Returns the name of the section.
 ReportObjects getReportObjects()
          Returns the report objects for the section.
 int getSectionCode()
          Returns the section code.
 int getWidth()
          Returns the width of the section.
 void setFormat(ISectionFormat sectionFormat)
          Sets the section format.
 void setHeight(int height)
          Sets the height of the section.
 void setKind(AreaSectionKind kind)
          Sets the kind of section.
 void setName(java.lang.String name)
          Sets the name of the section.
 void setReportObjects(ReportObjects reportObjects)
          Set the report objects for the section.
 void setSectionCode(int sectionCode)
          Sets the section code.
 void setWidth(int width)
          Sets the width of the section.
 

Method Detail

getFormat

ISectionFormat getFormat()

Returns the section format.

Returns:
The section kind as an ISectionFormat.

getHeight

int getHeight()

Returns the height of the section.

Returns:
The height of the section as an int in twips.

getKind

AreaSectionKind getKind()

Returns AreaSectionKind that identifies the kind of section.

Returns:
The section kind as an AreaSectionKind.

getName

java.lang.String getName()

Returns the name of the section.

Returns:
The name of the section as a String.

getReportObjects

ReportObjects getReportObjects()

Returns the report objects for the section.

Returns:
The report objects for the section as ReportObjects.

getSectionCode

int getSectionCode()

Returns the section code. The section code is an int that is used to identify sections within a report.

Returns:
The section code as an int.

getWidth

int getWidth()

Returns the width of the section.

Returns:
The width of the section as an int in twips.

setFormat

void setFormat(ISectionFormat sectionFormat)

Sets the section format.

Parameters:
sectionFormat - The section kind as an ISectionFormat.

setHeight

void setHeight(int height)

Sets the height of the section.

Parameters:
height - The height of the section as an int in twips.

setKind

void setKind(AreaSectionKind kind)

Sets the kind of section.

Parameters:
kind - The section kind as an AreaSectionKind.

setName

void setName(java.lang.String name)

Sets the name of the section.

Parameters:
name - The name of the section as a String.

setReportObjects

void setReportObjects(ReportObjects reportObjects)

Set the report objects for the section.

Parameters:
reportObjects - The report objects for the section as ReportObjects.

setSectionCode

void setSectionCode(int sectionCode)

Sets the section code. The section code is an int that is used to identify sections within a report.

Parameters:
sectionCode - The section code as an int.

setWidth

void setWidth(int width)

Sets the width of the section.

Parameters:
width - The width of the section as an int in twips.