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

All Known Subinterfaces:
IAreaFormat, IDetailAreaFormat, IGroupAreaFormat, IPageAreaFormat, ISectionFormat
All Known Implementing Classes:
AreaFormat, DetailAreaFormat, GroupAreaFormat, PageAreaFormat, SectionFormat

public interface ISectionAreaFormat

The base interface for section and area format settings. Many options are shared in common between sections and areas.


Method Summary
 java.awt.Color getBackgroundColor()
           Returns the color for the background of the report.
 SectionAreaFormatConditionFormulas getConditionFormulas()
           Returns the conditional formulas as SectionAreaFormatConditionFormulas.
 boolean getEnableKeepTogether()
           Returns whether the section is printed on the same page as the preceding section.
 boolean getEnableNewPageAfter()
           Returns whether a new page is inserted after the section.
 boolean getEnableNewPageBefore()
           Returns whether a new page is inserted before the section.
 boolean getEnablePrintAtBottomOfPage()
           Returns whether each group value is printed only at the bottom of the page.
 boolean getEnableResetPageNumberAfter()
           Returns whether the page number is reset to 1 after the section.
 boolean getEnableSuppress()
           Returns whether the section is suppressed.
 void setBackgroundColor(java.awt.Color backgroundColor)
           Sets the color for the background of the report.
 void setConditionFormulas(SectionAreaFormatConditionFormulas conditionFormulas)
           Sets the conditional formulas as SectionAreaFormatConditionFormulas.
 void setEnableKeepTogether(boolean enableKeepTogether)
           Sets whether the section is printed on the same page as the preceding section.
 void setEnableNewPageAfter(boolean enableNewPageAfter)
           Sets whether a new page is inserted after the section.
 void setEnableNewPageBefore(boolean enableNewPageBefore)
           Sets whether a new page is inserted before the section.
 void setEnablePrintAtBottomOfPage(boolean enablePrintAtBottomOfPage)
           Sets whether each group value is printed only at the bottom of the page.
 void setEnableResetPageNumberAfter(boolean enableResetPageNumberAfter)
           Sets whether the page number is reset to 1 after the section.
 void setEnableSuppress(boolean enableSuppress)
           Sets whether the section is suppressed.
 

Method Detail

getConditionFormulas

SectionAreaFormatConditionFormulas getConditionFormulas()

Returns the conditional formulas as SectionAreaFormatConditionFormulas. Conditional formulas are used to override the regular format settings.

Returns:
Conditional formulas as SectionAreaFormatConditionFormulas.

getBackgroundColor

java.awt.Color getBackgroundColor()

Returns the color for the background of the report.

Returns:
The color as a java.awt.Color object.

getEnableSuppress

boolean getEnableSuppress()

Returns whether the section is suppressed. If the section is suppressed, it will not appear when the report is displayed or printed.

Returns:
true if the section is suppressed, and otherwise false.

getEnableKeepTogether

boolean getEnableKeepTogether()

Returns whether the section is printed on the same page as the preceding section.

Returns:
true if the section is printed on the same page as the preceding section, and otherwise false.

getEnableNewPageAfter

boolean getEnableNewPageAfter()

Returns whether a new page is inserted after the section.

Returns:
true if a new page is inserted after the section, and otherwise false.

getEnableNewPageBefore

boolean getEnableNewPageBefore()

Returns whether a new page is inserted before the section.

Returns:
true if a new page is inserted before the section, and otherwise false.

getEnablePrintAtBottomOfPage

boolean getEnablePrintAtBottomOfPage()

Returns whether each group value is printed only at the bottom of the page.

Returns:
true if each group value is printed only at the bottom of the page, and otherwise false.

getEnableResetPageNumberAfter

boolean getEnableResetPageNumberAfter()

Returns whether the page number is reset to 1 after the section.

Returns:
true if the page number is reset to 1 after the section, and otherwise false.

setConditionFormulas

void setConditionFormulas(SectionAreaFormatConditionFormulas conditionFormulas)

Sets the conditional formulas as SectionAreaFormatConditionFormulas. Conditional formulas are used to override the section's format settings.

Parameters:
conditionFormulas - Conditional formulas as SectionAreaFormatConditionFormulas.

setBackgroundColor

void setBackgroundColor(java.awt.Color backgroundColor)

Sets the color for the background of the report.

Parameters:
backgroundColor - The color as a java.awt.Color object.

setEnableSuppress

void setEnableSuppress(boolean enableSuppress)

Sets whether the section is suppressed. If the section is suppressed, it will not appear when the report is displayed or printed.

Parameters:
enableSuppress - true if the section is suppressed, and otherwise false.

setEnableKeepTogether

void setEnableKeepTogether(boolean enableKeepTogether)

Sets whether the section is printed on the same page as the preceding section.

Parameters:
enableKeepTogether - true if the section is printed on the same page as the preceding section, and otherwise false.

setEnableNewPageAfter

void setEnableNewPageAfter(boolean enableNewPageAfter)

Sets whether a new page is inserted after the section.

Parameters:
enableNewPageAfter - true if a new page is inserted after the section, and otherwise false.

setEnableNewPageBefore

void setEnableNewPageBefore(boolean enableNewPageBefore)

Sets whether a new page is inserted before the section.

Parameters:
enableNewPageBefore - true if a new page is inserted before the section, and otherwise false.

setEnablePrintAtBottomOfPage

void setEnablePrintAtBottomOfPage(boolean enablePrintAtBottomOfPage)

Sets whether each group value is printed only at the bottom of the page.

Parameters:
enablePrintAtBottomOfPage - true if each group value is printed only at the bottom of the page, and otherwise false.

setEnableResetPageNumberAfter

void setEnableResetPageNumberAfter(boolean enableResetPageNumberAfter)

Sets whether the page number is reset to 1 after the section.

Parameters:
enableResetPageNumberAfter - true if the page number is reset to 1 after the section, and otherwise false.