oracle.adf.view.faces.bi.component.graph

Class TimeAxisDateFormat

java.lang.Object

oracle.adf.view.faces.bi.component.BIComplexAttributeBase

oracle.adf.view.faces.bi.component.graph.TimeAxisDateFormat

All Implemented Interfaces:

javax.faces.component.StateHolder

public class TimeAxisDateFormat
extends BIComplexAttributeBase

Defines properties for formatting date and time values in a graph.

Since:

11.0

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.myfaces.trinidad.bean.PropertyKey	DAY_FORMAT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MONTH_FORMAT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	QUARTER_FORMAT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	TIME_FORMAT_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	YEAR_FORMAT_KEY

Fields inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase

ID_KEY, m_parent, TRANSIENT_KEY

Constructor Summary

Constructors

Constructor and Description
TimeAxisDateFormat()

Method Summary

Modifier and Type	Method and Description
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.lang.String	getDayFormat() Retrieves the format for day information.
java.lang.String	getMonthFormat() Retrieves the format for month information.
java.lang.String	getQuarterFormat() Retrieves the format for quarter information.
java.lang.String	getTimeFormat() Retrieves the format for time information.
java.lang.String	getYearFormat() Retrieves the format for year information.
protected void	resetStyleProperties()
void	setDayFormat(java.lang.String format) Specifies the format for day information.
void	setMonthFormat(java.lang.String format) Specifies the format for month information.
void	setQuarterFormat(java.lang.String format) Specifies the format for quarter information.
void	setTimeFormat(java.lang.String format) Specifies the format for time information.
void	setYearFormat(java.lang.String format) Specifies the format for year information.

Methods inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase

applyProperties, getBooleanProperty, getFacesBean, getId, getParent, getProperty, getPropertyKey, getSetAttributeIndex, isTransient, isUpdated, processSetAttribute, processSetAttributeAndAdd, registerAttachedObjectKey, restoreState, saveState, setBooleanProperty, setId, setParent, setProperty, setTransient, setUpdated

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

YEAR_FORMAT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey YEAR_FORMAT_KEY

QUARTER_FORMAT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey QUARTER_FORMAT_KEY

MONTH_FORMAT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey MONTH_FORMAT_KEY

DAY_FORMAT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DAY_FORMAT_KEY

TIME_FORMAT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey TIME_FORMAT_KEY

Constructor Detail

TimeAxisDateFormat

public TimeAxisDateFormat()

Method Detail

setYearFormat

public void setYearFormat(java.lang.String format)

Specifies the format for year information.

Parameters:

format -

The default value is automatic, and it will change based on the occupancy of the axis labels. Valid values are:

• AUTOMATIC - (Default) The graph chooses the setting automatically.
• YEAR_LONG - The number of the year. Example: 2006.
• YEAR_LONG_WITH_COMMA - The number of the year with a comma. Example: 2,006.
• YEAR_SHORT - The number of the year without the century indicator. Example: 06 instead of 2006.
• YEAR_SHORT_WITH_APOSTROPHE - The number of the year without the century indicator but with a comma. Example: '06.
• NONE - Year is not shown.

getYearFormat

public java.lang.String getYearFormat()

Retrieves the format for year information.

Returns:

format

The default value is automatic, and it will change based on the occupancy of the axis labels. Valid values are:

• AUTOMATIC - (Default) The graph chooses the setting automatically.
• YEAR_LONG - The number of the year. Example: 2006.
• YEAR_LONG_WITH_COMMA - The number of the year with a comma. Example: 2,006.
• YEAR_SHORT - The number of the year without the century indicator. Example: 06 instead of 2006.
• YEAR_SHORT_WITH_APOSTROPHE - The number of the year without the century indicator but with a comma. Example: '06.
• NONE - Year is not shown.

setQuarterFormat

public void setQuarterFormat(java.lang.String format)

Specifies the format for quarter information.

Parameters:

format -

The default value is automatic, and it will change based on the occupancy of the axis labels. Valid values are:

• AUTOMATIC - (Default) The graph chooses the setting automatically.
• QUARTER_LONG - The text and number of the quarter. Example: Quarter 1.
• QUARTER_SHORT - Abbreviated text and number of the quarter. Example: Qtr 1.
• QUARTER_SINGLE_LETTER - Single letter and the number of the quarter. Example: Q1.
• NONE - Quarter is not shown.

getQuarterFormat

public java.lang.String getQuarterFormat()

Retrieves the format for quarter information.

Returns:

format

The default value is automatic, and it will change based on the occupancy of the axis labels. Valid values are:

• AUTOMATIC - (Default) The graph chooses the setting automatically.
• QUARTER_LONG - The text and number of the quarter. Example: Quarter 1.
• QUARTER_SHORT - Abbreviated text and number of the quarter. Example: Qtr 1.
• QUARTER_SINGLE_LETTER - Single letter and the number of the quarter. Example: Q1.
• NONE - Quarter is not shown.

setMonthFormat

public void setMonthFormat(java.lang.String format)

Specifies the format for month information.

Parameters:

format -

The default value is automatic, and it will change based on the occupancy of the axis labels. Valid values are:

• AUTOMATIC - (Default) The graph chooses the setting automatically.
• MONTH_LONG - Full name of the month. Example: January.
• MONTH_SHORT - Abbreviated name of the month. Example: Jan.
• MONTH_NUMBER - Number of the month. Example for January: 1.
• MONTH_SINGLE_LETTER - First letter of the month. Example for January: J.
• NONE - Month is not shown.

getMonthFormat

public java.lang.String getMonthFormat()

Retrieves the format for month information.

Returns:

format

The default value is automatic, and it will change based on the occupancy of the axis labels. Valid values are:

• AUTOMATIC - (Default) The graph chooses the setting automatically.
• MONTH_LONG - Full name of the month. Example: January.
• MONTH_SHORT - Abbreviated name of the month. Example: Jan.
• MONTH_NUMBER - Number of the month. Example for January: 1.
• MONTH_SINGLE_LETTER - First letter of the month. Example for January: J.
• NONE - Month is not shown.

setDayFormat

public void setDayFormat(java.lang.String format)

Specifies the format for day information.

Parameters:

format -

The default value is automatic, and it will change based on the occupancy of the axis labels. Valid values are:

• AUTOMATIC - (Default) The graph chooses the setting automatically.
• DAY_OF_WEEK_NUMBER - The number of the day in the week. Example for Monday: 1.
• DAY_OF_WEEK - The text for the day of the week. Example: Monday.
• DAY_OF_WEEK_ABBR - The string abbreviation of the day of the week. Example: Mon.
• DAY_SINGLE_LETTER - The first letter of the day of the week. Example: M.
• NONE - Day is not shown.

getDayFormat

public java.lang.String getDayFormat()

Retrieves the format for day information.

Returns:

format

The default value is automatic, and it will change based on the occupancy of the axis labels. Valid values are:

• AUTOMATIC - (Default) The graph chooses the setting automatically.
• DAY_OF_WEEK_NUMBER - The number of the day in the week. Example for Monday: 1.
• DAY_OF_WEEK - The text for the day of the week. Example: Monday.
• DAY_OF_WEEK_ABBR - The string abbreviation of the day of the week. Example: Mon.
• DAY_SINGLE_LETTER - The first letter of the day of the week. Example: M.
• NONE - Day is not shown.

setTimeFormat

public void setTimeFormat(java.lang.String format)

Specifies the format for time information.

Parameters:

format - The default value is automatic, and it will change based on the occupancy of the axis labels. Valid values are:

• AUTOMATIC - (Default) The graph chooses the setting automatically.
• HOUR - Hour on a 12-hour clock. Example: 03 pm.
• HOUR24 - Hour on a 24-hour clock. Example: 15.
• HOUR_MINUTE - Hour and minute on a 12-hour clock. Example: 03:20 pm.
• HOUR24_MINUTE - Hour and minute on a 24-hour clock. Example: 15:20.
• HOUR_MINUTE_SECOND - Hour, minute, second on a 12-hour clock. Example: 03:20:05 pm.
• HOUR24_MINUTE_SECOND - Hour, minute, second on a 24-hour clock. Example: 15:20:05.
• NONE - Time is not shown.

getTimeFormat

public java.lang.String getTimeFormat()

Retrieves the format for time information.

Returns:

format The default value is automatic, and it will change based on the occupancy of the axis labels. Valid values are:

• AUTOMATIC - (Default) The graph chooses the setting automatically.
• HOUR - Hour on a 12-hour clock. Example: 03 pm.
• HOUR24 - Hour on a 24-hour clock. Example: 15.
• HOUR_MINUTE - Hour and minute on a 12-hour clock. Example: 03:20 pm.
• HOUR24_MINUTE - Hour and minute on a 24-hour clock. Example: 15:20.
• HOUR_MINUTE_SECOND - Hour, minute, second on a 12-hour clock. Example: 03:20:05 pm.
• HOUR24_MINUTE_SECOND - Hour, minute, second on a 24-hour clock. Example: 15:20:05.
• NONE - Time is not shown.

resetStyleProperties

protected void resetStyleProperties()

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Specified by:

getBeanType in class BIComplexAttributeBase