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

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

public class DateTimeFieldFormat
extends java.lang.Object
implements IDateTimeFieldFormat, IClone

This object describes how a DateTime value shown by a FieldObject object should be formatted if the FieldObject object is being used to display dates and/or times. When possible, use the IDateTimeFieldFormat interface to manipulate this object.


Constructor Summary
DateTimeFieldFormat()
           
DateTimeFieldFormat(IDateTimeFieldFormat src)
           
DateTimeFieldFormat(java.util.Locale locale)
           
 
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)
           
 DateTimeFieldFormatConditionFormulas getConditionFormulas()
           Returns the condition formulas used to override the date field's format settings.
 ControllableMixin getControllableMixin()
           
 DateTimeOrder getDateTimeOrder()
           Returns the order in which the elements of DateTime field appear.
 java.lang.String getDateTimeSeparator()
           Returns the separator between the date and time.
 boolean hasContent(java.lang.Object srcDateTimeFieldFormat)
           
 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 setConditionFormulas(DateTimeFieldFormatConditionFormulas conditionFormulas)
           Sets the condition formulas used to override the date field's format settings.
 void setDateTimeOrder(DateTimeOrder dateTimeOrder)
           Sets the order in which the elements of DateTime field appear.
 void setDateTimeSeparator(java.lang.String dateTimeSeparator)
           Sets the separator between the date and time.
 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

DateTimeFieldFormat

public DateTimeFieldFormat(IDateTimeFieldFormat src)

DateTimeFieldFormat

public DateTimeFieldFormat()

DateTimeFieldFormat

public DateTimeFieldFormat(java.util.Locale locale)
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.


getConditionFormulas

public DateTimeFieldFormatConditionFormulas getConditionFormulas()
Description copied from interface: IDateTimeFieldFormat

Returns the condition formulas used to override the date field's format settings.

Specified by:
getConditionFormulas in interface IDateTimeFieldFormat
Returns:
A DateTimeFieldFormatConditionFormulas object containing the condition formulas used to override the date field's format settings.

getDateTimeOrder

public DateTimeOrder getDateTimeOrder()
Description copied from interface: IDateTimeFieldFormat

Returns the order in which the elements of DateTime field appear.

Specified by:
getDateTimeOrder in interface IDateTimeFieldFormat
Returns:
A DateTimeOrder object that specifies the order in which the elements of DateTime field appear.

getDateTimeSeparator

public java.lang.String getDateTimeSeparator()
Description copied from interface: IDateTimeFieldFormat

Returns the separator between the date and time.

Specified by:
getDateTimeSeparator in interface IDateTimeFieldFormat
Returns:
A String containing the separator between the date and time.

hasContent

public boolean hasContent(java.lang.Object srcDateTimeFieldFormat)

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

setConditionFormulas

public void setConditionFormulas(DateTimeFieldFormatConditionFormulas conditionFormulas)
Description copied from interface: IDateTimeFieldFormat

Sets the condition formulas used to override the date field's format settings.

Specified by:
setConditionFormulas in interface IDateTimeFieldFormat
Parameters:
conditionFormulas - A DateTimeFieldFormatConditionFormulas object containing the condition formulas used to override the date field's format settings.

setDateTimeOrder

public void setDateTimeOrder(DateTimeOrder dateTimeOrder)
Description copied from interface: IDateTimeFieldFormat

Sets the order in which the elements of DateTime field appear.

Specified by:
setDateTimeOrder in interface IDateTimeFieldFormat
Parameters:
dateTimeOrder - A DateTimeOrder object that specifies the order in which the elements of DateTime field appear.

setDateTimeSeparator

public void setDateTimeSeparator(java.lang.String dateTimeSeparator)
Description copied from interface: IDateTimeFieldFormat

Sets the separator between the date and time.

Specified by:
setDateTimeSeparator in interface IDateTimeFieldFormat
Parameters:
dateTimeSeparator - A String containing the separator between the date and time.

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