|
||||||||||
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
This object represents a report field in general.
Constructor Summary | |
Field()
|
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,
com.crystaldecisions.xml.serialization.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. |
java.lang.String |
getDescription()
Returns a description of the field. |
java.lang.String |
getDisplayName(FieldDisplayNameType displayName,
java.util.Locale locale)
Returns the name of the field that has been formatted according to the value of the parameter displayNameType .
|
java.lang.String |
getFormulaForm()
Returns the name of the field as it will be used in a formula. |
java.lang.String |
getHeadingText()
Returns the text used as a heading when the field is added to the report. |
boolean |
getIsRecurring()
Returns true if the field is recurring, and false otherwise. |
int |
getLength()
Returns the maximum length the field's data may be (in bytes). |
java.lang.String |
getLongName(java.util.Locale locale)
Returns the fully qualified name of the field. |
java.lang.String |
getName()
Returns the name of the field. |
java.lang.String |
getShortName(java.util.Locale locale)
Returns the short name of the field. |
FieldValueType |
getType()
Returns what type of field this is. |
boolean |
hasContent(java.lang.Object srcField)
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(com.crystaldecisions.xml.serialization.XMLWriter writer,
com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
For internal use only. |
void |
save(com.crystaldecisions.xml.serialization.XMLWriter writer,
java.lang.String sTag,
com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
For internal use only. |
void |
saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
For internal use only. |
void |
setDescription(java.lang.String description)
Sets the description of the field. |
void |
setHeadingText(java.lang.String headingText)
Sets the text used as a heading when the field is added to the report. |
void |
setLength(int length)
Sets the maximum length the field's data may be (in bytes). |
void |
setName(java.lang.String name)
Sets the name of the field. |
void |
setType(FieldValueType valueType)
Sets what type of field this is. |
void |
startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
For internal use only. |
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 |
getKind |
Constructor Detail |
public Field()
Method Detail |
public java.lang.Object clone(boolean deepClone)
IClone
Returns the new object that has been cloned.
clone
in interface IClone
deepClone
- true
to use deep clone,
false
to use shallow.
public void copyTo(java.lang.Object destObject, boolean deepCopy)
IClone
Copies the object.
copyTo
in interface IClone
destObject
- The destination object to copy to.deepCopy
- true
to use deep copy,
false
to use shallow.public java.lang.Object createMember(java.lang.String eleName, org.xml.sax.Attributes attrs, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt, java.util.Map objState, boolean[] bLoaded)
For internal use only.
public void endElement(java.lang.String eleName, java.util.Map objState)
For internal use only.
public java.lang.String getDescription()
IField
Returns a description of the field.
getDescription
in interface IField
String
containing a description of the field.public java.lang.String getDisplayName(FieldDisplayNameType displayName, java.util.Locale locale)
IField
Returns the name of the field that has been formatted according to the value of the parameter
displayNameType
.
getDisplayName
in interface IField
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.
String
containing the name of the field that has been formatted according to the
value of the parameter displayNameType
.public java.lang.String getFormulaForm()
IField
Returns the name of the field as it will be used in a formula. This is a unique identifier to avoid ambiguity in formula code. It is the same value as the one used in the CRW formula editor.
getFormulaForm
in interface IField
String
containing the name of the field as it will be used in a formula.public java.lang.String getHeadingText()
IField
Returns the text used as a heading when the field is added to the report.
getHeadingText
in interface IField
String
containing the text used as a heading when the field is added to the
report.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
true
if the field is recurring, and false
otherwise.public int getLength()
IField
Returns the maximum length the field's data may be (in bytes).
getLength
in interface IField
String
containing the maximum length the field's data may be (in bytes).public java.lang.String getLongName(java.util.Locale locale)
IField
Returns the fully qualified name of the field.
getLongName
in interface IField
locale
- The locale that will be used to localize the field.
String
containing the fully qualified name of the field.public java.lang.String getName()
IField
Returns the name of the field. For DBField
objects, the value returned by this method is
equivalent to the getDisplayName
method.
getName
in interface IField
String
containing the name of the field.public java.lang.String getShortName(java.util.Locale locale)
IField
Returns the short name of the field.
getShortName
in interface IField
locale
- The locale that will be used to localize the field name.
String
containing the short name of the field.public FieldValueType getType()
IField
Returns what type of field this is. Do not confuse this property with Kind. Kind identifies what sort of report field this is, while Type identifies what data it stores. For example, a bitmap, string, 8 bit integer, chart, etc.
getType
in interface IField
FieldValueType
object that specifies what type of field this is.public boolean hasContent(java.lang.Object srcField)
IClone
Returns true
if this object contains the same elements
as the passed in object.
hasContent
in interface IClone
srcField
- The object to check for content.
true
if this object contains the same elements
as the passed in object, otherwise false
.public void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
For internal use only.
public void save(com.crystaldecisions.xml.serialization.XMLWriter writer, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
public void save(com.crystaldecisions.xml.serialization.XMLWriter writer, java.lang.String sTag, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
public void saveContents(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
public void setDescription(java.lang.String description)
IField
Sets the description of the field.
setDescription
in interface IField
description
- A String
containing a description of the field.public void setHeadingText(java.lang.String headingText)
IField
Sets the text used as a heading when the field is added to the report.
setHeadingText
in interface IField
headingText
- A String
containing the text used as a heading when the field is added
to the report.public void setLength(int length)
IField
Sets the maximum length the field's data may be (in bytes).
setLength
in interface IField
length
- A String
containing the maximum length the field's data may be (in bytes).public void setName(java.lang.String name)
IField
Sets the name of the field. For DBField
objects, the value returned by this method is
equivalent to the getDisplayName
method.
setName
in interface IField
name
- A String
containing the name of the field.public void setType(FieldValueType valueType)
IField
Sets what type of field this is. Do not confuse this property with Kind. Kind identifies what sort of report field this is, while Type identifies what data it stores. For example, a bitmap, string, 8 bit integer, chart, etc.
setType
in interface IField
valueType
- A FieldValueType
object that specifies what type of field this is.public void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
For internal use only.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |