|
|||||||||
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)
|
Method Summary | |
---|---|
java.lang.Object |
clone(boolean deepClone)
|
void |
copyTo(java.lang.Object destObject,
boolean deepCopy)
|
void |
doControllerModification(java.lang.Object newObject)
|
void |
enumerateMembers(IMemberVisitor visitor)
|
ControllableMixin |
getControllableMixin()
|
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. |
FieldKind |
getKind()
Returns what kind of field this is. |
java.lang.String |
getShortName(java.util.Locale locale)
Returns the short name of the field. |
SpecialFieldType |
getSpecialType()
Returns the type of special field. |
boolean |
hasContent(java.lang.Object srcSpecialField)
|
boolean |
isDirectlyControllable()
|
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 |
setName(java.lang.String name)
Sets the name of the field. |
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, getType, 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, getType, 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 Field
public FieldKind getKind()
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.
getKind
in interface IField
String
that specifies what kind of field this is.public SpecialFieldType getSpecialType()
ISpecialField
Returns the type of special field.
getSpecialType
in interface ISpecialField
SpecialFieldType
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)
Field
For internal use only.
readElement
in class Field
public void save(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
save
in class Field
java.io.IOException
public void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
save
in class Field
java.io.IOException
public void saveContents(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
Field
For internal use only.
saveContents
in class Field
java.io.IOException
public void setSpecialType(SpecialFieldType specialType)
ISpecialField
Sets the type of special field.
setSpecialType
in interface ISpecialField
specialType
- A SpecialFieldType
object that specifies the type of the special field.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
IField.getDisplayName(FieldDisplayNameType, java.util.Locale)
method.
setName
in interface IField
setName
in class Field
name
- A String
containing the name of the field.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
getFormulaForm
in class Field
String
containing the name of the field as it will be used in a
formula.public java.lang.String getShortName(java.util.Locale locale)
IField
Returns the short name of the field.
getShortName
in interface IField
getShortName
in class Field
locale
- The locale that will be used to localize the field name.
String
containing the short name 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
getDisplayName
in class Field
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 ControllableMixin getControllableMixin()
getControllableMixin
in class Field
public void doControllerModification(java.lang.Object newObject)
public boolean isDirectlyControllable()
public void enumerateMembers(IMemberVisitor visitor)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |