|
|||||||||
| 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.SpecialField
public class SpecialField
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 |
|---|
public SpecialField(ISpecialField src)
public SpecialField(SpecialFieldType specialType)
public SpecialField()
| Method Detail |
|---|
public java.lang.Object clone(boolean deepClone)
clone in class Field
public void copyTo(java.lang.Object destObject,
boolean deepCopy)
copyTo in class Fieldpublic FieldKind getKind()
IFieldReturns 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 IFieldString that specifies what kind of field this is.public SpecialFieldType getSpecialType()
ISpecialFieldReturns the type of special field.
getSpecialType in interface ISpecialFieldSpecialFieldType object that specifies the type of the special field.public boolean hasContent(java.lang.Object srcSpecialField)
hasContent in class Field
public void readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
readElement in class Field
public void save(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
save in class Fieldjava.io.IOException
public void save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
throws java.io.IOException
save in class Fieldjava.io.IOException
public void saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
saveContents in class Fieldjava.io.IOExceptionpublic void setSpecialType(SpecialFieldType specialType)
ISpecialFieldSets the type of special field.
setSpecialType in interface ISpecialFieldspecialType - A SpecialFieldType object that specifies the type of the special field.public void setName(java.lang.String name)
setName in interface IFieldsetName in class Fieldname - A String containing the name of the field.public java.lang.String getFormulaForm()
getFormulaForm in interface IFieldgetFormulaForm in class FieldString containing the name of the field as it will be used in a
formula.
public java.lang.String getDisplayName(FieldDisplayNameType displayName,
java.util.Locale locale)
getDisplayName in interface IFieldgetDisplayName in class FielddisplayName - 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.
String containing the name of the field that has been formatted
according to the value of the parameter displayNameType.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||