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

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

public class TimeFieldFormat
extends java.lang.Object
implements ITimeFieldFormat, IClone

This object describes how the time format shown by a FieldObject should be formatted if the FieldObject is being used to display time. If the field is not being used to represent a TimeFormat property, and you modify this object, your changes will be ignored and discarded.


Constructor Summary
TimeFieldFormat()
           
TimeFieldFormat(ITimeFieldFormat src)
           
TimeFieldFormat(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)
           
 AMPMFormat getAMPMFormat()
          Returns the position for AM or PM.
 java.lang.String getAMString()
          Returns the String used to identify the time that is between midnight and noon.
 TimeFieldFormatConditionFormulas getConditionFormulas()
          Returns the condition formulas for the time field format.
 ControllableMixin getControllableMixin()
           
 HourFormat getHourFormat()
          Returns the format for displaying the hour.
 java.lang.String getHourMinuteSeparator()
          Returns the separator used to separate the hours and minutes.
 MinuteFormat getMinuteFormat()
          Returns the format for displaying the minutes.
 java.lang.String getMinuteSecondSeparator()
          Returns the separator used to separate the minutes and seconds.
 java.lang.String getPMString()
          Returns the String used to identify the time that is between noon and midnight.
 SecondFormat getSecondFormat()
          Returns the format for displaying the seconds.
 TimeBase getTimeBase()
          Returns the time base.
 boolean hasContent(java.lang.Object srcTimeFieldFormat)
           
 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 setAMPMFormat(AMPMFormat aMPMFormat)
          Sets the position for AM or PM.
 void setAMString(java.lang.String aMString)
          Sets the String used to identify the time that is between midnight and noon.
 void setConditionFormulas(TimeFieldFormatConditionFormulas conditionFormulas)
          Sets the condition formulas for the time field format.
 void setHourFormat(HourFormat hourFormat)
          Sets the format for displaying the hour.
 void setHourMinuteSeparator(java.lang.String hourMinuteSeparator)
          Sets the separator used to separate the hours and minutes.
 void setMinuteFormat(MinuteFormat minuteFormat)
          Sets the format for displaying the minutes.
 void setMinuteSecondSeparator(java.lang.String minuteSecondSeparator)
          Sets the separator used to separate the minutes and seconds.
 void setPMString(java.lang.String pMString)
          Sets the String used to identify the time that is between noon and midnight.
 void setSecondFormat(SecondFormat secondFormat)
          Sets the format for displaying the seconds.
 void setTimeBase(TimeBase timeBase)
          Sets the time base.
 boolean skipWritingIdenticalObject()
           For internal use only.
 void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TimeFieldFormat

public TimeFieldFormat(ITimeFieldFormat src)

TimeFieldFormat

public TimeFieldFormat()

TimeFieldFormat

public TimeFieldFormat(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.


getAMPMFormat

public AMPMFormat getAMPMFormat()
Description copied from interface: ITimeFieldFormat

Returns the position for AM or PM.

Specified by:
getAMPMFormat in interface ITimeFieldFormat
Returns:
The AM PM format as an AMPMFormat.

getAMString

public java.lang.String getAMString()
Description copied from interface: ITimeFieldFormat

Returns the String used to identify the time that is between midnight and noon.

Specified by:
getAMString in interface ITimeFieldFormat
Returns:
The AM String.

getConditionFormulas

public TimeFieldFormatConditionFormulas getConditionFormulas()
Description copied from interface: ITimeFieldFormat

Returns the condition formulas for the time field format.

Specified by:
getConditionFormulas in interface ITimeFieldFormat
Returns:
The condition formulas as TimeFieldFormatConditionFormulas.

getHourFormat

public HourFormat getHourFormat()
Description copied from interface: ITimeFieldFormat

Returns the format for displaying the hour.

Specified by:
getHourFormat in interface ITimeFieldFormat
Returns:
The hour format as an HourFormat.

getHourMinuteSeparator

public java.lang.String getHourMinuteSeparator()
Description copied from interface: ITimeFieldFormat

Returns the separator used to separate the hours and minutes.

Specified by:
getHourMinuteSeparator in interface ITimeFieldFormat
Returns:
The separator as a String.

getMinuteFormat

public MinuteFormat getMinuteFormat()
Description copied from interface: ITimeFieldFormat

Returns the format for displaying the minutes.

Specified by:
getMinuteFormat in interface ITimeFieldFormat
Returns:
The minute format as a MinuteFormat.

getMinuteSecondSeparator

public java.lang.String getMinuteSecondSeparator()
Description copied from interface: ITimeFieldFormat

Returns the separator used to separate the minutes and seconds.

Specified by:
getMinuteSecondSeparator in interface ITimeFieldFormat
Returns:
The separator as a String.

getPMString

public java.lang.String getPMString()
Description copied from interface: ITimeFieldFormat

Returns the String used to identify the time that is between noon and midnight.

Specified by:
getPMString in interface ITimeFieldFormat
Returns:
The PM String.

getSecondFormat

public SecondFormat getSecondFormat()
Description copied from interface: ITimeFieldFormat

Returns the format for displaying the seconds.

Specified by:
getSecondFormat in interface ITimeFieldFormat
Returns:
The minute format as a SecondFormat.

getTimeBase

public TimeBase getTimeBase()
Description copied from interface: ITimeFieldFormat

Returns the time base. The time base specifies that the time is in either a 12-hour or 24-hour format.

Specified by:
getTimeBase in interface ITimeFieldFormat
Returns:
The time base as a TimeBase.

hasContent

public boolean hasContent(java.lang.Object srcTimeFieldFormat)

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

setAMPMFormat

public void setAMPMFormat(AMPMFormat aMPMFormat)
Description copied from interface: ITimeFieldFormat

Sets the position for AM or PM.

Specified by:
setAMPMFormat in interface ITimeFieldFormat
Parameters:
aMPMFormat - The AM PM format as an AMPMFormat.

setAMString

public void setAMString(java.lang.String aMString)
Description copied from interface: ITimeFieldFormat

Sets the String used to identify the time that is between midnight and noon.

Specified by:
setAMString in interface ITimeFieldFormat
Parameters:
aMString - The AM String.

setConditionFormulas

public void setConditionFormulas(TimeFieldFormatConditionFormulas conditionFormulas)
Description copied from interface: ITimeFieldFormat

Sets the condition formulas for the time field format.

Specified by:
setConditionFormulas in interface ITimeFieldFormat
Parameters:
conditionFormulas - The condition formulas as TimeFieldFormatConditionFormulas.

setHourFormat

public void setHourFormat(HourFormat hourFormat)
Description copied from interface: ITimeFieldFormat

Sets the format for displaying the hour.

Specified by:
setHourFormat in interface ITimeFieldFormat
Parameters:
hourFormat - The hour format as an HourFormat.

setHourMinuteSeparator

public void setHourMinuteSeparator(java.lang.String hourMinuteSeparator)
Description copied from interface: ITimeFieldFormat

Sets the separator used to separate the hours and minutes.

Specified by:
setHourMinuteSeparator in interface ITimeFieldFormat
Parameters:
hourMinuteSeparator - The separator as a String.

setMinuteFormat

public void setMinuteFormat(MinuteFormat minuteFormat)
Description copied from interface: ITimeFieldFormat

Sets the format for displaying the minutes.

Specified by:
setMinuteFormat in interface ITimeFieldFormat
Parameters:
minuteFormat - The minute format as a MinuteFormat.

setMinuteSecondSeparator

public void setMinuteSecondSeparator(java.lang.String minuteSecondSeparator)
Description copied from interface: ITimeFieldFormat

Sets the separator used to separate the minutes and seconds.

Specified by:
setMinuteSecondSeparator in interface ITimeFieldFormat
Parameters:
minuteSecondSeparator - The separator as a String.

setPMString

public void setPMString(java.lang.String pMString)
Description copied from interface: ITimeFieldFormat

Sets the String used to identify the time that is between noon and midnight.

Specified by:
setPMString in interface ITimeFieldFormat
Parameters:
pMString - The PM String.

setSecondFormat

public void setSecondFormat(SecondFormat secondFormat)
Description copied from interface: ITimeFieldFormat

Sets the format for displaying the seconds.

Specified by:
setSecondFormat in interface ITimeFieldFormat
Parameters:
secondFormat - The minute format as a SecondFormat.

setTimeBase

public void setTimeBase(TimeBase timeBase)
Description copied from interface: ITimeFieldFormat

Sets the time base. The time base specifies that the time is in either a 12-hour or 24-hour format.

Specified by:
setTimeBase in interface ITimeFieldFormat
Parameters:
timeBase - The time base as a TimeBase.

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)

doControllerModification

public void doControllerModification(java.lang.Object newObject)

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)

getControllableMixin

public ControllableMixin getControllableMixin()

isDirectlyControllable

public boolean isDirectlyControllable()