com.crystaldecisions.sdk.occa.report.definition
Class DetailAreaFormat

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.definition.AreaFormat
      extended by com.crystaldecisions.sdk.occa.report.definition.DetailAreaFormat
All Implemented Interfaces:
IAreaFormat, IDetailAreaFormat, ISectionAreaFormat, IClone

public class DetailAreaFormat
extends AreaFormat
implements IDetailAreaFormat, IClone

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

When possible, use the IDetailAreaFormat interface.


Constructor Summary
DetailAreaFormat()
          Creates a new DetailAreaFormat.
DetailAreaFormat(IDetailAreaFormat src)
          Copies the given IDetailAreaFormat.
 
Method Summary
 java.lang.Object clone(boolean deepClone)
           
 void copyTo(java.lang.Object destObject, boolean deepCopy)
           
 java.lang.Object createMember(java.lang.String eleName, org.xml.sax.Attributes attrs, XMLSerializationContext context, java.util.Map objState, boolean[] bLoaded)
          For internal use only.
 void endElement(java.lang.String eleName, java.util.Map objState)
          For internal use only.
 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.
 boolean hasContent(java.lang.Object srcDetailFormatAreaFormat)
           
 void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
          For internal use only.
 void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt)
          For internal use only.
 void save(XMLWriter writer, XMLSerializationContext ctxt)
          For internal use only.
 void saveContents(XMLWriter writer, XMLSerializationContext ctxt)
          For internal use only.
 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.
 void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
          For internal use only.
 
Methods inherited from class com.crystaldecisions.sdk.occa.report.definition.AreaFormat
doControllerModification, enumerateMembers, getBackgroundColor, getConditionFormulas, getControllableMixin, getEnableHideForDrillDown, getEnableKeepTogether, getEnableNewPageAfter, getEnableNewPageBefore, getEnablePrintAtBottomOfPage, getEnableResetPageNumberAfter, getEnableSuppress, isDirectlyControllable, setBackgroundColor, setConditionFormulas, setEnableHideForDrillDown, setEnableKeepTogether, setEnableNewPageAfter, setEnableNewPageBefore, setEnablePrintAtBottomOfPage, setEnableResetPageNumberAfter, setEnableSuppress, skipWritingIdenticalObject
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
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
 

Constructor Detail

DetailAreaFormat

public DetailAreaFormat(IDetailAreaFormat src)
Copies the given IDetailAreaFormat. This method creates a deep copy of the src object.

Parameters:
src - the page area format to copy

DetailAreaFormat

public DetailAreaFormat()
Creates a new DetailAreaFormat.

Method Detail

clone

public java.lang.Object clone(boolean deepClone)
Overrides:
clone in class AreaFormat

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)
Overrides:
copyTo in class AreaFormat

hasContent

public boolean hasContent(java.lang.Object srcDetailFormatAreaFormat)
Overrides:
hasContent in class AreaFormat

getEnableMultipleColumnFormatting

public boolean getEnableMultipleColumnFormatting()
Description copied from interface: IDetailAreaFormat
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.

Specified by:
getEnableMultipleColumnFormatting in interface IDetailAreaFormat
Returns:
true if multi-column formatting is enabled, or false if it is disabled.
See Also:
IDetailAreaFormat.setEnableMultipleColumnFormatting(boolean)

setEnableMultipleColumnFormatting

public void setEnableMultipleColumnFormatting(boolean enableMultipleColumnFormatting)
Description copied from interface: IDetailAreaFormat
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.

Specified by:
setEnableMultipleColumnFormatting in interface IDetailAreaFormat
Parameters:
enableMultipleColumnFormatting - true to enable multi-column formatting, or false to disable it.

getEnableFormatGroupWithMultipleColumn

public boolean getEnableFormatGroupWithMultipleColumn()
Description copied from interface: IDetailAreaFormat
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.

Specified by:
getEnableFormatGroupWithMultipleColumn in interface IDetailAreaFormat
Returns:
true if groups use the same multi-column formatting as the detail section, or false otherwise.

setEnableFormatGroupWithMultipleColumn

public void setEnableFormatGroupWithMultipleColumn(boolean enableFormatGroupWithMultipleColumn)
Description copied from interface: IDetailAreaFormat
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.

Specified by:
setEnableFormatGroupWithMultipleColumn in interface IDetailAreaFormat
Parameters:
enableFormatGroupWithMultipleColumn - true to enable groups to use the same multi-column formattting as the detail section, or false to disable it.

getDetailWidth

public int getDetailWidth()
Description copied from interface: IDetailAreaFormat
Gets the width of one detail column.

Specified by:
getDetailWidth in interface IDetailAreaFormat
Returns:
an int specifying the width of one detail column

setDetailWidth

public void setDetailWidth(int detailWidth)
Description copied from interface: IDetailAreaFormat
Sets the width of one detail column.

Specified by:
setDetailWidth in interface IDetailAreaFormat
Parameters:
detailWidth - the width of one detail column

getHorizontalGap

public int getHorizontalGap()
Description copied from interface: IDetailAreaFormat
Gets the horizontal gap between detail columns.

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

Specified by:
getHorizontalGap in interface IDetailAreaFormat
Returns:
The size of the horizontal gap.

setHorizontalGap

public void setHorizontalGap(int horizontalGap)
Description copied from interface: IDetailAreaFormat
Sets the horizontal gap between detail columns.

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

Specified by:
setHorizontalGap in interface IDetailAreaFormat
Parameters:
horizontalGap - The size of the horizontal gap.

getVerticalGap

public int getVerticalGap()
Description copied from interface: IDetailAreaFormat
Gets the vertical gap between details.

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

Specified by:
getVerticalGap in interface IDetailAreaFormat
Returns:
The size of the vertical gap.

setVerticalGap

public void setVerticalGap(int verticalGap)
Description copied from interface: IDetailAreaFormat
Sets the vertical gap between details.

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

Specified by:
setVerticalGap in interface IDetailAreaFormat
Parameters:
verticalGap - The size of the vertical gap.

getDetailPrintDirection

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

Specified by:
getDetailPrintDirection in interface IDetailAreaFormat
Returns:
the detail print direction that's used if multi-column formatting is enabled
See Also:
DetailPrintDirection

setDetailPrintDirection

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

Specified by:
setDetailPrintDirection in interface IDetailAreaFormat
Parameters:
detailPrintDirection - the detail print direction to use when multi-column formatting is enabled
See Also:
DetailPrintDirection

createMember

public java.lang.Object createMember(java.lang.String eleName,
                                     org.xml.sax.Attributes attrs,
                                     XMLSerializationContext context,
                                     java.util.Map objState,
                                     boolean[] bLoaded)
For internal use only.

Overrides:
createMember in class AreaFormat

endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)
For internal use only.

Overrides:
endElement in class AreaFormat

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)
For internal use only.

Overrides:
readElement in class AreaFormat

save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
For internal use only.

Overrides:
save in class AreaFormat
Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
For internal use only.

Overrides:
save in class AreaFormat
Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException
For internal use only.

Overrides:
saveContents in class AreaFormat
Throws:
java.io.IOException

startElement

public void startElement(java.lang.String eleName,
                         java.util.Map objState,
                         org.xml.sax.Attributes attrs)
For internal use only.

Overrides:
startElement in class AreaFormat