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

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.definition.AreaFormat
All Implemented Interfaces:
IAreaFormat, ISectionAreaFormat, IClone
Direct Known Subclasses:
GroupAreaFormat

public class AreaFormat
extends java.lang.Object
implements IAreaFormat, IClone

This object enables you to specify the format of the area dynamically when the report is displayed.


Constructor Summary
AreaFormat()
           
AreaFormat(IAreaFormat src)
           
 
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 ctxt, java.util.Map objState, boolean[] bLoaded)
           For internal use only.
 void endElement(java.lang.String eleName, java.util.Map objState)
           For internal use only.
 java.awt.Color getBackgroundColor()
          For internal use only
 SectionAreaFormatConditionFormulas getConditionFormulas()
           Returns the conditional formulas as SectionAreaFormatConditionFormulas.
 boolean getEnableClampPageFooter()
           Returns if clamp page footer is enabled, used for customized pagination.
 boolean getEnableHideForDrillDown()
           Returns whether the area will be hidden (though the area is still available for drill down).
 boolean getEnableKeepTogether()
           Returns whether the section is printed on the same page as the preceding section.
 boolean getEnableNewPageAfter()
           Returns whether a new page is inserted after the section.
 boolean getEnableNewPageBefore()
           Returns whether a new page is inserted before the section.
 boolean getEnablePrintAtBottomOfPage()
           Returns whether each group value is printed only at the bottom of the page.
 boolean getEnableResetPageNumberAfter()
           Returns whether the page number is reset to 1 after the section.
 boolean getEnableSuppress()
           Returns whether the section is suppressed.
 int getVisibleRecordNumberPerPage()
           Returns a value indicating the number of visible records per page, used for customized pagination.
 boolean hasContent(java.lang.Object srcAreaFormat)
           
 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 setBackgroundColor(java.awt.Color backgroundColor)
          For internal use only
 void setConditionFormulas(SectionAreaFormatConditionFormulas conditionFormulas)
           Sets the conditional formulas as SectionAreaFormatConditionFormulas.
 void setEnableClampPageFooter(boolean enableClampPageFooter)
           Sets if the clamp page footer will be enabled, used for customized pagination.
 void setEnableHideForDrillDown(boolean enableHideForDrillDown)
           Sets whether the area will be hidden (though the area is still available for drill down).
 void setEnableKeepTogether(boolean enableKeepTogether)
           Sets whether the section is printed on the same page as the preceding section.
 void setEnableNewPageAfter(boolean enableNewPageAfter)
           Sets whether a new page is inserted after the section.
 void setEnableNewPageBefore(boolean enableNewPageBefore)
           Sets whether a new page is inserted before the section.
 void setEnablePrintAtBottomOfPage(boolean enablePrintAtBottomOfPage)
           Sets whether each group value is printed only at the bottom of the page.
 void setEnableResetPageNumberAfter(boolean enableResetPageNumberAfter)
           Sets whether the page number is reset to 1 after the section.
 void setEnableSuppress(boolean enableSuppress)
           Sets whether the section is suppressed.
 void setVisibleRecordNumberPerPage(int visibleRecordNumberPerPage)
           Sets a non-negative value indicating the number of visible records per page, used for customized pagination.
 boolean skipWritingIdenticalObject()
           For internal use only.
 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
 

Constructor Detail

AreaFormat

public AreaFormat(IAreaFormat src)

AreaFormat

public AreaFormat()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)

createMember

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

For internal use only.


endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)

For internal use only.


getConditionFormulas

public SectionAreaFormatConditionFormulas getConditionFormulas()
Description copied from interface: ISectionAreaFormat

Returns the conditional formulas as SectionAreaFormatConditionFormulas. Conditional formulas are used to override the regular format settings.

Specified by:
getConditionFormulas in interface ISectionAreaFormat
Returns:
Conditional formulas as SectionAreaFormatConditionFormulas.

getEnableHideForDrillDown

public boolean getEnableHideForDrillDown()
Description copied from interface: IAreaFormat

Returns whether the area will be hidden (though the area is still available for drill down).

Specified by:
getEnableHideForDrillDown in interface IAreaFormat
Returns:
true if the area will be hidden, and false otherwise.

getEnableKeepTogether

public boolean getEnableKeepTogether()
Description copied from interface: ISectionAreaFormat

Returns whether the section is printed on the same page as the preceding section.

Specified by:
getEnableKeepTogether in interface ISectionAreaFormat
Returns:
true if the section is printed on the same page as the preceding section, and otherwise false.

getEnableNewPageAfter

public boolean getEnableNewPageAfter()
Description copied from interface: ISectionAreaFormat

Returns whether a new page is inserted after the section.

Specified by:
getEnableNewPageAfter in interface ISectionAreaFormat
Returns:
true if a new page is inserted after the section, and otherwise false.

getEnableNewPageBefore

public boolean getEnableNewPageBefore()
Description copied from interface: ISectionAreaFormat

Returns whether a new page is inserted before the section.

Specified by:
getEnableNewPageBefore in interface ISectionAreaFormat
Returns:
true if a new page is inserted before the section, and otherwise false.

getEnablePrintAtBottomOfPage

public boolean getEnablePrintAtBottomOfPage()
Description copied from interface: ISectionAreaFormat

Returns whether each group value is printed only at the bottom of the page.

Specified by:
getEnablePrintAtBottomOfPage in interface ISectionAreaFormat
Returns:
true if each group value is printed only at the bottom of the page, and otherwise false.

getEnableResetPageNumberAfter

public boolean getEnableResetPageNumberAfter()
Description copied from interface: ISectionAreaFormat

Returns whether the page number is reset to 1 after the section.

Specified by:
getEnableResetPageNumberAfter in interface ISectionAreaFormat
Returns:
true if the page number is reset to 1 after the section, and otherwise false.

getEnableSuppress

public boolean getEnableSuppress()
Description copied from interface: ISectionAreaFormat

Returns whether the section is suppressed. If the section is suppressed, it will not appear when the report is displayed or printed.

Specified by:
getEnableSuppress in interface ISectionAreaFormat
Returns:
true if the section is suppressed, and otherwise false.

getBackgroundColor

public java.awt.Color getBackgroundColor()
For internal use only

Specified by:
getBackgroundColor in interface ISectionAreaFormat
Returns:
The color as a java.awt.Color object.

getVisibleRecordNumberPerPage

public int getVisibleRecordNumberPerPage()
Description copied from interface: IAreaFormat

Returns a value indicating the number of visible records per page, used for customized pagination. This feature applies only to visible records. Suppressed records may be contained on a page, but will not count toward visible records. This property can only be applied to the DetailArea section of a report.

Note: By default, the VisibleRecordNumberPerPage property is set to 0, indicating that paging is not determined by the number of visible records.

Specified by:
getVisibleRecordNumberPerPage in interface IAreaFormat
Returns:
int that indicates the number of records that are visible on each page.

getEnableClampPageFooter

public boolean getEnableClampPageFooter()
Description copied from interface: IAreaFormat

Returns if clamp page footer is enabled, used for customized pagination. The clamp page pooter removes any extra white space between the report details and the page footer.

Note: The clamp page footer can only be enabled in the PageFooter section of a report.

Specified by:
getEnableClampPageFooter in interface IAreaFormat
Returns:
true if clamping page footer is enabled, and false otherwise.

hasContent

public boolean hasContent(java.lang.Object srcAreaFormat)

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.


save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

save

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

For internal use only.

Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

setConditionFormulas

public void setConditionFormulas(SectionAreaFormatConditionFormulas conditionFormulas)
Description copied from interface: ISectionAreaFormat

Sets the conditional formulas as SectionAreaFormatConditionFormulas. Conditional formulas are used to override the section's format settings.

Specified by:
setConditionFormulas in interface ISectionAreaFormat
Parameters:
conditionFormulas - Conditional formulas as SectionAreaFormatConditionFormulas.

setEnableHideForDrillDown

public void setEnableHideForDrillDown(boolean enableHideForDrillDown)
Description copied from interface: IAreaFormat

Sets whether the area will be hidden (though the area is still available for drill down).

Specified by:
setEnableHideForDrillDown in interface IAreaFormat
Parameters:
enableHideForDrillDown - true if the area will be hidden, and false otherwise.

setEnableKeepTogether

public void setEnableKeepTogether(boolean enableKeepTogether)
Description copied from interface: ISectionAreaFormat

Sets whether the section is printed on the same page as the preceding section.

Specified by:
setEnableKeepTogether in interface ISectionAreaFormat
Parameters:
enableKeepTogether - true if the section is printed on the same page as the preceding section, and otherwise false.

setEnableNewPageAfter

public void setEnableNewPageAfter(boolean enableNewPageAfter)
Description copied from interface: ISectionAreaFormat

Sets whether a new page is inserted after the section.

Specified by:
setEnableNewPageAfter in interface ISectionAreaFormat
Parameters:
enableNewPageAfter - true if a new page is inserted after the section, and otherwise false.

setEnableNewPageBefore

public void setEnableNewPageBefore(boolean enableNewPageBefore)
Description copied from interface: ISectionAreaFormat

Sets whether a new page is inserted before the section.

Specified by:
setEnableNewPageBefore in interface ISectionAreaFormat
Parameters:
enableNewPageBefore - true if a new page is inserted before the section, and otherwise false.

setEnablePrintAtBottomOfPage

public void setEnablePrintAtBottomOfPage(boolean enablePrintAtBottomOfPage)
Description copied from interface: ISectionAreaFormat

Sets whether each group value is printed only at the bottom of the page.

Specified by:
setEnablePrintAtBottomOfPage in interface ISectionAreaFormat
Parameters:
enablePrintAtBottomOfPage - true if each group value is printed only at the bottom of the page, and otherwise false.

setEnableResetPageNumberAfter

public void setEnableResetPageNumberAfter(boolean enableResetPageNumberAfter)
Description copied from interface: ISectionAreaFormat

Sets whether the page number is reset to 1 after the section.

Specified by:
setEnableResetPageNumberAfter in interface ISectionAreaFormat
Parameters:
enableResetPageNumberAfter - true if the page number is reset to 1 after the section, and otherwise false.

setEnableSuppress

public void setEnableSuppress(boolean enableSuppress)
Description copied from interface: ISectionAreaFormat

Sets whether the section is suppressed. If the section is suppressed, it will not appear when the report is displayed or printed.

Specified by:
setEnableSuppress in interface ISectionAreaFormat
Parameters:
enableSuppress - true if the section is suppressed, and otherwise false.

setVisibleRecordNumberPerPage

public void setVisibleRecordNumberPerPage(int visibleRecordNumberPerPage)
Description copied from interface: IAreaFormat

Sets a non-negative value indicating the number of visible records per page, used for customized pagination. This feature applies only to visible records. Suppressed records may be contained on a page, but will not count toward visible records. This property can only be applied to the DetailArea section of a report.

Note: By default, the VisibleRecordNumberPerPage property is set to 0, indicating that paging is not determined by the number of visible records.

Specified by:
setVisibleRecordNumberPerPage in interface IAreaFormat
Parameters:
visibleRecordNumberPerPage - an int object.

setEnableClampPageFooter

public void setEnableClampPageFooter(boolean enableClampPageFooter)
Description copied from interface: IAreaFormat

Sets if the clamp page footer will be enabled, used for customized pagination. The clamp page pooter removes any extra white space between the report details and the page footer.

Note: The clamp page footer can only be enabled in the PageFooter section of a report.

Specified by:
setEnableClampPageFooter in interface IAreaFormat
Parameters:
enableClampPageFooter - true if clamping page footer is enabled, and false otherwise.

setBackgroundColor

public void setBackgroundColor(java.awt.Color backgroundColor)
For internal use only

Specified by:
setBackgroundColor in interface ISectionAreaFormat
Parameters:
backgroundColor - The color as a java.awt.Color object.

skipWritingIdenticalObject

public boolean skipWritingIdenticalObject()

For internal use only.


startElement

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

For internal use only.