|
|||||||||
| 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
public class AreaFormat
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 |
|---|
public AreaFormat(IAreaFormat src)
public AreaFormat()
| 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)
For internal use only.
public void endElement(java.lang.String eleName,
java.util.Map objState)
For internal use only.
public SectionAreaFormatConditionFormulas getConditionFormulas()
ISectionAreaFormat
Returns the conditional formulas as SectionAreaFormatConditionFormulas. Conditional
formulas are used to override the regular format settings.
getConditionFormulas in interface ISectionAreaFormatSectionAreaFormatConditionFormulas.public boolean getEnableHideForDrillDown()
IAreaFormatReturns whether the area will be hidden (though the area is still available for drill down).
getEnableHideForDrillDown in interface IAreaFormattrue if the area will be hidden, and false otherwise.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 java.awt.Color getBackgroundColor()
getBackgroundColor in interface ISectionAreaFormatjava.awt.Color object.public int getVisibleRecordNumberPerPage()
IAreaFormatReturns 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.
getVisibleRecordNumberPerPage in interface IAreaFormatpublic boolean getEnableClampPageFooter()
IAreaFormatReturns 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.
getEnableClampPageFooter in interface IAreaFormattrue if clamping page footer is enabled, and false otherwise.public boolean hasContent(java.lang.Object srcAreaFormat)
public void readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
For internal use only.
public void save(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
For internal use only.
java.io.IOException
public void save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
throws java.io.IOException
For internal use only.
java.io.IOException
public void saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
For internal use only.
java.io.IOExceptionpublic 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 setEnableHideForDrillDown(boolean enableHideForDrillDown)
IAreaFormatSets whether the area will be hidden (though the area is still available for drill down).
setEnableHideForDrillDown in interface IAreaFormatenableHideForDrillDown - true if the area will be hidden, and
false otherwise.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 setVisibleRecordNumberPerPage(int visibleRecordNumberPerPage)
IAreaFormatSets 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.
setVisibleRecordNumberPerPage in interface IAreaFormatvisibleRecordNumberPerPage - an int object.public void setEnableClampPageFooter(boolean enableClampPageFooter)
IAreaFormatSets 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.
setEnableClampPageFooter in interface IAreaFormatenableClampPageFooter - true if clamping page footer is enabled, and false otherwise.public void setBackgroundColor(java.awt.Color backgroundColor)
setBackgroundColor in interface ISectionAreaFormatbackgroundColor - The color as a java.awt.Color object.public boolean skipWritingIdenticalObject()
For internal use only.
public void startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
For internal use only.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||