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

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

public class PageAreaFormat
extends AreaFormat
implements IPageAreaFormat, IClone

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 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

PageAreaFormat

public PageAreaFormat(IPageAreaFormat src)
Copies the given IPageAreaFormat. This method will create a deep copy of the src object.

Parameters:
src - the page area format to copy

PageAreaFormat

public PageAreaFormat()
Creates a new PageAreaFormat.

Method Detail

getEnableReserveMinimumPageFooter

public boolean getEnableReserveMinimumPageFooter()
Description copied from interface: IPageAreaFormat
Gets whether the page footer areas will be minimized to use less space. See IPageAreaFormat.getEnableReserveMinimumPageFooter() for more information about this option.

Specified by:
getEnableReserveMinimumPageFooter in interface IPageAreaFormat
Returns:
true if the reserved space for page footer areas will be minimized, or false otherwise.
See Also:
IPageAreaFormat.getEnableReserveMinimumPageFooter()

setEnableReserveMinimumPageFooter

public void setEnableReserveMinimumPageFooter(boolean b)
Description copied from interface: IPageAreaFormat
Sets whether the page footer areas should be minimized to use less space.

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.

Specified by:
setEnableReserveMinimumPageFooter in interface IPageAreaFormat
Parameters:
b - Use true to indicate that the reserved space for page footer areas should be minimized.

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

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

hasContent

public boolean hasContent(java.lang.Object srcPageAreaFormat)
Overrides:
hasContent 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