|
|||||||||
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 |
doControllerModification(java.lang.Object newObject)
|
void |
endElement(java.lang.String eleName,
java.util.Map objState)
For internal use only. |
void |
enumerateMembers(IMemberVisitor visitor)
|
java.awt.Color |
getBackgroundColor()
Returns the color for the background of the report. |
SectionAreaFormatConditionFormulas |
getConditionFormulas()
Returns the conditional formulas as SectionAreaFormatConditionFormulas . |
ControllableMixin |
getControllableMixin()
|
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. |
boolean |
hasContent(java.lang.Object srcAreaFormat)
|
boolean |
isDirectlyControllable()
|
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)
Sets the color for the background of the report. |
void |
setConditionFormulas(SectionAreaFormatConditionFormulas conditionFormulas)
Sets the conditional formulas as SectionAreaFormatConditionFormulas . |
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. |
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 ISectionAreaFormat
SectionAreaFormatConditionFormulas
.public boolean getEnableHideForDrillDown()
IAreaFormat
Returns whether the area will be hidden (though the area is still available for drill down).
getEnableHideForDrillDown
in interface IAreaFormat
true
if the area will be hidden, and false
otherwise.public boolean getEnableKeepTogether()
ISectionAreaFormat
Returns whether the section is printed on the same page as the preceding section.
getEnableKeepTogether
in interface ISectionAreaFormat
true
if the section is printed on the same page as the preceding
section, and otherwise false
.public boolean getEnableNewPageAfter()
ISectionAreaFormat
Returns whether a new page is inserted after the section.
getEnableNewPageAfter
in interface ISectionAreaFormat
true
if a new page is inserted after the section, and otherwise
false
.public boolean getEnableNewPageBefore()
ISectionAreaFormat
Returns whether a new page is inserted before the section.
getEnableNewPageBefore
in interface ISectionAreaFormat
true
if a new page is inserted before the section, and otherwise
false
.public boolean getEnablePrintAtBottomOfPage()
ISectionAreaFormat
Returns whether each group value is printed only at the bottom of the page.
getEnablePrintAtBottomOfPage
in interface ISectionAreaFormat
true
if each group value is printed only at the bottom of the page,
and otherwise false
.public boolean getEnableResetPageNumberAfter()
ISectionAreaFormat
Returns whether the page number is reset to 1 after the section.
getEnableResetPageNumberAfter
in interface ISectionAreaFormat
true
if the page number is reset to 1 after the section, and otherwise
false
.public boolean getEnableSuppress()
ISectionAreaFormat
Returns whether the section is suppressed. If the section is suppressed, it will not appear when the report is displayed or printed.
getEnableSuppress
in interface ISectionAreaFormat
true
if the section is suppressed, and otherwise false
.public java.awt.Color getBackgroundColor()
ISectionAreaFormat
Returns the color for the background of the report.
getBackgroundColor
in interface ISectionAreaFormat
java.awt.Color
object.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.IOException
public 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 ISectionAreaFormat
conditionFormulas
- Conditional formulas as SectionAreaFormatConditionFormulas
.public void setEnableHideForDrillDown(boolean enableHideForDrillDown)
IAreaFormat
Sets whether the area will be hidden (though the area is still available for drill down).
setEnableHideForDrillDown
in interface IAreaFormat
enableHideForDrillDown
- true
if the area will be hidden, and
false
otherwise.public void setEnableKeepTogether(boolean enableKeepTogether)
ISectionAreaFormat
Sets whether the section is printed on the same page as the preceding section.
setEnableKeepTogether
in interface ISectionAreaFormat
enableKeepTogether
- true
if the section is printed on the same page as
the preceding section, and otherwise false
.public void setEnableNewPageAfter(boolean enableNewPageAfter)
ISectionAreaFormat
Sets whether a new page is inserted after the section.
setEnableNewPageAfter
in interface ISectionAreaFormat
enableNewPageAfter
- true
if a new page is inserted after the section,
and otherwise false
.public void setEnableNewPageBefore(boolean enableNewPageBefore)
ISectionAreaFormat
Sets whether a new page is inserted before the section.
setEnableNewPageBefore
in interface ISectionAreaFormat
enableNewPageBefore
- true
if a new page is inserted before the section,
and otherwise false
.public void setEnablePrintAtBottomOfPage(boolean enablePrintAtBottomOfPage)
ISectionAreaFormat
Sets whether each group value is printed only at the bottom of the page.
setEnablePrintAtBottomOfPage
in interface ISectionAreaFormat
enablePrintAtBottomOfPage
- true
if each group value is printed only at
the bottom of the page, and otherwise false
.public void setEnableResetPageNumberAfter(boolean enableResetPageNumberAfter)
ISectionAreaFormat
Sets whether the page number is reset to 1 after the section.
setEnableResetPageNumberAfter
in interface ISectionAreaFormat
enableResetPageNumberAfter
- true
if the page number is reset to 1 after
the section, and otherwise false
.public void setEnableSuppress(boolean enableSuppress)
ISectionAreaFormat
Sets whether the section is suppressed. If the section is suppressed, it will not appear when the report is displayed or printed.
setEnableSuppress
in interface ISectionAreaFormat
enableSuppress
- true
if the section is suppressed, and otherwise
false
.public void setBackgroundColor(java.awt.Color backgroundColor)
ISectionAreaFormat
Sets the color for the background of the report.
setBackgroundColor
in interface ISectionAreaFormat
backgroundColor
- 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.
public ControllableMixin getControllableMixin()
public void doControllerModification(java.lang.Object newObject) throws ReportSDKException
ReportSDKException
public boolean isDirectlyControllable()
public void enumerateMembers(IMemberVisitor visitor)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |