|
Framework JavaScript ACube V2.10.0 | ||||||||
CLASSE PRECEDENTE CLASSE SUIVANTE | CADRES SANS CADRES | ||||||||
SOMMAIRE: ATTR | CONSTR | METH | DETAIL: ATTR | CONSTR | METH |
Object | +--AgendaComponent
the class «AgendaComponent» is the class to manage an AgendaComponent object
IHM
AgendaComponent picture:
Example usage of the component AgendaComponent.
Version: 2.8.0
Date: 25/02/2008
Fichiers JS nécessaires:
Sommaire des Attributs | |
<private> int |
_componentId
Private attribute « _componentId » - the generated id of the component. |
<private> Date |
_date
Private attribute « _date » - the Date object representing the current month of the agenda. |
<private> Function |
_dayClickCallBack
Private attribute « _dayClickCallBack » - the callback called when a click event is fired on a day. |
<private> DOMElement |
_domElement
Private attribute « _domElement » - the DOM element of the container. |
<private> Date |
_endPeriod
Private attribute « _endPeriod » - the Date object representing the ending of the current period. |
<private> int |
_numYear
Private attribute « _numYear » - the number of year to display around the current year in the year selector. |
<private> Function |
_provideCallBack
Private attribute « _provideCallBack » - the callback called when a month outside the current period is requested. |
<private> Boolean |
_providing
Private attribute « _providing » - boolean indicating if the agenda is providing. |
<private> AgendaRenderer |
_renderer
Private attribute « _renderer » - the AgendaRenderer used to render the component. |
<private> Object_Array_AgendaSpecialDay |
_specialDays
Private attribute « _specialDays » - the AgendaSpecialDay collections containing the defined special days for the current period. |
<private> Date |
_startPeriod
Private attribute « _startPeriod » - the Date object representing the beginning of the current period. |
<private> Array_AgendaState |
_states
Private attribute « _states » - the AgendaState array containing the defined states for the current agenda. |
Sommaire des Constructeurs | |
AgendaComponent
(<String_Obligatoire> domContainerId)
Create a new AgendaComponent object. |
Sommaire des Méthodes | |
void
|
addSpecialDay(<Date_Obligatoire> date, <int_Obligatoire> stateId)
The public method « addSpecialDay() » is used to add a new special day. |
void
|
backToday()
The public method « backToday() » is used to reset the date. |
void
|
configure(<XMLDocument_Obligatoire> xmlConfig)
The public method « configure() » is used to configure the states used in the current Agenda. |
void
|
doBackToday()
The public method « doBackToday() » is used to go back to today. |
void
|
doClose()
The public method « doClose() » is used to close or hide the agenda. |
void
|
doDayClick(<Event_Obligatoire> event)
The public method « doDayClick() » is used when a user click on a day. |
void
|
doNextMonth()
The public method « doNextMonth() » is used to go to the next month. |
void
|
doNextYear()
The public method « doNextYear() » is used to go to the next year. |
void
|
doOpen()
The public method « doOpen() » is used to open or show the agenda. |
void
|
doPrevMonth()
The public method « doPrevMonth() » is used to go to the previous month. |
void
|
doPrevYear()
The public method « doPrevYear() » is used to go to the previous year. |
void
|
doToMonth(<int_Obligatoire> month)
The public method « doToMonth() » is used to go to any month. |
void
|
doToYear(<int_Obligatoire> year)
The public method « doToYear() » is used to go to any year. |
void
|
feed(<XMLDocument_Obligatoire> xmlFlow)
The public method « feed() » is used to feed the agenda with datas (period and special days). |
int
|
getComponentId()
The public method « getComponentId() » is used to get the generated Component id. |
Array_AgendaSpecialDays
|
getCurrentSpecialDays()
The public method « getCurrentSpecialDays() » is used to get the defined special days in the current month. |
Date
|
getDate()
The public method « getDate() » is used to get the Date object representing the current month. |
int
|
getDaysNum(<Date_Obligatoire> date)
The public method « getDaysNum() » is used to get the number of days in the month representing by the date. |
int
|
getDayStateId(<Date_Obligatoire> date)
The public method « getDayStateId() » is used to get the AgendaState id of a day. |
DOMElement
|
getDomElement()
The public method « getDomElement() » is used to get the DOM element of the container. |
int
|
getMonth()
The public method « getMonth() » is used to the month of the current Date. |
AgendaRenderer
|
getRenderer()
The public method « getRenderer() » is used to get the AgendaRenderer object. |
Array_AgendaSpecialDays
|
getSpecialDays()
The public method « getSpecialDays() » is used to get the defined special days in the current period. |
AgendaState
|
getState(<int_Obligatoire> stateId)
The public method « getState() » is used to get an AgendaState object from its id. |
Array_AgendaState
|
getStates()
The public method « getStates() » is used to get the defined states for the current agenda. |
int
|
getWeekIndex(<Date_Obligatoire> date)
The public method « getWeekIndex() » is used to get the week number of a date. |
int
|
getYear()
The public method « getYear() » is used to get the year of the current Date. |
int
|
getYearNum()
The public method « getYearNum() » is used to get the year number to display around the current year. |
void
|
nextMonth()
The public method « nextMonth() » is used to go to increment the current month. |
void
|
nextYear()
The public method « nextYear() » is used to go to increment the current year. |
void
|
prevMonth()
The public method « prevMonth() » is used to decrement the current month. |
void
|
prevYear()
The public method « prevYear() » is used to decrement the current year. |
void
|
render()
The public method « render() » is used to render the Agenda in the DOMElement container. |
void
|
setDayClickCallBack(<Function_Obligatoire> func)
The public method « setDayClickCallBack() » is used to set the click callback. |
void
|
setEndPeriod(<int_Obligatoire> year, <int_Obligatoire> month)
The public method « setEndPeriod() » is used to set the end of the current period (in month). |
void
|
setMonth(<int_Obligatoire> month)
The public method « setMonth() » is used to set a new month. |
void
|
setProvideCallBack(<Function_Obligatoire> func)
The public method « setProvideCallBack() » is used to set the provide callback. |
void
|
setStartPeriod(<int_Obligatoire> year, <int_Obligatoire> month)
The public method « setStartPeriod() » is used to set the beginning of the current period (in month). |
void
|
setYear(<int_Obligatoire> year)
The public method « setYear() » is used to set a new year. |
Détail des Attributs |
<private> int _componentId
<private> Date _date
<private> Function _dayClickCallBack
<private> DOMElement _domElement
<private> Date _endPeriod
<private> int _numYear
<private> Function _provideCallBack
<private> Boolean _providing
<private> AgendaRenderer _renderer
<private> Object_Array_AgendaSpecialDay _specialDays
<private> Date _startPeriod
<private> Array_AgendaState _states
Détail des Constructeurs |
AgendaComponent(<String_Obligatoire> domContainerId)
domContainerId - String_Obligatoire
: the DOMElement containter id for the agenda
Détail des Méthodes |
void addSpecialDay(<Date_Obligatoire> date, <int_Obligatoire> stateId)
date - Date_Obligatoire
: the date of the special day
stateId - int_Obligatoire
: the id of the AgendaState
void backToday()
none -
void configure(<XMLDocument_Obligatoire> xmlConfig)
xmlConfig - XMLDocument_Obligatoire
: the xml flow containing the states definition.
void doBackToday()
none -
void doClose()
none -
void doDayClick(<Event_Obligatoire> event)
event - Event_Obligatoire
: the DOM Event
void doNextMonth()
none -
void doNextYear()
none -
void doOpen()
none -
void doPrevMonth()
none -
void doPrevYear()
none -
void doToMonth(<int_Obligatoire> month)
month - int_Obligatoire
:
void doToYear(<int_Obligatoire> year)
year - int_Obligatoire
:
void feed(<XMLDocument_Obligatoire> xmlFlow)
xmlFlow - XMLDocument_Obligatoire
: the xml flow
int getComponentId()
none -
Array_AgendaSpecialDays getCurrentSpecialDays()
none -
Date getDate()
none -
int getDaysNum(<Date_Obligatoire> date)
date - Date_Obligatoire
: the date
int getDayStateId(<Date_Obligatoire> date)
date - Date_Obligatoire
: the Date object of the day
DOMElement getDomElement()
none -
int getMonth()
none -
AgendaRenderer getRenderer()
none -
Array_AgendaSpecialDays getSpecialDays()
none -
AgendaState getState(<int_Obligatoire> stateId)
stateId - int_Obligatoire
: the id of the AgendaState
Array_AgendaState getStates()
none -
int getWeekIndex(<Date_Obligatoire> date)
date - Date_Obligatoire
: the date
int getYear()
none -
int getYearNum()
none -
void nextMonth()
none -
void nextYear()
none -
void prevMonth()
none -
void prevYear()
none -
void render()
none -
void setDayClickCallBack(<Function_Obligatoire> func)
func - Function_Obligatoire
: the callback called when a click is fired on a day void setEndPeriod(<int_Obligatoire> year, <int_Obligatoire> month)
year - int_Obligatoire
: the year
month - int_Obligatoire
: the month (1-12)
void setMonth(<int_Obligatoire> month)
month - int_Obligatoire
: the new month (0-11).
void setProvideCallBack(<Function_Obligatoire> func)
func - Function_Obligatoire
: the callback called when a date outside the current period is requested void setStartPeriod(<int_Obligatoire> year, <int_Obligatoire> month)
year - int_Obligatoire
: the year
month - int_Obligatoire
: the month (1-12)
void setYear(<int_Obligatoire> year)
year - int_Obligatoire
: the new year.
|
Framework JavaScript ACube V2.10.0 | ||||||||
CLASSE PRECEDENTE CLASSE SUIVANTE | CADRES SANS CADRES | ||||||||
SOMMAIRE: ATTR | CONSTR | METH | DETAIL: ATTR | CONSTR | METH |