|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ICalendarProvider
Interface definition for a provider that supplies calendar unit and day to a CalendarTable control
DefaultCalendarProvider
Method Summary | |
---|---|
ICalendarDay |
getCurrentDay()
Get the day at the current day index within the current calendar unit. |
CalendarUnit |
getCurrentUnit()
Get the current aligned calendar unit index, expressed as the number of calendar units from the provider start date |
int |
getDayCount()
Get the number of days within the current calendar unit. |
Date |
getEndDate()
Get the end date of the date range for this provider. |
Date |
getInitialDate()
Get the initial date to display. |
int |
getNumUnits()
Get the number of calendar units in this provider. |
Date |
getStartDate()
Get the start date of the date range for this provider. |
int |
getUnitCount()
Get the number of calendar units in this provider. |
Date |
getUnitEndDate()
Get the last day date in the current calendar unit (e.g. |
String |
getUnits()
Get the calendar unit of measure for this provider. |
Date |
getUnitStartDate()
Get the first day date in the current calendar unit (e.g. |
String |
getUnitVariable()
Get the name of the request variable that current CalendarUnit will be exposed as. |
void |
initialize(String units,
Date startDate,
Date endDate,
Date initialDate,
int numDisplayUnits)
Common method to set the content of the calendar provider. |
boolean |
isDayAvailable()
Is the day selected by setDayIndex within the start and end dates of the current calendar unit. |
boolean |
isInitialized()
Determine if method initialize has been called. |
void |
setDayIndex(int dayIndex)
Set the index of the day within the current calendar unit. |
void |
setEndDate(Date date)
Set the end date for the date range for this provider |
void |
setInitialDate(Date initialDate)
Set the initial date to display. |
void |
setNumUnits(int numUnits)
Set the the number of calendar units |
void |
setStartDate(Date date)
Set the start date of the date range for this provider. |
void |
setUnitIndex(int unitIndex)
Set the current aligned calendar unit index, expressed as the number of calendar units from the provider start date |
void |
setUnits(String numUnits)
Set the calendar unit of measure for this provider. |
void |
setUnitVariable(String var)
Set the name of the request variable that current Calendar Unit will be exposed as. |
Methods inherited from interface com.webmethods.caf.faces.data.ITableContentProvider |
---|
getCurrentRow, getRowCount, getRowIndex, getRowVariable, isRowAvailable, setRowIndex, setRowVariable |
Methods inherited from interface com.webmethods.caf.faces.data.IContentProvider |
---|
getPropertyKeys, getType, getValue, hasProperty, toString |
Method Detail |
---|
boolean isInitialized()
void initialize(String units, Date startDate, Date endDate, Date initialDate, int numDisplayUnits)
units
- The unit of measurement. (Example: day, week, month, year )startDate
- The start date for the date range of events in this calendar provider.endDate
- The end date for the date range of events in this calendar provider.initialDate
- An initial start date within the date range of events in this calendar provider.numDisplayUnits
- The number of calendar units displays by the provider.Date getStartDate()
void setStartDate(Date date)
startDate
- The end date for the date range of this provider.Date getEndDate()
void setEndDate(Date date)
endDate
- The end date for the date range of this provider.Date getInitialDate()
void setInitialDate(Date initialDate)
initialDate
- The initial date this provider will display.String getUnits()
DefaultCalendarProvider
void setUnits(String numUnits)
numUnits
- The unit of measure.DefaultCalendarProvider
int getNumUnits()
CalendarUnit
void setNumUnits(int numUnits)
numUnits
- void setUnitIndex(int unitIndex)
unitIndex
- The index for the current calendar unit.CalendarUnit
CalendarUnit getCurrentUnit()
CalendarUnit
String getUnitVariable()
void setUnitVariable(String var)
var
- The name of the provider variable.int getUnitCount()
Date getUnitStartDate()
Date getUnitEndDate()
void setDayIndex(int dayIndex)
dayIndex
- The number of days, staring at one.int getDayCount()
ICalendarDay getCurrentDay()
boolean isDayAvailable()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |