|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.crystaldecisions.sdk.occa.report.definition.SectionFormat
public class SectionFormat
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 |
|---|
public SectionFormat(ISectionFormat src)
public SectionFormat()
| Method Detail |
|---|
public java.lang.Object clone(boolean deepClone)
public void copyTo(java.lang.Object destObject,
boolean deepCopy)
public java.lang.Object createMember(java.lang.String eleName,
org.xml.sax.Attributes attrs,
XMLSerializationContext ctxt,
java.util.Map objState,
boolean[] bLoaded)
public void endElement(java.lang.String eleName,
java.util.Map objState)
public java.awt.Color getBackgroundColor()
ISectionAreaFormatReturns the color for the background of the report.
getBackgroundColor in interface ISectionAreaFormatjava.awt.Color object.@Deprecated public int getBackgroundColorValue()
getBackgroundColorValue in interface ISectionFormatpublic SectionAreaFormatConditionFormulas getConditionFormulas()
ISectionAreaFormat
Returns the conditional formulas as SectionAreaFormatConditionFormulas. Conditional
formulas are used to override the regular format settings.
getConditionFormulas in interface ISectionAreaFormatSectionAreaFormatConditionFormulas.public java.lang.String getCssClass()
ISectionFormatReturns 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.
getCssClass in interface ISectionFormatString.public boolean getEnableKeepTogether()
ISectionAreaFormatReturns whether the section is printed on the same page as the preceding section.
getEnableKeepTogether in interface ISectionAreaFormattrue if the section is printed on the same page as the preceding
section, and otherwise false.public boolean getEnableNewPageAfter()
ISectionAreaFormatReturns whether a new page is inserted after the section.
getEnableNewPageAfter in interface ISectionAreaFormattrue if a new page is inserted after the section, and otherwise
false.public boolean getEnableNewPageBefore()
ISectionAreaFormatReturns whether a new page is inserted before the section.
getEnableNewPageBefore in interface ISectionAreaFormattrue if a new page is inserted before the section, and otherwise
false.public boolean getEnablePrintAtBottomOfPage()
ISectionAreaFormatReturns whether each group value is printed only at the bottom of the page.
getEnablePrintAtBottomOfPage in interface ISectionAreaFormattrue if each group value is printed only at the bottom of the page,
and otherwise false.public boolean getEnableResetPageNumberAfter()
ISectionAreaFormatReturns whether the page number is reset to 1 after the section.
getEnableResetPageNumberAfter in interface ISectionAreaFormattrue if the page number is reset to 1 after the section, and otherwise
false.public boolean getEnableSuppress()
ISectionAreaFormatReturns whether the section is suppressed. If the section is suppressed, it will not appear when the report is displayed or printed.
getEnableSuppress in interface ISectionAreaFormattrue if the section is suppressed, and otherwise false.public boolean getEnableSuppressIfBlank()
ISectionFormatReturns 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.
getEnableSuppressIfBlank in interface ISectionFormattrue if the section is suppressed if it is blank, and otherwise
false.public boolean getEnableUnderlaySection()
ISectionFormatReturns 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.
getEnableUnderlaySection in interface ISectionFormattrue if the section underlays to the following sections, and otherwise
false.public PaperOrientation getPageOrientation()
ISectionFormatReturns the page orientation of a section, used for customized pagination.
getPageOrientation in interface ISectionFormatPaperOrientationpublic boolean getEnableRelativePositions()
ISectionFormat
getEnableRelativePositions in interface ISectionFormatpublic boolean hasContent(java.lang.Object srcSectionFormat)
public void readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
public void save(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
java.io.IOException
public void save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
throws java.io.IOException
java.io.IOException
public void saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
java.io.IOExceptionpublic void setBackgroundColor(java.awt.Color backgroundColor)
ISectionAreaFormatSets the color for the background of the report.
setBackgroundColor in interface ISectionAreaFormatbackgroundColor - The color as a java.awt.Color object.@Deprecated public void setBackgroundColorValue(int backgroundColor)
setBackgroundColorValue in interface ISectionFormatpublic void setConditionFormulas(SectionAreaFormatConditionFormulas conditionFormulas)
ISectionAreaFormat
Sets the conditional formulas as SectionAreaFormatConditionFormulas. Conditional
formulas are used to override the section's format settings.
setConditionFormulas in interface ISectionAreaFormatconditionFormulas - Conditional formulas as SectionAreaFormatConditionFormulas.public void setCssClass(java.lang.String cssClass)
ISectionFormatSets 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.
setCssClass in interface ISectionFormatcssClass - The class name of the report object (used in a CSS) as a
String.public void setEnableKeepTogether(boolean enableKeepTogether)
ISectionAreaFormatSets whether the section is printed on the same page as the preceding section.
setEnableKeepTogether in interface ISectionAreaFormatenableKeepTogether - true if the section is printed on the same page as
the preceding section, and otherwise false.public void setEnableNewPageAfter(boolean enableNewPageAfter)
ISectionAreaFormatSets whether a new page is inserted after the section.
setEnableNewPageAfter in interface ISectionAreaFormatenableNewPageAfter - true if a new page is inserted after the section,
and otherwise false.public void setEnableNewPageBefore(boolean enableNewPageBefore)
ISectionAreaFormatSets whether a new page is inserted before the section.
setEnableNewPageBefore in interface ISectionAreaFormatenableNewPageBefore - true if a new page is inserted before the section,
and otherwise false.public void setEnablePrintAtBottomOfPage(boolean enablePrintAtBottomOfPage)
ISectionAreaFormatSets whether each group value is printed only at the bottom of the page.
setEnablePrintAtBottomOfPage in interface ISectionAreaFormatenablePrintAtBottomOfPage - true if each group value is printed only at
the bottom of the page, and otherwise false.public void setEnableResetPageNumberAfter(boolean enableResetPageNumberAfter)
ISectionAreaFormatSets whether the page number is reset to 1 after the section.
setEnableResetPageNumberAfter in interface ISectionAreaFormatenableResetPageNumberAfter - true if the page number is reset to 1 after
the section, and otherwise false.public void setEnableSuppress(boolean enableSuppress)
ISectionAreaFormatSets whether the section is suppressed. If the section is suppressed, it will not appear when the report is displayed or printed.
setEnableSuppress in interface ISectionAreaFormatenableSuppress - true if the section is suppressed, and otherwise
false.public void setEnableSuppressIfBlank(boolean enableSuppressIfBlank)
ISectionFormatSets 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.
setEnableSuppressIfBlank in interface ISectionFormatenableSuppressIfBlank - true if the section is suppressed if it is blank,
and otherwise false.public void setEnableUnderlaySection(boolean enableUnderlaySection)
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.
setEnableUnderlaySection in interface ISectionFormatenableUnderlaySection - true if the section underlays to the following
sections, and otherwise false.public void setPageOrientation(PaperOrientation pageOrientation)
ISectionFormatSets 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.
setPageOrientation in interface ISectionFormatpublic void setEnableRelativePositions(boolean bEnableRelativePositions)
ISectionFormat
setEnableRelativePositions in interface ISectionFormatpublic boolean skipWritingIdenticalObject()
For internal use only.
public void startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||