|
|||||||||
| 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.FormulaField
public class FormulaField
This object implements a formula field in the report.
Use the IFormulaField interface to access
this object. To modify formula fields in a report,
use the DataDefController.
| Constructor Summary | |
|---|---|
FormulaField()
|
|
FormulaField(IFormulaField src)
|
|
| Method Summary | |
|---|---|
java.lang.Object |
clone(boolean deepClone)
|
void |
copyTo(java.lang.Object destObject,
boolean deepCopy)
|
FormulaNullTreatment |
getFormulaNullTreatment()
|
java.lang.String |
getImageKey()
For internal use only. |
boolean |
getIsPrintTime()
For internal use only |
boolean |
getIsRecurring()
Returns true if the field is recurring, and false otherwise. |
FieldKind |
getKind()
Returns what kind of field this is. |
int |
getOptions()
For internal use only. |
java.lang.String |
getShortName(java.util.Locale locale)
Returns the short name of the field. |
FormulaSyntax |
getSyntax()
|
java.lang.String |
getText()
|
IClone |
getTranslatableObject()
For internal use only |
java.lang.String |
getTranslatableString(TranslatableStringId id)
For internal use only |
java.util.List |
getTranslatableStringIds()
For internal use only |
java.lang.String |
getTranslatableStringLabelResourceID(TranslatableStringId id)
For internal use only |
boolean |
hasContent(java.lang.Object srcFormulaField)
|
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 |
setFormulaNullTreatment(FormulaNullTreatment treatment)
|
void |
setOptions(int options)
For internal use only. |
void |
setSyntax(FormulaSyntax syntax)
|
void |
setText(java.lang.String text)
|
void |
setTranslatableString(TranslatableStringId id,
java.lang.String newText)
For internal use only |
| Methods inherited from class com.crystaldecisions.sdk.occa.report.data.Field |
|---|
createMember, endElement, getAttributes, getDescription, getDisplayName, getFormulaForm, getHeadingText, getLength, getLongName, getName, getType, getValueTypeForFormatOption, setAttributes, setDescription, setHeadingText, setLength, setName, setType, startElement |
| 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, getDisplayName, getFormulaForm, getHeadingText, getLength, getLongName, getName, getType, getValueTypeForFormatOption, setDescription, setHeadingText, setLength, setName, setType |
| Constructor Detail |
|---|
public FormulaField(IFormulaField src)
public FormulaField()
| 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 Fieldpublic boolean getIsRecurring()
IField
Returns true if the field is recurring, and false otherwise. A
field is recurring if its contents change during the formatting of a report. A constant field
(not recurring) is one that doesn't change. The special field "Page Number," for example, is
a recurring field, while the special field "Report Title" is not.
getIsRecurring in interface IFieldgetIsRecurring in class Fieldtrue if the field is recurring, and false otherwise.public boolean getIsPrintTime()
getIsPrintTime in class Fieldpublic 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 int getOptions()
IFormulaFieldFor internal use only.
getOptions in interface IFormulaFieldpublic 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 FormulaSyntax getSyntax()
public java.lang.String getText()
public FormulaNullTreatment getFormulaNullTreatment()
public boolean hasContent(java.lang.Object srcFormulaField)
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 setOptions(int options)
IFormulaFieldFor internal use only.
setOptions in interface IFormulaFieldpublic void setSyntax(FormulaSyntax syntax)
public void setText(java.lang.String text)
public void setFormulaNullTreatment(FormulaNullTreatment treatment)
public java.util.List getTranslatableStringIds()
public java.lang.String getTranslatableString(TranslatableStringId id)
public void setTranslatableString(TranslatableStringId id,
java.lang.String newText)
public java.lang.String getTranslatableStringLabelResourceID(TranslatableStringId id)
public IClone getTranslatableObject()
public java.lang.String getImageKey()
For internal use only.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||