|
|||||||||
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)
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. |
int |
getBackgroundColorValue()
Deprecated. internal use only |
SectionAreaFormatConditionFormulas |
getConditionFormulas()
Returns the conditional formulas as SectionAreaFormatConditionFormulas . |
ControllableMixin |
getControllableMixin()
|
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()
|
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. |
boolean |
hasContent(java.lang.Object srcSectionFormat)
|
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 |
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)
|
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. |
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 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)
For internal use only.
public void endElement(java.lang.String eleName, java.util.Map objState)
For internal use only.
public java.awt.Color getBackgroundColor()
ISectionAreaFormat
Returns the color for the background of the report.
getBackgroundColor
in interface ISectionAreaFormat
java.awt.Color
object.public int getBackgroundColorValue()
getBackgroundColorValue
in interface ISectionFormat
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 java.lang.String getCssClass()
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.
getCssClass
in interface ISectionFormat
String
.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 boolean getEnableSuppressIfBlank()
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.
getEnableSuppressIfBlank
in interface ISectionFormat
true
if the section is suppressed if it is blank, and otherwise
false
.public boolean getEnableUnderlaySection()
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.
getEnableUnderlaySection
in interface ISectionFormat
true
if the section underlays to the following sections, and otherwise
false
.public boolean getEnableRelativePositions()
getEnableRelativePositions
in interface ISectionFormat
public 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)
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 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 void setBackgroundColorValue(int backgroundColor)
setBackgroundColorValue
in interface ISectionFormat
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 setCssClass(java.lang.String cssClass)
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.
setCssClass
in interface ISectionFormat
cssClass
- The class name of the report object (used in a CSS) as a
String
.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 setEnableSuppressIfBlank(boolean enableSuppressIfBlank)
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.
setEnableSuppressIfBlank
in interface ISectionFormat
enableSuppressIfBlank
- 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 ISectionFormat
enableUnderlaySection
- true
if the section underlays to the following
sections, and otherwise false
.public void setEnableRelativePositions(boolean bEnableRelativePositions)
setEnableRelativePositions
in interface ISectionFormat
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 |