|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.crystaldecisions.sdk.occa.report.definition.AreaFormat
com.crystaldecisions.sdk.occa.report.definition.DetailAreaFormat
public class DetailAreaFormat
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 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 |
---|
public DetailAreaFormat(IDetailAreaFormat src)
IDetailAreaFormat
.
This method creates a deep copy of the src object.
- Parameters:
src
- the page area format to copy
public DetailAreaFormat()
DetailAreaFormat
.
Method Detail |
---|
public java.lang.Object clone(boolean deepClone)
clone
in class AreaFormat
public void copyTo(java.lang.Object destObject, boolean deepCopy)
copyTo
in class AreaFormat
public boolean hasContent(java.lang.Object srcDetailFormatAreaFormat)
hasContent
in class AreaFormat
public boolean getEnableMultipleColumnFormatting()
IDetailAreaFormat
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.
getEnableMultipleColumnFormatting
in interface IDetailAreaFormat
true
if multi-column formatting is enabled, or false
if
it is disabled.IDetailAreaFormat.setEnableMultipleColumnFormatting(boolean)
public void setEnableMultipleColumnFormatting(boolean enableMultipleColumnFormatting)
IDetailAreaFormat
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.
setEnableMultipleColumnFormatting
in interface IDetailAreaFormat
enableMultipleColumnFormatting
- true
to enable multi-column formatting,
or false
to disable it.public boolean getEnableFormatGroupWithMultipleColumn()
IDetailAreaFormat
The multi-column formatting options include Width, Gap, and Print Direction.
getEnableFormatGroupWithMultipleColumn
in interface IDetailAreaFormat
true
if groups use the same multi-column formatting as the detail
section, or false
otherwise.public void setEnableFormatGroupWithMultipleColumn(boolean enableFormatGroupWithMultipleColumn)
IDetailAreaFormat
The multi-column formatting options include Width, Gap, and Print Direction.
setEnableFormatGroupWithMultipleColumn
in interface IDetailAreaFormat
enableFormatGroupWithMultipleColumn
- true
to enable groups to use the same multi-column formattting
as the detail section, or false
to disable it.public int getDetailWidth()
IDetailAreaFormat
getDetailWidth
in interface IDetailAreaFormat
int
specifying the width of one detail columnpublic void setDetailWidth(int detailWidth)
IDetailAreaFormat
setDetailWidth
in interface IDetailAreaFormat
detailWidth
- the width of one detail columnpublic int getHorizontalGap()
IDetailAreaFormat
The horizontal gap is the empty space between details going across the page.
getHorizontalGap
in interface IDetailAreaFormat
public void setHorizontalGap(int horizontalGap)
IDetailAreaFormat
The horizontal gap is the empty space you want to allow between details going across the page.
setHorizontalGap
in interface IDetailAreaFormat
horizontalGap
- The size of the horizontal gap.public int getVerticalGap()
IDetailAreaFormat
The vertical gap is the empty space between details going down the page.
getVerticalGap
in interface IDetailAreaFormat
public void setVerticalGap(int verticalGap)
IDetailAreaFormat
The vertical gap is the empty space you want to allow between details going down the page.
setVerticalGap
in interface IDetailAreaFormat
verticalGap
- The size of the vertical gap.public DetailPrintDirection getDetailPrintDirection()
IDetailAreaFormat
getDetailPrintDirection
in interface IDetailAreaFormat
DetailPrintDirection
public void setDetailPrintDirection(DetailPrintDirection detailPrintDirection)
IDetailAreaFormat
setDetailPrintDirection
in interface IDetailAreaFormat
detailPrintDirection
- the detail print direction to use when multi-column formatting is enabledDetailPrintDirection
public java.lang.Object createMember(java.lang.String eleName, org.xml.sax.Attributes attrs, XMLSerializationContext context, java.util.Map objState, boolean[] bLoaded)
createMember
in class AreaFormat
public void endElement(java.lang.String eleName, java.util.Map objState)
endElement
in class AreaFormat
public void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
readElement
in class AreaFormat
public void save(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
save
in class AreaFormat
java.io.IOException
public void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt) throws java.io.IOException
save
in class AreaFormat
java.io.IOException
public void saveContents(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
saveContents
in class AreaFormat
java.io.IOException
public void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
startElement
in class AreaFormat
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |