|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISummaryField
This interface is used to modify a summary for a group, or for the entire report.
Method Summary | |
---|---|
IGroup |
getGroup()
Returns the group for which the summary is being calculated. |
IGroup |
getSecondGroupForPercentage()
Gets the group that is used for the percentage summary. |
boolean |
isPercentageSummary()
Gets whether the summary calculates the percentage total of one group within a broader grouping. |
boolean |
isSummarizedAcrossHierarchy()
Gets whether the summary is calculated across hierarchical groupings. |
void |
setGroup(IGroup group)
Sets the group for which the summary is being calculated. |
void |
setPercentageSummary(boolean percentageSummary)
Sets whether the summary calculates the percentage total of one group within a broader grouping. |
void |
setSecondGroupForPercentage(IGroup group)
Sets the group that is used for the percentage summary. |
void |
setSummarizedAcrossHierarchy(boolean sumAcrossHierarchy)
Sets whether the summary is calculated across hierarchical groupings. |
Methods inherited from interface com.crystaldecisions.sdk.occa.report.data.ISummaryFieldBase |
---|
getOperation, getOperationParameter, getSecondarySummarizedField, getSummarizedField, setOperation, setOperationParameter, setSecondarySummarizedField, setSummarizedField |
Methods inherited from interface com.crystaldecisions.sdk.occa.report.data.IField |
---|
getDescription, getDisplayName, getFormulaForm, getHeadingText, getIsRecurring, getKind, getLength, getLongName, getName, getShortName, getType, setDescription, setHeadingText, setLength, setName, setType |
Method Detail |
---|
IGroup getGroup()
IGroup
object containing the group for which the summary field is
being calculated.void setGroup(IGroup group)
group
- An IGroup
object containing the group for which the summary field is
being calculated.IGroup getSecondGroupForPercentage()
IGroup
used for the percentage summaryisPercentageSummary()
void setSecondGroupForPercentage(IGroup group)
group
- the IGroup
to use for the percentage summarysetPercentageSummary(boolean)
boolean isPercentageSummary()
Note: The percentage option is valid only when the result of a summary operation is numeric.
true
if the percentage summary is enabled, false
if it is disabledgetSecondGroupForPercentage()
void setPercentageSummary(boolean percentageSummary)
percentageSummary
- true
to enable percentage summary, false
to disable itsetSecondGroupForPercentage(IGroup)
boolean isSummarizedAcrossHierarchy()
true
if the summary is calculated across hierarchical groupings, false
if it is notvoid setSummarizedAcrossHierarchy(boolean sumAcrossHierarchy)
sumAcrossHierarchy
- true
to enable calculating the summary across hierarchical groupings,
false
to disable it
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |