|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.crystaldecisions.sdk.occa.report.data.Field
com.crystaldecisions.sdk.occa.report.data.SummaryField
public class SummaryField
This object is used to calculate a summary for a group, or for the entire report.
| Constructor Summary | |
|---|---|
SummaryField()
For internal use only. |
|
SummaryField(ISummaryField 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.lang.String |
getDisplayName(FieldDisplayNameType displayName,
java.util.Locale locale)
Returns the name of the field that has been formatted according to the value of the parameter displayNameType. |
java.lang.String |
getFormulaForm()
Returns the name of the field as it will be used in a formula. |
IGroup |
getGroup()
Returns the group for which the summary is being calculated. |
boolean |
getIsPrintTime()
|
FieldKind |
getKind()
Returns what kind of field this is. |
java.lang.String |
getLongName(java.util.Locale locale)
Returns the fully qualified name of the field. |
SummaryOperation |
getOperation()
Returns the manner in which the summary will be calculated. |
int |
getOperationParameter()
For internal use only |
IField |
getSecondarySummarizedField()
For internal use only |
IGroup |
getSecondGroupForPercentage()
For internal use only |
java.lang.String |
getShortName(java.util.Locale locale)
Returns the short name of the field. |
IField |
getSummarizedField()
Returns the field that is being used to calculate the summary. |
boolean |
hasContent(java.lang.Object srcSummaryField)
|
boolean |
isPercentageSummary()
For internal use only |
boolean |
isSummarizedAcrossHierarchy()
For internal use only |
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 |
setGroup(IGroup group)
Sets the group for which the summary is being calculated. |
void |
setOperation(SummaryOperation operation)
Sets the manner in which the summary will be calculated. |
void |
setOperationParameter(int parameter)
For internal use only |
void |
setPercentageSummary(boolean percentageSummary)
For in-proc use only. |
void |
setSecondarySummarizedField(IField summarizedField)
For internal use only |
void |
setSecondGroupForPercentage(IGroup secondGroup)
For in-proc use only. |
void |
setSummarizedAcrossHierarchy(boolean sumAcrossHierarchy)
For internal use only |
void |
setSummarizedField(IField summarizedField)
Sets the field that is being used to calculate the summary. |
void |
startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
|
| Methods inherited from class com.crystaldecisions.sdk.occa.report.data.Field |
|---|
getAttributes, getDescription, getHeadingText, getIsRecurring, getLength, getName, getType, getValueTypeForFormatOption, setAttributes, setDescription, setHeadingText, setLength, setName, setType |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface com.crystaldecisions.sdk.occa.report.data.IField |
|---|
getDescription, getHeadingText, getIsRecurring, getLength, getName, getType, getValueTypeForFormatOption, setDescription, setHeadingText, setLength, setName, setType |
| Constructor Detail |
|---|
public SummaryField(ISummaryField src)
public SummaryField()
For internal use only.
| Method Detail |
|---|
public java.lang.Object clone(boolean deepClone)
clone in class Field
public void copyTo(java.lang.Object destObject,
boolean deepCopy)
copyTo in class Field
public java.lang.Object createMember(java.lang.String eleName,
org.xml.sax.Attributes attrs,
XMLSerializationContext ctxt,
java.util.Map objState,
boolean[] bLoaded)
createMember in class Field
public void endElement(java.lang.String eleName,
java.util.Map objState)
endElement in class Field
public java.lang.String getDisplayName(FieldDisplayNameType displayName,
java.util.Locale locale)
IField
Returns the name of the field that has been formatted according to the value of the parameter
displayNameType.
getDisplayName in interface IFieldgetDisplayName in class FielddisplayName - Indicates how the display text should be formatted. It may be one of
the values listed under FieldDisplayNameType.locale - Formats the string according to a locale.
String containing the name of the field that has been formatted
according to the value of the parameter displayNameType.public java.lang.String getFormulaForm()
IFieldReturns the name of the field as it will be used in a formula. This is a unique identifier to avoid ambiguity in formula code. It is the same value as the one used in the CRW formula editor.
getFormulaForm in interface IFieldgetFormulaForm in class FieldString containing the name of the field as it will be used in a
formula.public IGroup getGroup()
ISummaryField
getGroup in interface ISummaryFieldIGroup object containing the group for which the summary field is
being calculated.public FieldKind getKind()
IFieldReturns what kind of field this is. Do not confuse this property with Type. Kind identifies what sort of report field this is, while Type identifies what the field is composed of. For example, a bitmap, string, chart, number, date, and so on.
getKind in interface IFieldString that specifies what kind of field this is.public boolean getIsPrintTime()
getIsPrintTime in class Fieldpublic java.lang.String getLongName(java.util.Locale locale)
IFieldReturns the fully qualified name of the field.
getLongName in interface IFieldgetLongName in class Fieldlocale - The locale that will be used to localize the field.
String containing the fully qualified name of the field.public SummaryOperation getOperation()
ISummaryFieldBase
getOperation in interface ISummaryFieldBaseSummaryOperation object that specifies the manner in which the summary will
be calculated.public int getOperationParameter()
ISummaryFieldBase
getOperationParameter in interface ISummaryFieldBasepublic IField getSecondarySummarizedField()
ISummaryFieldBase
getSecondarySummarizedField in interface ISummaryFieldBasepublic void setSecondarySummarizedField(IField summarizedField)
ISummaryFieldBase
setSecondarySummarizedField in interface ISummaryFieldBasepublic IGroup getSecondGroupForPercentage()
ISummaryField
getSecondGroupForPercentage in interface ISummaryFieldpublic void setSecondGroupForPercentage(IGroup secondGroup)
setSecondGroupForPercentage in interface ISummaryFieldpublic boolean isPercentageSummary()
ISummaryField
isPercentageSummary in interface ISummaryFieldpublic void setPercentageSummary(boolean percentageSummary)
setPercentageSummary in interface ISummaryFieldpublic boolean isSummarizedAcrossHierarchy()
ISummaryField
isSummarizedAcrossHierarchy in interface ISummaryFieldpublic void setSummarizedAcrossHierarchy(boolean sumAcrossHierarchy)
ISummaryField
setSummarizedAcrossHierarchy in interface ISummaryFieldpublic java.lang.String getShortName(java.util.Locale locale)
IFieldReturns the short name of the field.
getShortName in interface IFieldgetShortName in class Fieldlocale - The locale that will be used to localize the field name.
String containing the short name of the field.public IField getSummarizedField()
ISummaryFieldBase
getSummarizedField in interface ISummaryFieldBaseIField object containing the field that is being used to calculate
the summary.public boolean hasContent(java.lang.Object srcSummaryField)
hasContent in class Field
public void readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
readElement in class Field
public void save(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
save in class Fieldjava.io.IOException
public void save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
throws java.io.IOException
save in class Fieldjava.io.IOException
public void saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
saveContents in class Fieldjava.io.IOExceptionpublic void setGroup(IGroup group)
ISummaryField
setGroup in interface ISummaryFieldgroup - An IGroup object containing the group for which the summary field is
being calculated.public void setOperation(SummaryOperation operation)
ISummaryFieldBase
setOperation in interface ISummaryFieldBaseoperation - A SummaryOperation object that specifies the manner in which the summary will
be calculated.public void setOperationParameter(int parameter)
ISummaryFieldBase
setOperationParameter in interface ISummaryFieldBasepublic void setSummarizedField(IField summarizedField)
ISummaryFieldBase
setSummarizedField in interface ISummaryFieldBasesummarizedField - An IField object containing the field that is being used to calculate
the summary.
public void startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
startElement in class Field
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||