Framework JavaScript ACube V2.10.0
 

Classe AgendaComponent

Object
   |
   +--AgendaComponent

class AgendaComponent


the class «AgendaComponent» is the class to manage an AgendaComponent object






IHM

AgendaComponent picture:
PictureAgendaComponent


Example usage of the component AgendaComponent.


Version: 2.8.0

Date: 25/02/2008

Fichiers JS nécessaires:

Definie dans ergonomique/fw_agenda.js

Fichiers CSS 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

_componentId

<private> int _componentId

_date

<private> Date _date

_dayClickCallBack

<private> Function _dayClickCallBack

_domElement

<private> DOMElement _domElement

_endPeriod

<private> Date _endPeriod

_numYear

<private> int _numYear

_provideCallBack

<private> Function _provideCallBack

_providing

<private> Boolean _providing

_renderer

<private> AgendaRenderer _renderer

_specialDays

<private> Object_Array_AgendaSpecialDay _specialDays

_startPeriod

<private> Date _startPeriod

_states

<private> Array_AgendaState _states

Détail des Constructeurs

AgendaComponent

AgendaComponent(<String_Obligatoire> domContainerId)

Détail des Méthodes

addSpecialDay

void addSpecialDay(<Date_Obligatoire> date, <int_Obligatoire> stateId)

backToday

void backToday()

configure

void configure(<XMLDocument_Obligatoire> xmlConfig)

doBackToday

void doBackToday()

doClose

void doClose()

doDayClick

void doDayClick(<Event_Obligatoire> event)

doNextMonth

void doNextMonth()

doNextYear

void doNextYear()

doOpen

void doOpen()

doPrevMonth

void doPrevMonth()

doPrevYear

void doPrevYear()

doToMonth

void doToMonth(<int_Obligatoire> month)

doToYear

void doToYear(<int_Obligatoire> year)

feed

void feed(<XMLDocument_Obligatoire> xmlFlow)

getComponentId

int getComponentId()

getCurrentSpecialDays

Array_AgendaSpecialDays getCurrentSpecialDays()

getDate

Date getDate()

getDaysNum

int getDaysNum(<Date_Obligatoire> date)

getDayStateId

int getDayStateId(<Date_Obligatoire> date)

getDomElement

DOMElement getDomElement()

getMonth

int getMonth()

getRenderer

AgendaRenderer getRenderer()

getSpecialDays

Array_AgendaSpecialDays getSpecialDays()

getState

AgendaState getState(<int_Obligatoire> stateId)

getStates

Array_AgendaState getStates()

getWeekIndex

int getWeekIndex(<Date_Obligatoire> date)

getYear

int getYear()

getYearNum

int getYearNum()

nextMonth

void nextMonth()

nextYear

void nextYear()

prevMonth

void prevMonth()

prevYear

void prevYear()

render

void render()

setDayClickCallBack

void setDayClickCallBack(<Function_Obligatoire> func)

setEndPeriod

void setEndPeriod(<int_Obligatoire> year, <int_Obligatoire> month)

setMonth

void setMonth(<int_Obligatoire> month)

setProvideCallBack

void setProvideCallBack(<Function_Obligatoire> func)

setStartPeriod

void setStartPeriod(<int_Obligatoire> year, <int_Obligatoire> month)

setYear

void setYear(<int_Obligatoire> year)

Framework JavaScript ACube V2.10.0
 

Version 2.10.0, / Etat : Validé
Cette création est mise à disposition selon le Contrat Paternité - Pas d'Utilisation Commerciale - Partage des Conditions Initiales à l'Identique disponible en ligne http://creativecommons.org/licenses/by-nc-sa/2.0/fr/ ou par courrier postal à Creative Commons, 559 Nathan Abbott Way, Stanford,California 94305, USA.


Documentation generated by JSDoc on Wed Jan 6 17:05:02 2010