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

All Superinterfaces:
IClone, ISectionAreaFormat
All Known Implementing Classes:
SectionFormat

public interface ISectionFormat
extends ISectionAreaFormat, IClone

This interface is used to specify the formatting for a section.


Method Summary
 int getBackgroundColorValue()
          Deprecated. internal use only
 java.lang.String getCssClass()
           Returns the specified class name for the report object.
 boolean getEnableRelativePositions()
          For internal use only
 boolean getEnableSuppressIfBlank()
           Returns whether the section is suppressed if it is blank.
 boolean getEnableUnderlaySection()
           Returns whether the section underlays to the following sections.
 PaperOrientation getPageOrientation()
          Returns the page orientation of a section, used for customized pagination.
 void setBackgroundColorValue(int backgroundColor)
          Deprecated. internal use only
 void setCssClass(java.lang.String styleClass)
           Sets the specified class name for the report object.
 void setEnableRelativePositions(boolean bEnableRelativePositions)
          For internal use only
 void setEnableSuppressIfBlank(boolean enableSuppressIfBlank)
           Sets whether the section is suppressed if it is blank.
 void setEnableUnderlaySection(boolean enableUnderlaySection)
           Sets the whether the section underlays to the following sections.
 void setPageOrientation(PaperOrientation pageOrientation)
          Sets the page orientation of a section, 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

getBackgroundColorValue

int getBackgroundColorValue()
Deprecated. internal use only


getCssClass

java.lang.String getCssClass()

Returns the specified class name for the report object. This class name can be used in a cascading style sheet (CSS) to indicate a unique style for the selected report object.

Returns:
The class name for the report object (used in a CSS) as a String.

getEnableSuppressIfBlank

boolean getEnableSuppressIfBlank()

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

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

getEnableUnderlaySection

boolean getEnableUnderlaySection()

Returns whether the section underlays to the following sections. You can use underlays to create the effect of a watermark that serves as the background for a report.

Returns:
true if the section underlays to the following sections, and otherwise false.

getEnableRelativePositions

boolean getEnableRelativePositions()
For internal use only


getPageOrientation

PaperOrientation getPageOrientation()

Returns the page orientation of a section, used for customized pagination.

Returns:
PaperOrientation

setBackgroundColorValue

void setBackgroundColorValue(int backgroundColor)
Deprecated. internal use only


setCssClass

void setCssClass(java.lang.String styleClass)

Sets the specified class name for the report object. This class name can be used in a cascading style sheet (CSS) to indicate a unique style for the selected report object.

Parameters:
styleClass - The class name of the report object (used in a CSS) as a String.

setEnableSuppressIfBlank

void setEnableSuppressIfBlank(boolean enableSuppressIfBlank)

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

Parameters:
enableSuppressIfBlank - true if the section is suppressed if it is blank, and otherwise false.

setEnableUnderlaySection

void setEnableUnderlaySection(boolean enableUnderlaySection)

Sets the whether the section underlays to the following sections. You can use underlays to create the effect of a watermark that serves as the background for a report. To create an underlay, first insert the object that you want as an underlay in the section above the section you want it to underlay and then set enableUnderlaySection to true.

Parameters:
enableUnderlaySection - true if the section underlays to the following sections, and otherwise false.

setEnableRelativePositions

void setEnableRelativePositions(boolean bEnableRelativePositions)
For internal use only


setPageOrientation

void setPageOrientation(PaperOrientation pageOrientation)

Sets the page orientation of a section, used for customized pagination. Allows you to set page orientation for each section in the report except for the Page Header and Page footer.

Note: The default setting will be the same as the report page orientation in the Page Setup dialog box. Once changed from the default setting, section page orientation will not be affected by any further changes to the report page orientation.

Parameters:
pageOrientation, - the page orientation as a PaperOrientation