|
||||||||||
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
This object implements a formula field in the report.
Use the IFormulaField
interface to access
this object. To permanently modify formula fields in a report, a
Report Application Server is required.
Constructor Summary | |
FormulaField()
|
|
FormulaField(IFormulaField src)
|
Method Summary | |
java.lang.Object |
clone(boolean deepClone)
Returns the new object that has been cloned. |
void |
copyTo(java.lang.Object destObject,
boolean deepCopy)
Copies the object. |
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 |
endElement(java.lang.String eleName,
java.util.Map objState)
For internal use only. |
FormulaNullTreatment |
getFormulaNullTreatment()
Gets a value that specifies how to deal with NULL values at runtime. |
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()
Returns the syntax used to write the formula. |
java.lang.String |
getText()
Returns the formula string. |
boolean |
hasContent(java.lang.Object srcFormulaField)
Returns true if this object contains the same elements
as the passed in object. |
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 |
setFormulaNullTreatment(FormulaNullTreatment treatment)
Sets a value that specifies how to deal with NULL values at runtime. |
void |
setOptions(int options)
For internal use only. |
void |
setSyntax(FormulaSyntax syntax)
Sets the syntax used to write the formula. |
void |
setText(java.lang.String text)
Sets the formula string. |
void |
startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
For internal use only. |
Methods inherited from class com.crystaldecisions.sdk.occa.report.data.Field |
createMember, getDescription, getDisplayName, getFormulaForm, getHeadingText, getLength, getLongName, getName, getType, save, save, 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, getDisplayName, getFormulaForm, getHeadingText, getLength, getLongName, getName, getType, setDescription, setHeadingText, setLength, setName, setType |
Constructor Detail |
public FormulaField(IFormulaField src)
public FormulaField()
Method Detail |
public java.lang.Object clone(boolean deepClone)
IClone
Returns the new object that has been cloned.
clone
in interface IClone
clone
in class Field
public void copyTo(java.lang.Object destObject, boolean deepCopy)
IClone
Copies the object.
copyTo
in interface IClone
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)
For internal use only.
createMember
in class Field
public void endElement(java.lang.String eleName, java.util.Map objState)
Field
For internal use only.
endElement
in class Field
public 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 IField
getIsRecurring
in class Field
public FieldKind getKind()
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.
getKind
in interface IField
String
that specifies what kind of field this is.public int getOptions()
IFormulaField
For internal use only.
getOptions
in interface IFormulaField
public java.lang.String getShortName(java.util.Locale locale)
IField
Returns the short name of the field.
getShortName
in interface IField
getShortName
in class Field
public FormulaSyntax getSyntax()
IFormulaField
Returns the syntax used to write the formula.
getSyntax
in interface IFormulaField
FormulaSyntax
object.public java.lang.String getText()
IFormulaField
Returns the formula string.
getText
in interface IFormulaField
String
.public FormulaNullTreatment getFormulaNullTreatment()
IFormulaField
Gets a value that specifies how to deal with NULL values at runtime.
getFormulaNullTreatment
in interface IFormulaField
FormulaNullTreatment
object that specifies how to deal with NULL values at runtimepublic boolean hasContent(java.lang.Object srcFormulaField)
IClone
Returns true
if this object contains the same elements
as the passed in object.
hasContent
in interface IClone
hasContent
in class Field
public void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
Field
For internal use only.
readElement
in class Field
public void save(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
save
in class Field
java.io.IOException
public void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
save
in class Field
java.io.IOException
public void saveContents(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
saveContents
in class Field
java.io.IOException
public void setOptions(int options)
IFormulaField
For internal use only.
setOptions
in interface IFormulaField
public void setSyntax(FormulaSyntax syntax)
IFormulaField
Sets the syntax used to write the formula.
setSyntax
in interface IFormulaField
syntax
- the FormulaSyntax
objectpublic void setText(java.lang.String text)
IFormulaField
Sets the formula string.
setText
in interface IFormulaField
text
- the formula as a String
public void setFormulaNullTreatment(FormulaNullTreatment treatment)
IFormulaField
Sets a value that specifies how to deal with NULL values at runtime.
setFormulaNullTreatment
in interface IFormulaField
treatment
- a FormulaNullTreatment
object that specifies how to deal with NULL values at runtime.public void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
Field
For internal use only.
startElement
in class Field
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |