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

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.definition.SectionFormat
All Implemented Interfaces:
ISectionAreaFormat, ISectionFormat, IClone

public class SectionFormat
extends java.lang.Object
implements ISectionFormat, IClone

This object defines the formatting for a section.


Constructor Summary
SectionFormat()
           
SectionFormat(ISectionFormat 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)
           
 void endElement(java.lang.String eleName, java.util.Map objState)
           
 java.awt.Color getBackgroundColor()
           Returns the color for the background of the report.
 int getBackgroundColorValue()
          Deprecated. internal use only
 SectionAreaFormatConditionFormulas getConditionFormulas()
           Returns the conditional formulas as SectionAreaFormatConditionFormulas.
 java.lang.String getCssClass()
           Returns the specified class name for the report object.
 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 getEnableRelativePositions()
          For internal use only
 boolean getEnableResetPageNumberAfter()
           Returns whether the page number is reset to 1 after the section.
 boolean getEnableSuppress()
           Returns whether the section is suppressed.
 boolean getEnableSuppressIfBlank()
           Returns whether the section is suppressed if it is blank.
 boolean getEnableUnderlaySection()
           Returns whether the section underlays to the following sections.
 PaperOrientation getPageOrientation()
          Returns the page orientation of a section, used for customized pagination.
 boolean hasContent(java.lang.Object srcSectionFormat)
           
 void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
           
 void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt)
           
 void save(XMLWriter writer, XMLSerializationContext ctxt)
           
 void saveContents(XMLWriter writer, XMLSerializationContext ctxt)
           
 void setBackgroundColor(java.awt.Color backgroundColor)
           Sets the color for the background of the report.
 void setBackgroundColorValue(int backgroundColor)
          Deprecated. internal use only
 void setConditionFormulas(SectionAreaFormatConditionFormulas conditionFormulas)
           Sets the conditional formulas as SectionAreaFormatConditionFormulas.
 void setCssClass(java.lang.String cssClass)
           Sets the specified class name for the report object.
 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 setEnableRelativePositions(boolean bEnableRelativePositions)
          For internal use only
 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 setEnableSuppressIfBlank(boolean enableSuppressIfBlank)
           Sets whether the section is suppressed if it is blank.
 void setEnableUnderlaySection(boolean enableUnderlaySection)
           Sets the whether the section underlays to the following sections.
 void setPageOrientation(PaperOrientation pageOrientation)
          Sets the page orientation of a section, 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)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SectionFormat

public SectionFormat(ISectionFormat src)

SectionFormat

public SectionFormat()
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)

endElement

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

getBackgroundColor

public java.awt.Color getBackgroundColor()
Description copied from interface: ISectionAreaFormat

Returns the color for the background of the report.

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

getBackgroundColorValue

@Deprecated
public int getBackgroundColorValue()
Deprecated. internal use only

Specified by:
getBackgroundColorValue in interface ISectionFormat

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.

getCssClass

public java.lang.String getCssClass()
Description copied from interface: ISectionFormat

Returns the specified class name for the report object. This class name can be used in a cascading style sheet (CSS) to indicate a unique style for the selected report object.

Specified by:
getCssClass in interface ISectionFormat
Returns:
The class name for the report object (used in a CSS) as a String.

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.

getEnableSuppressIfBlank

public boolean getEnableSuppressIfBlank()
Description copied from interface: ISectionFormat

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

Specified by:
getEnableSuppressIfBlank in interface ISectionFormat
Returns:
true if the section is suppressed if it is blank, and otherwise false.

getEnableUnderlaySection

public boolean getEnableUnderlaySection()
Description copied from interface: ISectionFormat

Returns whether the section underlays to the following sections. You can use underlays to create the effect of a watermark that serves as the background for a report.

Specified by:
getEnableUnderlaySection in interface ISectionFormat
Returns:
true if the section underlays to the following sections, and otherwise false.

getPageOrientation

public PaperOrientation getPageOrientation()
Description copied from interface: ISectionFormat

Returns the page orientation of a section, used for customized pagination.

Specified by:
getPageOrientation in interface ISectionFormat
Returns:
PaperOrientation

getEnableRelativePositions

public boolean getEnableRelativePositions()
Description copied from interface: ISectionFormat
For internal use only

Specified by:
getEnableRelativePositions in interface ISectionFormat

hasContent

public boolean hasContent(java.lang.Object srcSectionFormat)

readElement

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

save

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

save

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

saveContents

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

setBackgroundColor

public void setBackgroundColor(java.awt.Color backgroundColor)
Description copied from interface: ISectionAreaFormat

Sets the color for the background of the report.

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

setBackgroundColorValue

@Deprecated
public void setBackgroundColorValue(int backgroundColor)
Deprecated. internal use only

Specified by:
setBackgroundColorValue in interface ISectionFormat

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.

setCssClass

public void setCssClass(java.lang.String cssClass)
Description copied from interface: ISectionFormat

Sets the specified class name for the report object. This class name can be used in a cascading style sheet (CSS) to indicate a unique style for the selected report object.

Specified by:
setCssClass in interface ISectionFormat
Parameters:
cssClass - The class name of the report object (used in a CSS) as a String.

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.

setEnableSuppressIfBlank

public void setEnableSuppressIfBlank(boolean enableSuppressIfBlank)
Description copied from interface: ISectionFormat

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

Specified by:
setEnableSuppressIfBlank in interface ISectionFormat
Parameters:
enableSuppressIfBlank - true if the section is suppressed if it is blank, and otherwise false.

setEnableUnderlaySection

public void setEnableUnderlaySection(boolean enableUnderlaySection)
Description copied from interface: ISectionFormat

Sets the whether the section underlays to the following sections. You can use underlays to create the effect of a watermark that serves as the background for a report. To create an underlay, first insert the object that you want as an underlay in the section above the section you want it to underlay and then set enableUnderlaySection to true.

Specified by:
setEnableUnderlaySection in interface ISectionFormat
Parameters:
enableUnderlaySection - true if the section underlays to the following sections, and otherwise false.

setPageOrientation

public void setPageOrientation(PaperOrientation pageOrientation)
Description copied from interface: ISectionFormat

Sets the page orientation of a section, used for customized pagination. Allows you to set page orientation for each section in the report except for the Page Header and Page footer.

Note: The default setting will be the same as the report page orientation in the Page Setup dialog box. Once changed from the default setting, section page orientation will not be affected by any further changes to the report page orientation.

Specified by:
setPageOrientation in interface ISectionFormat

setEnableRelativePositions

public void setEnableRelativePositions(boolean bEnableRelativePositions)
Description copied from interface: ISectionFormat
For internal use only

Specified by:
setEnableRelativePositions in interface ISectionFormat

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)