|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.crystaldecisions.sdk.occa.report.definition.DateFieldFormat
public class DateFieldFormat
This object is used to specify the format of the date field or the date part of
the DateTimeField in the report object. You can specify
properties such as the calendar type, the date, month, and year format, and the order in which the date
elements appear. When possible, use the IDateFieldFormat interface.
| Constructor Summary | |
|---|---|
DateFieldFormat()
|
|
DateFieldFormat(IDateFieldFormat src)
|
|
DateFieldFormat(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 |
endElement(java.lang.String eleName,
java.util.Map objState)
For internal use only. |
DateCalendarType |
getCalendarType()
Returns the calendar type for the date field. |
DateFieldFormatConditionFormulas |
getConditionFormulas()
Returns the condition formulas used to override the date field's format settings. |
java.lang.String |
getDateFirstSeparator()
Returns the first separator which separates the date elements. |
DateOrder |
getDateOrder()
Returns the order in which the date elements will appear. |
java.lang.String |
getDatePrefixSeparator()
Returns the prefix for the date. |
java.lang.String |
getDateSecondSeparator()
Returns the second separator which separates the date elements. |
java.lang.String |
getDateSuffixSeparator()
Returns the suffix for the date. |
DayFormat |
getDayFormat()
Returns the format for displaying the day in the date. |
DayOfWeekEnclosure |
getDayOfWeekEnclosure()
For internal use only |
DayOfWeekPosition |
getDayOfWeekPosition()
Returns where the name of the day appears. |
java.lang.String |
getDayOfWeekSeparator()
Returns the separator which is inserted between the name of the day and the date. |
DayOfWeekType |
getDayOfWeekType()
Returns the format for displaying the name of the day. |
DateEraType |
getEraType()
Returns the format for displaying the era or period in the date. |
MonthFormat |
getMonthFormat()
Returns the format for displaying the month in the date. |
DateSystemDefaultType |
getSystemDefaultType()
Returns whether or not to use the default system date format. |
YearFormat |
getYearFormat()
Returns the format for displaying the year in the date. |
boolean |
hasContent(java.lang.Object srcDateFieldFormat)
|
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 |
setCalendarType(DateCalendarType calendarType)
Sets the calendar type for the date field. |
void |
setConditionFormulas(DateFieldFormatConditionFormulas conditionFormulas)
Sets the condition formulas used to override the date field's format settings. |
void |
setDateFirstSeparator(java.lang.String dateFirstSeparator)
Sets the first separator which separates the date elements. |
void |
setDateOrder(DateOrder dateOrder)
Sets the order in which the date elements will appear. |
void |
setDatePrefixSeparator(java.lang.String datePrefixSeparator)
Sets the prefix for the date. |
void |
setDateSecondSeparator(java.lang.String dateSecondSeparator)
Sets the second separator that separates the date elements. |
void |
setDateSuffixSeparator(java.lang.String dateSuffixSeparator)
Sets the suffix for the date. |
void |
setDayFormat(DayFormat dayFormat)
Sets the format for displaying the day in the date. |
void |
setDayOfWeekEnclosure(DayOfWeekEnclosure dayOfWeekEnclosure)
For internal use only |
void |
setDayOfWeekPosition(DayOfWeekPosition dayOfWeekPosition)
Sets where the name of the day appears. |
void |
setDayOfWeekSeparator(java.lang.String dayOfWeekSeparator)
Sets the separator that is inserted between the name of the day and the date. |
void |
setDayOfWeekType(DayOfWeekType dayOfWeekType)
Sets the format for displaying the name of the day. |
void |
setEraType(DateEraType eraType)
Sets the format for displaying the era or period in the date. |
void |
setMonthFormat(MonthFormat monthFormat)
Sets the format for displaying the month in the date. |
void |
setSystemDefaultType(DateSystemDefaultType systemDefaultType)
Sets whether or not to use the default system date format. |
void |
setYearFormat(YearFormat yearFormat)
Sets the format for displaying the year in the date. |
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 |
|---|
public DateFieldFormat(IDateFieldFormat src)
public DateFieldFormat()
public DateFieldFormat(java.util.Locale locale)
| Method Detail |
|---|
public java.lang.Object clone(boolean deepClone)
public void copyTo(java.lang.Object destObject,
boolean deepCopy)
public java.lang.Object createMember(java.lang.String eleName,
org.xml.sax.Attributes attrs,
XMLSerializationContext ctxt,
java.util.Map objState,
boolean[] bLoaded)
public void endElement(java.lang.String eleName,
java.util.Map objState)
public DateCalendarType getCalendarType()
IDateFieldFormat
getCalendarType in interface IDateFieldFormatDateCalendarType object that specifies the calendar type for the date field.public DateFieldFormatConditionFormulas getConditionFormulas()
IDateFieldFormat
getConditionFormulas in interface IDateFieldFormatDateFieldFormatConditionFormulas object containing the condition formulas
used to override the date field's format settings.public java.lang.String getDateFirstSeparator()
IDateFieldFormat
getDateFirstSeparator in interface IDateFieldFormatString that specifies the first separator which separates the date elements.public DateOrder getDateOrder()
IDateFieldFormat
getDateOrder in interface IDateFieldFormatDateOrder object that specifies the order in which the date elements will appear.public java.lang.String getDatePrefixSeparator()
IDateFieldFormat
getDatePrefixSeparator in interface IDateFieldFormatString that specifies the prefix for the date.public java.lang.String getDateSecondSeparator()
IDateFieldFormat
getDateSecondSeparator in interface IDateFieldFormatString that specifies the second separator which separates the date elements.public java.lang.String getDateSuffixSeparator()
IDateFieldFormat
getDateSuffixSeparator in interface IDateFieldFormatString that specifies the suffix for the date.public DayFormat getDayFormat()
IDateFieldFormat
getDayFormat in interface IDateFieldFormatDayFormat object that specifies the format for displaying the day in the date.public DayOfWeekPosition getDayOfWeekPosition()
IDateFieldFormat
getDayOfWeekPosition in interface IDateFieldFormatDayOfWeekPosition object that specifies where the name of the day appears.public DayOfWeekEnclosure getDayOfWeekEnclosure()
IDateFieldFormat
getDayOfWeekEnclosure in interface IDateFieldFormatpublic java.lang.String getDayOfWeekSeparator()
IDateFieldFormat
getDayOfWeekSeparator in interface IDateFieldFormatString that specifies the separator which is inserted between the name of the
day and the date.public DayOfWeekType getDayOfWeekType()
IDateFieldFormat
getDayOfWeekType in interface IDateFieldFormatDayOfWeekType object that specifies the format for displaying the name of the day.public DateEraType getEraType()
IDateFieldFormat
getEraType in interface IDateFieldFormatDateEraType object that specifies the format for displaying the era or period in
the date.public MonthFormat getMonthFormat()
IDateFieldFormat
getMonthFormat in interface IDateFieldFormatMonthFormat object that specifies the format for displaying the month in the date.public DateSystemDefaultType getSystemDefaultType()
IDateFieldFormat
getSystemDefaultType in interface IDateFieldFormatDateSystemDefaultType object that specifies whether or not to use the default
system date format.public YearFormat getYearFormat()
IDateFieldFormat
getYearFormat in interface IDateFieldFormatYearFormat object that specifies the format for displaying the year in the date.public boolean hasContent(java.lang.Object srcDateFieldFormat)
public void readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
public void save(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
java.io.IOException
public void save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
throws java.io.IOException
java.io.IOException
public void saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
java.io.IOExceptionpublic void setCalendarType(DateCalendarType calendarType)
IDateFieldFormat
setCalendarType in interface IDateFieldFormatcalendarType - A DateCalendarType object that specifies the calendar type for the date field.public void setConditionFormulas(DateFieldFormatConditionFormulas conditionFormulas)
IDateFieldFormat
setConditionFormulas in interface IDateFieldFormatconditionFormulas - A DateFieldFormatConditionFormulas object containing the condition formulas
used to override the date field's format settings.public void setDateFirstSeparator(java.lang.String dateFirstSeparator)
IDateFieldFormat
setDateFirstSeparator in interface IDateFieldFormatdateFirstSeparator - A String that specifies the first separator which separates the date elements.public void setDateOrder(DateOrder dateOrder)
IDateFieldFormat
setDateOrder in interface IDateFieldFormatdateOrder - A DateOrder object that specifies the order in which the date elements will appear.public void setDatePrefixSeparator(java.lang.String datePrefixSeparator)
IDateFieldFormat
setDatePrefixSeparator in interface IDateFieldFormatdatePrefixSeparator - A String that specifies the prefix for the date.public void setDateSecondSeparator(java.lang.String dateSecondSeparator)
IDateFieldFormat
setDateSecondSeparator in interface IDateFieldFormatdateSecondSeparator - A String that specifies the second separator that separates the date elements.public void setDateSuffixSeparator(java.lang.String dateSuffixSeparator)
IDateFieldFormat
setDateSuffixSeparator in interface IDateFieldFormatdateSuffixSeparator - A String that specifies the suffix for the date.public void setDayFormat(DayFormat dayFormat)
IDateFieldFormat
setDayFormat in interface IDateFieldFormatdayFormat - A DayFormat object that specifies the format for displaying the day in the date.public void setDayOfWeekEnclosure(DayOfWeekEnclosure dayOfWeekEnclosure)
IDateFieldFormat
setDayOfWeekEnclosure in interface IDateFieldFormatpublic void setDayOfWeekPosition(DayOfWeekPosition dayOfWeekPosition)
IDateFieldFormat
setDayOfWeekPosition in interface IDateFieldFormatdayOfWeekPosition - A DayOfWeekPosition object that specifies where the name of the day appears.public void setDayOfWeekSeparator(java.lang.String dayOfWeekSeparator)
IDateFieldFormat
setDayOfWeekSeparator in interface IDateFieldFormatdayOfWeekSeparator - A String that specifies the separator that is inserted between the name of the
day and the date.public void setDayOfWeekType(DayOfWeekType dayOfWeekType)
IDateFieldFormat
setDayOfWeekType in interface IDateFieldFormatdayOfWeekType - A DayOfWeekType object that specifies the format for displaying the name of the day.public void setEraType(DateEraType eraType)
IDateFieldFormat
setEraType in interface IDateFieldFormateraType - A DateEraType object that specifies the format for displaying the era or period in
the date.public void setMonthFormat(MonthFormat monthFormat)
IDateFieldFormat
setMonthFormat in interface IDateFieldFormatmonthFormat - A MonthFormat object that specifies the format for displaying the month in the date.public void setSystemDefaultType(DateSystemDefaultType systemDefaultType)
IDateFieldFormat
setSystemDefaultType in interface IDateFieldFormatsystemDefaultType - A DateSystemDefaultType object that specifies whether or not to use the default
system date format.public void setYearFormat(YearFormat yearFormat)
IDateFieldFormat
setYearFormat in interface IDateFieldFormatyearFormat - A YearFormat object that specifies the format for displaying the year in the date.public boolean skipWritingIdenticalObject()
public void startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||