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

All Superinterfaces:
IClone
All Known Subinterfaces:
IMultiColumnArea
All Known Implementing Classes:
Area, MultiColumnArea

public interface IArea
extends IClone

This interface manipulates an area in a report. An area is a group of like sections in the report (for example, Details A--Da, Details B--Db, and so on) that all share the same characteristics. Each section within the area can be formatted differently. This interface allows you to retrieve information and set options for a specified area in your report.


Method Summary
 IAreaFormat getFormat()
           Returns the format of the area.
 AreaSectionKind getKind()
           Returns the type (kind) of area (for example, Details, Report Header, Page Footer, and so on).
 java.lang.String getName()
           Returns the area name.
 Sections getSections()
           Returns the sections of the area.
 void setFormat(IAreaFormat areaFormat)
           Sets the format of the area.
 void setKind(AreaSectionKind kind)
           Sets the type (kind) of area (for example, Details, Report Header, Page Footer, and so on).
 void setName(java.lang.String name)
           Sets the area name.
 void setSections(Sections sections)
           Sets the sections of the area.
 

Method Detail

getFormat

IAreaFormat getFormat()

Returns the format of the area.

Returns:
An IAreaFormat object that specifies the format of the area.

getKind

AreaSectionKind getKind()

Returns the type (kind) of area (for example, Details, Report Header, Page Footer, and so on).

Returns:
An AreaSectionKind object that specifies the kind of area.

getName

java.lang.String getName()

Returns the area name.

Returns:
A String that specifies the area name.

getSections

Sections getSections()

Returns the sections of the area.

Returns:
A Sections object containing the sections of the area.

setFormat

void setFormat(IAreaFormat areaFormat)

Sets the format of the area.

Parameters:
areaFormat - An IAreaFormat object that specifies the format of the area.

setKind

void setKind(AreaSectionKind kind)

Sets the type (kind) of area (for example, Details, Report Header, Page Footer, and so on).

Parameters:
kind - An AreaSectionKind object that specifies the kind of area.

setName

void setName(java.lang.String name)

Sets the area name.

Parameters:
name - A String that specifies the area name.

setSections

void setSections(Sections sections)

Sets the sections of the area.

Parameters:
sections - A Sections object containing the sections of the area.