com.crystaldecisions.sdk.occa.report.data
Class FormulaField

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.data.Field
      extended by com.crystaldecisions.sdk.occa.report.data.FormulaField
All Implemented Interfaces:
IField, IFormulaField, IClone

public class FormulaField
extends Field
implements IFormulaField, IClone

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

FormulaField

public FormulaField(IFormulaField src)

FormulaField

public FormulaField()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)
Overrides:
clone in class Field

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)
Overrides:
copyTo in class Field

getIsRecurring

public boolean getIsRecurring()
Description copied from interface: 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.

Specified by:
getIsRecurring in interface IField
Overrides:
getIsRecurring in class Field
Returns:
true if the field is recurring, and false otherwise.

getIsPrintTime

public boolean getIsPrintTime()
For internal use only

Overrides:
getIsPrintTime in class Field

getKind

public FieldKind getKind()
Description copied from interface: IField

Returns 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.

Specified by:
getKind in interface IField
Returns:
A String that specifies what kind of field this is.

getOptions

public int getOptions()
Description copied from interface: IFormulaField

For internal use only.

Specified by:
getOptions in interface IFormulaField

getShortName

public java.lang.String getShortName(java.util.Locale locale)
Description copied from interface: IField

Returns the short name of the field.

Specified by:
getShortName in interface IField
Overrides:
getShortName in class Field
Parameters:
locale - The locale that will be used to localize the field name.
Returns:
A String containing the short name of the field.

getSyntax

public FormulaSyntax getSyntax()

getText

public java.lang.String getText()

getFormulaNullTreatment

public FormulaNullTreatment getFormulaNullTreatment()

hasContent

public boolean hasContent(java.lang.Object srcFormulaField)
Overrides:
hasContent in class Field

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)
Overrides:
readElement in class Field

save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
Overrides:
save in class Field
Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
Overrides:
save in class Field
Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException
Overrides:
saveContents in class Field
Throws:
java.io.IOException

setOptions

public void setOptions(int options)
Description copied from interface: IFormulaField

For internal use only.

Specified by:
setOptions in interface IFormulaField

setSyntax

public void setSyntax(FormulaSyntax syntax)

setText

public void setText(java.lang.String text)

setFormulaNullTreatment

public void setFormulaNullTreatment(FormulaNullTreatment treatment)

getTranslatableStringIds

public java.util.List getTranslatableStringIds()
For internal use only


getTranslatableString

public java.lang.String getTranslatableString(TranslatableStringId id)
For internal use only


setTranslatableString

public void setTranslatableString(TranslatableStringId id,
                                  java.lang.String newText)
For internal use only


getTranslatableStringLabelResourceID

public java.lang.String getTranslatableStringLabelResourceID(TranslatableStringId id)
For internal use only


getTranslatableObject

public IClone getTranslatableObject()
For internal use only


getImageKey

public java.lang.String getImageKey()

For internal use only.