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

All Superinterfaces:
IAreaFormat, IClone, ISectionAreaFormat
All Known Implementing Classes:
GroupAreaFormat

public interface IGroupAreaFormat
extends IAreaFormat

This interface enables you to get and set behavior for printing the group header and the group area.


Method Summary
 boolean getEnableKeepGroupTogether()
           Returns true if the group area will be printed on the same page, and false otherwise.
 boolean getEnableRepeatGroupHeader()
           Returns true if the group header will be printed on each page, and false otherwise.
 int getVisibleGroupNumberPerPage()
           Gets a value indicating the number of visible groups per page.
 void setEnableKeepGroupTogether(boolean enableKeepGroupTogether)
           Sets whether the group area will be printed on the same page.
 void setEnableRepeatGroupHeader(boolean enableRepeatGroupHeader)
           Sets whether the group header will be printed on each page.
 void setVisibleGroupNumberPerPage(int visibleGroupNumberPerPage)
           Sets a non-negative value indicating the number of visible groups per page.
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.definition.IAreaFormat
getEnableClampPageFooter, getEnableHideForDrillDown, getVisibleRecordNumberPerPage, setEnableClampPageFooter, setEnableHideForDrillDown, setVisibleRecordNumberPerPage
 
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

getEnableKeepGroupTogether

boolean getEnableKeepGroupTogether()

Returns true if the group area will be printed on the same page, and false otherwise.

Returns:
true if the group area will be printed on the same page, and false otherwise.

getEnableRepeatGroupHeader

boolean getEnableRepeatGroupHeader()

Returns true if the group header will be printed on each page, and false otherwise.

Returns:
true if the group header will be printed on each page, and false otherwise.

getVisibleGroupNumberPerPage

int getVisibleGroupNumberPerPage()

Gets a value indicating the number of visible groups per page.

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

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

setEnableKeepGroupTogether

void setEnableKeepGroupTogether(boolean enableKeepGroupTogether)

Sets whether the group area will be printed on the same page.

Parameters:
enableKeepGroupTogether - true if the group area will be printed on the same page, and false otherwise.

setEnableRepeatGroupHeader

void setEnableRepeatGroupHeader(boolean enableRepeatGroupHeader)

Sets whether the group header will be printed on each page.

Parameters:
enableRepeatGroupHeader - true if the group header will be printed on each page, and false otherwise.

setVisibleGroupNumberPerPage

void setVisibleGroupNumberPerPage(int visibleGroupNumberPerPage)

Sets a non-negative value indicating the number of visible groups per page.

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

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