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

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

public class SpecialField
extends Field
implements ISpecialField

This object allows you to add date and time fields into your report. You do not have to go through a controller to create or define these special fields. You can use this object in the RowsetController and the ReportDefController. Use the ISpecialField interface to get and set special field types.


Constructor Summary
SpecialField()
           
SpecialField(ISpecialField src)
           
SpecialField(SpecialFieldType specialType)
          For internal use only
 
Method Summary
 java.lang.Object clone(boolean deepClone)
           
 void copyTo(java.lang.Object destObject, boolean deepCopy)
           
 java.lang.String getDisplayName(FieldDisplayNameType displayName, java.util.Locale locale)
          For internal use only
 java.lang.String getFormulaForm()
          For internal use only
 FieldKind getKind()
           Returns what kind of field this is.
 SpecialFieldType getSpecialType()
           Returns the type of special field.
 boolean hasContent(java.lang.Object srcSpecialField)
           
 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 setName(java.lang.String name)
          For internal use only
 void setSpecialType(SpecialFieldType specialType)
           Sets the type of special field.
 
Methods inherited from class com.crystaldecisions.sdk.occa.report.data.Field
createMember, endElement, getAttributes, getDescription, getHeadingText, getIsPrintTime, getIsRecurring, getLength, getLongName, getName, getShortName, getType, getValueTypeForFormatOption, setAttributes, setDescription, setHeadingText, setLength, 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, getHeadingText, getIsRecurring, getLength, getLongName, getName, getShortName, getType, getValueTypeForFormatOption, setDescription, setHeadingText, setLength, setType
 

Constructor Detail

SpecialField

public SpecialField(ISpecialField src)

SpecialField

public SpecialField(SpecialFieldType specialType)
For internal use only


SpecialField

public SpecialField()
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

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.

getSpecialType

public SpecialFieldType getSpecialType()
Description copied from interface: ISpecialField

Returns the type of special field.

Specified by:
getSpecialType in interface ISpecialField
Returns:
A SpecialFieldType object that specifies the type of the special field.

hasContent

public boolean hasContent(java.lang.Object srcSpecialField)
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

setSpecialType

public void setSpecialType(SpecialFieldType specialType)
Description copied from interface: ISpecialField

Sets the type of special field.

Specified by:
setSpecialType in interface ISpecialField
Parameters:
specialType - A SpecialFieldType object that specifies the type of the special field.

setName

public void setName(java.lang.String name)
For internal use only

Specified by:
setName in interface IField
Overrides:
setName in class Field
Parameters:
name - A String containing the name of the field.

getFormulaForm

public java.lang.String getFormulaForm()
For internal use only

Specified by:
getFormulaForm in interface IField
Overrides:
getFormulaForm in class Field
Returns:
A String containing the name of the field as it will be used in a formula.

getDisplayName

public java.lang.String getDisplayName(FieldDisplayNameType displayName,
                                       java.util.Locale locale)
For internal use only

Specified by:
getDisplayName in interface IField
Overrides:
getDisplayName in class Field
Parameters:
displayName - Indicates how the display text should be formatted. It may be one of the values listed under FieldDisplayNameType.
locale - Formats the string according to a locale.
Returns:
A String containing the name of the field that has been formatted according to the value of the parameter displayNameType.