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

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.definition.ReportObject
      extended by com.crystaldecisions.sdk.occa.report.definition.TextObject
          extended by com.crystaldecisions.sdk.occa.report.definition.FieldHeadingObject
All Implemented Interfaces:
IFieldHeadingObject, IReportObject, ITextObject, IClone

public class FieldHeadingObject
extends TextObject
implements IFieldHeadingObject, IClone

This object is used to specify the field heading for the report object. For instance, you might specify that a field heading display "First Name" for the column that lists the first name of individuals. When possible, use the IFieldHeadingObject interface.


Constructor Summary
FieldHeadingObject()
           
FieldHeadingObject(IFieldHeadingObject src)
           
 
Method Summary
 java.lang.Object clone(boolean deepClone)
           
 void copyTo(java.lang.Object destObject, boolean deepCopy)
           
 java.lang.String getFieldObjectName()
           Returns the identifier for the heading of the name of the FieldObject.
 boolean hasContent(java.lang.Object srcFieldHeadingObject)
           
 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, XMLSerializationContext ctxt)
          For internal use only.
 void saveContents(XMLWriter writer, XMLSerializationContext ctxt)
          For internal use only.
 void setFieldObjectName(java.lang.String fieldObjectName)
           Sets the identifier for the heading of the name of the FieldObject.
 
Methods inherited from class com.crystaldecisions.sdk.occa.report.definition.TextObject
createMember, disconnect, endElement, enumerateMembers, getEmbeddedContentType, getEnableSuppressIfDuplicated, getFontColor, getMaxNumberOfLines, getParagraphs, getReadingOrder, getSuppressEmbeddedFieldBlankLines, getText, isConnected, refresh, save, setEmbeddedContentType, setEnableSuppressIfDuplicated, setFontColor, setMaxNumberOfLines, setParagraphs, setReadingOrder, setSuppressEmbeddedFieldBlankLines, startElement
 
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.ITextObject
getEnableSuppressIfDuplicated, getFontColor, getMaxNumberOfLines, getParagraphs, getReadingOrder, getSuppressEmbeddedFieldBlankLines, getText, setEnableSuppressIfDuplicated, setFontColor, setMaxNumberOfLines, setParagraphs, setReadingOrder, setSuppressEmbeddedFieldBlankLines
 
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

FieldHeadingObject

public FieldHeadingObject(IFieldHeadingObject src)

FieldHeadingObject

public FieldHeadingObject()
Method Detail

clone

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

copyTo

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

getFieldObjectName

public java.lang.String getFieldObjectName()
Description copied from interface: IFieldHeadingObject

Returns the identifier for the heading of the name of the FieldObject. For example, you may have a field heading display "First Name" for the column that lists the fist name of individuals of DBField "Customer.FirstName".

Specified by:
getFieldObjectName in interface IFieldHeadingObject
Returns:
A String that specifies the identifier for the heading of the name of the FieldObject.

hasContent

public boolean hasContent(java.lang.Object srcFieldHeadingObject)
Overrides:
hasContent in class TextObject

readElement

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

Overrides:
readElement in class TextObject

save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
Description copied from class: TextObject
For internal use only.

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

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException
Description copied from class: TextObject
For internal use only.

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

setFieldObjectName

public void setFieldObjectName(java.lang.String fieldObjectName)
Description copied from interface: IFieldHeadingObject

Sets the identifier for the heading of the name of the FieldObject. For example, you may have a field heading display "First Name" for the column that lists the fist name of individuals of DBField "Customer.FirstName".

Specified by:
setFieldObjectName in interface IFieldHeadingObject
Parameters:
fieldObjectName - A String that specifies the identifier for the heading of the name of the FieldObject.