com.crystaldecisions.sdk.occa.report.application
Class ReportAreaController

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.application.ReportAreaController

public class ReportAreaController
extends java.lang.Object

This object is used to set the properties for areas in the report. Report areas are predefined; that is, all reports have a report header and footer, a page header and footer, and a details area. In addition, a group header and footer are automatically created whenever a group is added to the report. Although you cannot manually add or delete areas in the report, you can format and rename them using the setProperty method.

Area objects are defined in the definition package, and can be accessed by using the ReportDefinition object.


Field Summary
static java.lang.String AREA_PROP_FORMAT
           Specifies a report area format property.
static java.lang.String AREA_PROP_LINKEDURI
           Specifies a report area linked URI property.
static java.lang.String AREA_PROP_NAME
           Specifies the name property for report area.
 
Method Summary
 void setProperty(IArea area, ReportAreaPropertyEnum propID, java.lang.Object value)
           Sets the properties for an area in the report.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

AREA_PROP_NAME

public static final java.lang.String AREA_PROP_NAME

Specifies the name property for report area.

See Also:
Constant Field Values

AREA_PROP_FORMAT

public static final java.lang.String AREA_PROP_FORMAT

Specifies a report area format property.

See Also:
Constant Field Values

AREA_PROP_LINKEDURI

public static final java.lang.String AREA_PROP_LINKEDURI

Specifies a report area linked URI property.

See Also:
Constant Field Values
Method Detail

setProperty

public void setProperty(IArea area,
                        ReportAreaPropertyEnum propID,
                        java.lang.Object value)
                 throws ReportSDKException

Sets the properties for an area in the report. Most objects are modified by copying the object, modifying the copy, and then using the appropriate controller to modify the original based on the changes you have made in the copy. Because areas consist of sections, and sections contain report objects, it is costly to copy the entire object. This method is used to modify a single property in the Area object.

Parameters:
area - The area whose property is being modified.
propID - The name of the property that is being modified. This value can be one of AREA_PROP_*.
value - The value that is being set for the property.
Throws:
ReportSDKException