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

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.definition.FieldFormat
All Implemented Interfaces:
IFieldFormat, IClone

public class FieldFormat
extends java.lang.Object
implements IFieldFormat, IClone

This object enables you to specify the format of the field, including the date and time format, the numeric format, the string format, and so on. When possible, use the IFieldFormat interface to manipulate this object.


Constructor Summary
FieldFormat()
           
FieldFormat(IFieldFormat src)
           
 
Method Summary
 java.lang.Object clone(boolean deepClone)
           
 void copyTo(java.lang.Object destObject, boolean deepCopy)
           
 java.lang.Object createMember(java.lang.String eleName, org.xml.sax.Attributes attrs, XMLSerializationContext ctxt, java.util.Map objState, boolean[] bLoaded)
           For internal use only.
 void doControllerModification(java.lang.Object newObject)
           
 void endElement(java.lang.String eleName, java.util.Map objState)
           For internal use only.
 void enumerateMembers(IMemberVisitor visitor)
           
 IBooleanFieldFormat getBooleanFormat()
           Returns the boolean format for the field if the field is a boolean field.
 ICommonFieldFormat getCommonFormat()
           Returns the common format for the field.
 ControllableMixin getControllableMixin()
           
 IDateFieldFormat getDateFormat()
           Returns the date format for the field if the field is a date or DateTime field.
 IDateTimeFieldFormat getDateTimeFormat()
           Returns the DateTime format for the field if the field is a DateTime field.
 INumericFieldFormat getNumericFormat()
           Returns the numeric format for the field if the field is a numeric field.
 IStringFieldFormat getStringFormat()
           Returns the string format for the field if the field is a String field.
 ITimeFieldFormat getTimeFormat()
           Returns the time format for the field if the field is a time or DateTime field.
 boolean hasContent(java.lang.Object srcFieldFormat)
           
 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 setBooleanFormat(IBooleanFieldFormat booleanFormat)
           Sets the boolean format for the field if the field is a boolean field.
 void setCommonFormat(ICommonFieldFormat commonFormat)
           Sets the common format for the field.
 void setDateFormat(IDateFieldFormat dateFormat)
           Sets the date format for the field if the field is a date or DateTime field.
 void setDateTimeFormat(IDateTimeFieldFormat dateTimeFormat)
           Sets the DateTime format for the field if the field is a DateTime field.
 void setNumericFormat(INumericFieldFormat numericFormat)
           Sets the numeric format for the field if the field is a numeric field.
 void setStringFormat(IStringFieldFormat stringFormat)
           Sets the string format for the field if the field is a String field.
 void setTimeFormat(ITimeFieldFormat timeFormat)
           Sets the time format for the field if the field is a time or DateTime field.
 boolean skipWritingIdenticalObject()
           For internal use only.
 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
 

Constructor Detail

FieldFormat

public FieldFormat(IFieldFormat src)

FieldFormat

public FieldFormat()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)

createMember

public java.lang.Object createMember(java.lang.String eleName,
                                     org.xml.sax.Attributes attrs,
                                     XMLSerializationContext ctxt,
                                     java.util.Map objState,
                                     boolean[] bLoaded)

For internal use only.


endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)

For internal use only.


getBooleanFormat

public IBooleanFieldFormat getBooleanFormat()
Description copied from interface: IFieldFormat

Returns the boolean format for the field if the field is a boolean field.

Specified by:
getBooleanFormat in interface IFieldFormat
Returns:
An IBooleanFieldFormat object that specifies the boolean format for the field.

getCommonFormat

public ICommonFieldFormat getCommonFormat()
Description copied from interface: IFieldFormat

Returns the common format for the field. (Applies to any field value type.)

Specified by:
getCommonFormat in interface IFieldFormat
Returns:
An ICommonFieldFormat object that specifies the common format for the field.

getDateFormat

public IDateFieldFormat getDateFormat()
Description copied from interface: IFieldFormat

Returns the date format for the field if the field is a date or DateTime field.

Specified by:
getDateFormat in interface IFieldFormat
Returns:
An IDateFieldFormat object that specifies the date format for the field.

getDateTimeFormat

public IDateTimeFieldFormat getDateTimeFormat()
Description copied from interface: IFieldFormat

Returns the DateTime format for the field if the field is a DateTime field.

Specified by:
getDateTimeFormat in interface IFieldFormat
Returns:
An IDateTimeFieldFormat object that specifies the DateTime format for the field.

getNumericFormat

public INumericFieldFormat getNumericFormat()
Description copied from interface: IFieldFormat

Returns the numeric format for the field if the field is a numeric field.

Specified by:
getNumericFormat in interface IFieldFormat
Returns:
An INumericFieldFormat object that specifies the numeric format for the field.

getStringFormat

public IStringFieldFormat getStringFormat()
Description copied from interface: IFieldFormat

Returns the string format for the field if the field is a String field.

Specified by:
getStringFormat in interface IFieldFormat
Returns:
An IStringFieldFormat object that specifies the string format for the field.

getTimeFormat

public ITimeFieldFormat getTimeFormat()
Description copied from interface: IFieldFormat

Returns the time format for the field if the field is a time or DateTime field.

Specified by:
getTimeFormat in interface IFieldFormat
Returns:
An ITimeFieldFormat object that specifies the time format for the field.

hasContent

public boolean hasContent(java.lang.Object srcFieldFormat)

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)

For internal use only.


save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

setBooleanFormat

public void setBooleanFormat(IBooleanFieldFormat booleanFormat)
Description copied from interface: IFieldFormat

Sets the boolean format for the field if the field is a boolean field.

Specified by:
setBooleanFormat in interface IFieldFormat
Parameters:
booleanFormat - An IBooleanFieldFormat object that specifies the boolean format for the field.

setCommonFormat

public void setCommonFormat(ICommonFieldFormat commonFormat)
Description copied from interface: IFieldFormat

Sets the common format for the field. (Applies to any field value type.)

Specified by:
setCommonFormat in interface IFieldFormat
Parameters:
commonFormat - An ICommonFieldFormat object that specifies the common format for the field.

setDateFormat

public void setDateFormat(IDateFieldFormat dateFormat)
Description copied from interface: IFieldFormat

Sets the date format for the field if the field is a date or DateTime field.

Specified by:
setDateFormat in interface IFieldFormat
Parameters:
dateFormat - An IDateFieldFormat object that specifies the date format for the field.

setDateTimeFormat

public void setDateTimeFormat(IDateTimeFieldFormat dateTimeFormat)
Description copied from interface: IFieldFormat

Sets the DateTime format for the field if the field is a DateTime field.

Specified by:
setDateTimeFormat in interface IFieldFormat
Parameters:
dateTimeFormat - An IDateTimeFieldFormat object that specifies the DateTime format for the field.

setNumericFormat

public void setNumericFormat(INumericFieldFormat numericFormat)
Description copied from interface: IFieldFormat

Sets the numeric format for the field if the field is a numeric field.

Specified by:
setNumericFormat in interface IFieldFormat
Parameters:
numericFormat - An INumericFieldFormat object that specifies the numeric format for the field.

setStringFormat

public void setStringFormat(IStringFieldFormat stringFormat)
Description copied from interface: IFieldFormat

Sets the string format for the field if the field is a String field.

Specified by:
setStringFormat in interface IFieldFormat
Parameters:
stringFormat - An IStringFieldFormat object that specifies the string format for the field.

setTimeFormat

public void setTimeFormat(ITimeFieldFormat timeFormat)
Description copied from interface: IFieldFormat

Sets the time format for the field if the field is a time or DateTime field.

Specified by:
setTimeFormat in interface IFieldFormat
Parameters:
timeFormat - An ITimeFieldFormat object that specifies the time format for the field.

skipWritingIdenticalObject

public boolean skipWritingIdenticalObject()

For internal use only.


startElement

public void startElement(java.lang.String eleName,
                         java.util.Map objState,
                         org.xml.sax.Attributes attrs)

For internal use only.


doControllerModification

public void doControllerModification(java.lang.Object newObject)

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)

getControllableMixin

public ControllableMixin getControllableMixin()

isDirectlyControllable

public boolean isDirectlyControllable()