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

All Superinterfaces:
IClone, ISectionAreaFormat
All Known Subinterfaces:
IGroupAreaFormat
All Known Implementing Classes:
AreaFormat, GroupAreaFormat

public interface IAreaFormat
extends ISectionAreaFormat, IClone

This interface enables you to specify the format of the area dynamically when the report is displayed.


Method Summary
 boolean getEnableClampPageFooter()
           Returns if clamp page footer is enabled, used for customized pagination.
 boolean getEnableHideForDrillDown()
           Returns whether the area will be hidden (though the area is still available for drill down).
 int getVisibleRecordNumberPerPage()
           Returns a value indicating the number of visible records per page, used for customized pagination.
 void setEnableClampPageFooter(boolean enableClampPageFooter)
           Sets if the clamp page footer will be enabled, used for customized pagination.
 void setEnableHideForDrillDown(boolean enableHideForDrillDown)
           Sets whether the area will be hidden (though the area is still available for drill down).
 void setVisibleRecordNumberPerPage(int visibleRecordNumberPerPage)
           Sets a non-negative value indicating the number of visible records per page, used for customized pagination.
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.definition.ISectionAreaFormat
getBackgroundColor, getConditionFormulas, getEnableKeepTogether, getEnableNewPageAfter, getEnableNewPageBefore, getEnablePrintAtBottomOfPage, getEnableResetPageNumberAfter, getEnableSuppress, setBackgroundColor, setConditionFormulas, setEnableKeepTogether, setEnableNewPageAfter, setEnableNewPageBefore, setEnablePrintAtBottomOfPage, setEnableResetPageNumberAfter, setEnableSuppress
 

Method Detail

getEnableHideForDrillDown

boolean getEnableHideForDrillDown()

Returns whether the area will be hidden (though the area is still available for drill down).

Returns:
true if the area will be hidden, and false otherwise.

setEnableHideForDrillDown

void setEnableHideForDrillDown(boolean enableHideForDrillDown)

Sets whether the area will be hidden (though the area is still available for drill down).

Parameters:
enableHideForDrillDown - true if the area will be hidden, and false otherwise.

getVisibleRecordNumberPerPage

int getVisibleRecordNumberPerPage()

Returns a value indicating the number of visible records per page, used for customized pagination. This feature applies only to visible records. Suppressed records may be contained on a page, but will not count toward visible records. This property can only be applied to the DetailArea section of a report.

Note: By default, the VisibleRecordNumberPerPage property is set to 0, indicating that paging is not determined by the number of visible records.

Returns:
int that indicates the number of records that are visible on each page.

getEnableClampPageFooter

boolean getEnableClampPageFooter()

Returns if clamp page footer is enabled, used for customized pagination. The clamp page pooter removes any extra white space between the report details and the page footer.

Note: The clamp page footer can only be enabled in the PageFooter section of a report.

Returns:
true if clamping page footer is enabled, and false otherwise.

setVisibleRecordNumberPerPage

void setVisibleRecordNumberPerPage(int visibleRecordNumberPerPage)

Sets a non-negative value indicating the number of visible records per page, used for customized pagination. This feature applies only to visible records. Suppressed records may be contained on a page, but will not count toward visible records. This property can only be applied to the DetailArea section of a report.

Note: By default, the VisibleRecordNumberPerPage property is set to 0, indicating that paging is not determined by the number of visible records.

Parameters:
visibleRecordNumberPerPage - an int object.

setEnableClampPageFooter

void setEnableClampPageFooter(boolean enableClampPageFooter)

Sets if the clamp page footer will be enabled, used for customized pagination. The clamp page pooter removes any extra white space between the report details and the page footer.

Note: The clamp page footer can only be enabled in the PageFooter section of a report.

Parameters:
enableClampPageFooter - true if clamping page footer is enabled, and false otherwise.