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

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

public interface IDetailAreaFormat
extends IAreaFormat

This interface enables you to get and set the formatting behaviour of a detail area.


Method Summary
 DetailPrintDirection getDetailPrintDirection()
          Gets the detail print direction, which specifies whether the data should first be printed across or down, when multi-column formatting is enabled.
 int getDetailWidth()
          Gets the width of one detail column.
 boolean getEnableFormatGroupWithMultipleColumn()
          Gets whether groups should be formatted with multiple columns using the same multi-column formatting options as the detail section.
 boolean getEnableMultipleColumnFormatting()
          Gets whether the report uses multi-column formatting.
 int getHorizontalGap()
          Gets the horizontal gap between detail columns.
 int getVerticalGap()
          Gets the vertical gap between details.
 void setDetailPrintDirection(DetailPrintDirection detailPrintDirection)
          Sets the detail print direction, which specifies whether the data should first be printed across or down, when multi-column formatting is enabled.
 void setDetailWidth(int detailWidth)
          Sets the width of one detail column.
 void setEnableFormatGroupWithMultipleColumn(boolean enableFormatGroupWithMultipleColumn)
          Sets whether groups should be formatted with multiple columns using the same multi-column formatting options as the detail section.
 void setEnableMultipleColumnFormatting(boolean enableMultipleColumnFormatting)
          Sets whether the report should use multi-column formatting.
 void setHorizontalGap(int horizontalGap)
          Sets the horizontal gap between detail columns.
 void setVerticalGap(int verticalGap)
          Sets the vertical gap between details.
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.definition.IAreaFormat
getEnableHideForDrillDown, setEnableHideForDrillDown
 
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

getEnableMultipleColumnFormatting

boolean getEnableMultipleColumnFormatting()
Gets whether the report uses multi-column formatting.

Instead of having the data print straight down the page, you can set up multiple columns and have the data flow from column to column. You can also have your data print across then down the page, printing one record in each column, then printing a second record in each column, then a third, and so on.

Returns:
true if multi-column formatting is enabled, or false if it is disabled.
See Also:
setEnableMultipleColumnFormatting(boolean)

setEnableMultipleColumnFormatting

void setEnableMultipleColumnFormatting(boolean enableMultipleColumnFormatting)
Sets whether the report should use multi-column formatting.

Instead of having the data print straight down the page, you can set up multiple columns and have the data flow from column to column. You can also have your data print across then down the page, printing one record in each column, then printing a second record in each column, then a third, and so on.

Parameters:
enableMultipleColumnFormatting - true to enable multi-column formatting, or false to disable it.

getEnableFormatGroupWithMultipleColumn

boolean getEnableFormatGroupWithMultipleColumn()
Gets whether groups should be formatted with multiple columns using the same multi-column formatting options as the detail section.

The multi-column formatting options include Width, Gap, and Print Direction.

Returns:
true if groups use the same multi-column formatting as the detail section, or false otherwise.

setEnableFormatGroupWithMultipleColumn

void setEnableFormatGroupWithMultipleColumn(boolean enableFormatGroupWithMultipleColumn)
Sets whether groups should be formatted with multiple columns using the same multi-column formatting options as the detail section.

The multi-column formatting options include Width, Gap, and Print Direction.

Parameters:
enableFormatGroupWithMultipleColumn - true to enable groups to use the same multi-column formattting as the detail section, or false to disable it.

getDetailWidth

int getDetailWidth()
Gets the width of one detail column.

Returns:
an int specifying the width of one detail column

setDetailWidth

void setDetailWidth(int detailWidth)
Sets the width of one detail column.

Parameters:
detailWidth - the width of one detail column

getHorizontalGap

int getHorizontalGap()
Gets the horizontal gap between detail columns.

The horizontal gap is the empty space between details going across the page.

Returns:
The size of the horizontal gap.

setHorizontalGap

void setHorizontalGap(int horizontalGap)
Sets the horizontal gap between detail columns.

The horizontal gap is the empty space you want to allow between details going across the page.

Parameters:
horizontalGap - The size of the horizontal gap.

getVerticalGap

int getVerticalGap()
Gets the vertical gap between details.

The vertical gap is the empty space between details going down the page.

Returns:
The size of the vertical gap.

setVerticalGap

void setVerticalGap(int verticalGap)
Sets the vertical gap between details.

The vertical gap is the empty space you want to allow between details going down the page.

Parameters:
verticalGap - The size of the vertical gap.

getDetailPrintDirection

DetailPrintDirection getDetailPrintDirection()
Gets the detail print direction, which specifies whether the data should first be printed across or down, when multi-column formatting is enabled.

Returns:
the detail print direction that's used if multi-column formatting is enabled
See Also:
DetailPrintDirection

setDetailPrintDirection

void setDetailPrintDirection(DetailPrintDirection detailPrintDirection)
Sets the detail print direction, which specifies whether the data should first be printed across or down, when multi-column formatting is enabled.

Parameters:
detailPrintDirection - the detail print direction to use when multi-column formatting is enabled
See Also:
DetailPrintDirection