oracle.adf.view.faces.bi.component.gantt
Interface CustomTimeScale

public interface CustomTimeScale

CustomTimeScale represents an application defined time scale. An application would implement the CustomTimeScale interface, and register the implementation with the Gantt component through the customTimeScales attribute. An application can register multiple implementations of the CustomTimeScale interface with the Gantt component. Gantt would use the information in the CustomTimeScale to render the TimeAxis facet.

Method Summary

java.lang.String	getLabel(java.util.Date date) Retrieves the label for the specified date.
java.util.Date	getNextDate(java.util.Date date) Retrieves date after the specified date.
java.util.Date	getPreviousDate(java.util.Date date) Retrieves date earlier than the specified date.
java.lang.String	getScaleName() Retrieves the scale name.

Method Detail

getScaleName

java.lang.String getScaleName()

Retrieves the scale name.

Returns:

scale name

getPreviousDate

java.util.Date getPreviousDate(java.util.Date date)

Retrieves date earlier than the specified date. The returned date should be adjusted to the beginning of the time period. For example, if the time period is in weeks and begins on Sunday, and the input date is Thursday, February 19, 2009, then the adjusted date should be Sunday, February 15, 2009.

Parameters:

date - time to be adjusted

Returns:

the adjusted time

getNextDate

java.util.Date getNextDate(java.util.Date date)

Retrieves date after the specified date. For example, if the time period is in weeks, and the input date is Sunday, February 15, 2009, then the returned date should be Sunday, February 22, 2009.

Parameters:

date - time

Returns:

the time after the specified date

getLabel

java.lang.String getLabel(java.util.Date date)

Retrieves the label for the specified date.

Parameters:

date - time

Returns:

the label for the specified date.