|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IDateFieldFormat
This interface 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.
This object describes how the DateFormat property shown by a FieldObject
object should be
formatted if the FieldObject
object is being used to display dates. To access this object,
use the getDateFormat
method. If the field is not being used to represent a DateFormat
property, and you modify this object, your changes will be ignored and discarded.
Method Summary | |
---|---|
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()
Gets the enclosing characters for the name of the day of the week. |
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. |
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)
Sets the enclosing characters for the name of the day of the week. |
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. |
Method Detail |
---|
DateCalendarType getCalendarType()
DateCalendarType
object that specifies the calendar type for the date field.DateFieldFormatConditionFormulas getConditionFormulas()
DateFieldFormatConditionFormulas
object containing the condition formulas
used to override the date field's format settings.java.lang.String getDateFirstSeparator()
String
that specifies the first separator which separates the date elements.DateOrder getDateOrder()
DateOrder
object that specifies the order in which the date elements will appear.java.lang.String getDatePrefixSeparator()
String
that specifies the prefix for the date.java.lang.String getDateSecondSeparator()
String
that specifies the second separator which separates the date elements.java.lang.String getDateSuffixSeparator()
String
that specifies the suffix for the date.DayFormat getDayFormat()
DayFormat
object that specifies the format for displaying the day in the date.DayOfWeekEnclosure getDayOfWeekEnclosure()
DayOfWeekEnclosure
that describes the enclosing characters to be used.DayOfWeekPosition getDayOfWeekPosition()
DayOfWeekPosition
object that specifies where the name of the day appears.java.lang.String getDayOfWeekSeparator()
String
that specifies the separator which is inserted between the name of the
day and the date.DayOfWeekType getDayOfWeekType()
DayOfWeekType
object that specifies the format for displaying the name of the day.DateEraType getEraType()
DateEraType
object that specifies the format for displaying the era or period in
the date.MonthFormat getMonthFormat()
MonthFormat
object that specifies the format for displaying the month in the date.DateSystemDefaultType getSystemDefaultType()
DateSystemDefaultType
object that specifies whether or not to use the default
system date format.YearFormat getYearFormat()
YearFormat
object that specifies the format for displaying the year in the date.void setCalendarType(DateCalendarType calendarType)
calendarType
- A DateCalendarType
object that specifies the calendar type for the date field.void setConditionFormulas(DateFieldFormatConditionFormulas conditionFormulas)
conditionFormulas
- A DateFieldFormatConditionFormulas
object containing the condition formulas
used to override the date field's format settings.void setDateFirstSeparator(java.lang.String dateFirstSeparator)
dateFirstSeparator
- A String
that specifies the first separator which separates the date elements.void setDateOrder(DateOrder dateOrder)
dateOrder
- A DateOrder
object that specifies the order in which the date elements will appear.void setDatePrefixSeparator(java.lang.String datePrefixSeparator)
datePrefixSeparator
- A String
that specifies the prefix for the date.void setDateSecondSeparator(java.lang.String dateSecondSeparator)
dateSecondSeparator
- A String
that specifies the second separator that separates the date elements.void setDateSuffixSeparator(java.lang.String dateSuffixSeparator)
dateSuffixSeparator
- A String
that specifies the suffix for the date.void setDayFormat(DayFormat dayFormat)
dayFormat
- A DayFormat
object that specifies the format for displaying the day in the date.void setDayOfWeekEnclosure(DayOfWeekEnclosure dayOfWeekEnclosure)
dayOfWeekEnclosure
- A DayOfWeekEnclosure
that describes the enclosing character to use.void setDayOfWeekPosition(DayOfWeekPosition dayOfWeekPosition)
dayOfWeekPosition
- A DayOfWeekPosition
object that specifies where the name of the day appears.void setDayOfWeekSeparator(java.lang.String dayOfWeekSeparator)
dayOfWeekSeparator
- A String
that specifies the separator that is inserted between the name of the
day and the date.void setDayOfWeekType(DayOfWeekType dayOfWeekType)
dayOfWeekType
- A DayOfWeekType
object that specifies the format for displaying the name of the day.void setEraType(DateEraType eraType)
eraType
- A DateEraType
object that specifies the format for displaying the era or period in
the date.void setMonthFormat(MonthFormat monthFormat)
monthFormat
- A MonthFormat
object that specifies the format for displaying the month in the date.void setSystemDefaultType(DateSystemDefaultType systemDefaultType)
systemDefaultType
- A DateSystemDefaultType
object that specifies whether or not to use the default
system date format.void setYearFormat(YearFormat yearFormat)
yearFormat
- A YearFormat
object that specifies the format for displaying the year in the date.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |