com.crystaldecisions.sdk.occa.report.definition
Class FieldObject

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.definition.ReportObject
      extended by com.crystaldecisions.sdk.occa.report.definition.FieldObject
All Implemented Interfaces:
IFieldObject, IReportObject, IClone

public class FieldObject
extends ReportObject
implements IFieldObject, IClone

This object implements a field found in a report (for example, special field, database field, parameter field, and so on). This object provides methods for formatting information for a field in your report. A FieldObject object is obtained from the ReportObjects collection. When possible, use the IFieldObject interface to manipulate this object.


Constructor Summary
FieldObject()
           
FieldObject(IFieldObject 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)
          For internal use only.
 void endElement(java.lang.String eleName, java.util.Map objState)
          For internal use only.
 void enumerateMembers(IMemberVisitor visitor)
          For internal use only.
 java.lang.String getDataSource()
          Deprecated. As of Version 10, it was replaced with the getDataSourceName method in order to maintain consistency with the BlobFieldObject object.
 java.lang.String getDataSourceName()
           Returns the formula form of the field name.
 com.crystaldecisions.sdk.occa.report.definition.EmbeddedContentType getEmbeddedContentType()
          For internal use only.
 IFieldFormat getFieldFormat()
           Returns the format of the field object
 FieldValueType getFieldValueType()
           Returns the value type of the field.
 IFontColor getFontColor()
           Returns the font color properties for the field.
 boolean hasContent(java.lang.Object srcFieldObject)
           
 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 setDataSource(java.lang.String dataSource)
          Deprecated. As of Version 10, it was replaced with the setDataSourceName method in order to maintain consistency with the BlobFieldObject object.
 void setDataSourceName(java.lang.String dataSourceName)
           Sets the formula form of the field name.
 void setEmbeddedContentType(com.crystaldecisions.sdk.occa.report.definition.EmbeddedContentType embeddedContentType)
          For internal use only.
 void setFieldFormat(IFieldFormat fieldFormat)
           Sets the format of the field object
 void setFieldValueType(FieldValueType fieldValueType)
          Deprecated.  
 void setFieldValueType(FieldValueType fieldValueType, java.util.Locale locale)
           Sets the value type of the field.
 void setFontColor(IFontColor fontColor)
           Sets the font color properties for the field.
 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.definition.ReportObject
doControllerModification, getBorder, getBorderMargins, getControllableMixin, getFormat, getHeight, getKind, getLeft, getLinkedURI, getName, getReplacementConditionFormulas, getReportPartBookmark, getSectionCode, getSectionName, getTop, getVersion, getWidth, isDirectlyControllable, setBorder, setFormat, setHeight, setKind, setLeft, setLinkedURI, setName, setReplacementConditionFormulas, setReportPartBookmark, setSectionCode, setSectionName, setTop, setVersion, setWidth
 
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.definition.IReportObject
getBorder, getBorderMargins, getFormat, getHeight, getKind, getLeft, getLinkedURI, getName, getReplacementConditionFormulas, getReportPartBookmark, getSectionCode, getSectionName, getTop, getWidth, setBorder, setFormat, setHeight, setLeft, setLinkedURI, setName, setReplacementConditionFormulas, setReportPartBookmark, setSectionCode, setSectionName, setTop, setWidth
 

Constructor Detail

FieldObject

public FieldObject(IFieldObject src)

FieldObject

public FieldObject()
Method Detail

clone

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

copyTo

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

createMember

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.

Overrides:
createMember in class ReportObject

endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)
For internal use only.

Overrides:
endElement in class ReportObject

getDataSource

public java.lang.String getDataSource()
Deprecated. As of Version 10, it was replaced with the getDataSourceName method in order to maintain consistency with the BlobFieldObject object.

Specified by:
getDataSource in interface IFieldObject

getDataSourceName

public java.lang.String getDataSourceName()
Description copied from interface: IFieldObject

Returns the formula form of the field name.

Specified by:
getDataSourceName in interface IFieldObject
Returns:
A String that specifies the formula form of the field name.

getFieldFormat

public IFieldFormat getFieldFormat()
Description copied from interface: IFieldObject

Returns the format of the field object

Specified by:
getFieldFormat in interface IFieldObject
Returns:
An IFieldFormat object that specifies the format of the field object.

getFieldValueType

public FieldValueType getFieldValueType()
Description copied from interface: IFieldObject

Returns the value type of the field.

Specified by:
getFieldValueType in interface IFieldObject
Returns:
A FieldValueType object that specifies the value type of the field.

getFontColor

public IFontColor getFontColor()
Description copied from interface: IFieldObject

Returns the font color properties for the field.

Specified by:
getFontColor in interface IFieldObject
Returns:
An IFontColor object that specifies the font color properties for the field.

getEmbeddedContentType

public com.crystaldecisions.sdk.occa.report.definition.EmbeddedContentType getEmbeddedContentType()
For internal use only.


hasContent

public boolean hasContent(java.lang.Object srcFieldObject)
Overrides:
hasContent in class ReportObject

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)
For internal use only.

Overrides:
readElement in class ReportObject

save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
For internal use only.

Overrides:
save in class ReportObject
Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
For internal use only.

Overrides:
save in class ReportObject
Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException
For internal use only.

Overrides:
saveContents in class ReportObject
Throws:
java.io.IOException

setDataSource

public void setDataSource(java.lang.String dataSource)
Deprecated. As of Version 10, it was replaced with the setDataSourceName method in order to maintain consistency with the BlobFieldObject object.

Specified by:
setDataSource in interface IFieldObject

setDataSourceName

public void setDataSourceName(java.lang.String dataSourceName)
Description copied from interface: IFieldObject

Sets the formula form of the field name.

Specified by:
setDataSourceName in interface IFieldObject
Parameters:
dataSourceName - A String that specifies the formula form of the field name.

setFieldFormat

public void setFieldFormat(IFieldFormat fieldFormat)
Description copied from interface: IFieldObject

Sets the format of the field object

Specified by:
setFieldFormat in interface IFieldObject
Parameters:
fieldFormat - An IFieldFormat object that specifies the format of the field object.

setFieldValueType

public void setFieldValueType(FieldValueType fieldValueType)
Deprecated. 

Description copied from interface: IFieldObject

Sets the value type of the field.

Specified by:
setFieldValueType in interface IFieldObject
Parameters:
fieldValueType - A FieldValueType object that specifies the value type of the field.

setFieldValueType

public void setFieldValueType(FieldValueType fieldValueType,
                              java.util.Locale locale)
Description copied from interface: IFieldObject

Sets the value type of the field.

Specified by:
setFieldValueType in interface IFieldObject
Parameters:
fieldValueType - A FieldValueType object that specifies the value type of the field.
locale - A Locale object.

setFontColor

public void setFontColor(IFontColor fontColor)
Description copied from interface: IFieldObject

Sets the font color properties for the field.

Specified by:
setFontColor in interface IFieldObject
Parameters:
fontColor - An IFontColor object that specifies the font color properties for the field.

setEmbeddedContentType

public void setEmbeddedContentType(com.crystaldecisions.sdk.occa.report.definition.EmbeddedContentType embeddedContentType)
For internal use only.


startElement

public void startElement(java.lang.String eleName,
                         java.util.Map objState,
                         org.xml.sax.Attributes attrs)
For internal use only.

Overrides:
startElement in class ReportObject

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)
For internal use only.

Overrides:
enumerateMembers in class ReportObject