|
|||||||||
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.PageAreaFormat
public class PageAreaFormat
This class enables you to get and set the formatting behaviour of a page header or page footer area.
When possible, use the IPageAreaFormat
interface.
Constructor Summary | |
---|---|
PageAreaFormat()
Creates a new PageAreaFormat . |
|
PageAreaFormat(IPageAreaFormat src)
Copies the given IPageAreaFormat . |
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. |
boolean |
getEnableReserveMinimumPageFooter()
Gets whether the page footer areas will be minimized to use less space. |
boolean |
hasContent(java.lang.Object srcPageAreaFormat)
|
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 |
setEnableReserveMinimumPageFooter(boolean b)
Sets whether the page footer areas should be minimized to use less space. |
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 PageAreaFormat(IPageAreaFormat src)
IPageAreaFormat
.
This method will create a deep copy of the src object.
- Parameters:
src
- the page area format to copy
public PageAreaFormat()
PageAreaFormat
.
Method Detail |
---|
public boolean getEnableReserveMinimumPageFooter()
IPageAreaFormat
IPageAreaFormat.getEnableReserveMinimumPageFooter()
for more
information about this option.
getEnableReserveMinimumPageFooter
in interface IPageAreaFormat
true
if the reserved space for page footer areas will be minimized, or false otherwise.IPageAreaFormat.getEnableReserveMinimumPageFooter()
public void setEnableReserveMinimumPageFooter(boolean b)
IPageAreaFormat
This option enables you to minimize the space reserved for Page Footer sections, thereby maximizing the space available for report information on each page. This option only affects a Page Footer area with multiple sections.
By default, space is reserved at the bottom of each page for your Page Footer sections. This space is reserved whether or not the Page Footer sections are conditionally suppressed. Normally, the space reserved is equivalent to the combined height of all Page Footer sections that are shown or conditionally suppressed.
You can, however, minimize the space reserved. To do so, first conditionally suppress individual Page Footers as desired. Then use the Reserve Minimum Page Footer option to only reserve space on each page for the tallest of your Page Footer sections.
setEnableReserveMinimumPageFooter
in interface IPageAreaFormat
b
- Use true
to indicate that the reserved space for page footer areas
should be minimized.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 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 boolean hasContent(java.lang.Object srcPageAreaFormat)
hasContent
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 |