Class SweetDevRia.BaseCalendar

RIA Base calendar.
Defined in: BaseCalendar.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	SweetDevRia.BaseCalendar(id, containerId, monthyear, selected)

Field Summary
Field Attributes	Field Name and Description
	acronymCounter Acronym counter used to optimize loop.
	acronymCss CSS class used for acronyms rendering.
	acronymDates Date list used for acronyms rendering.
	acronymList Acronyms list used for acronyms rendering.
	enabled Enabled property.
	mustBeRendered If calendar is hidden, we don't need to render it but we must know that it must be rendered when it will be displayed.
	tooltip Click to open tooltip JavaScript object.

Method Summary
Method Attributes	Method Name and Description
<private>	_unload(e, cal)
	addAcronymRender(Date, List, CSS) Add a acronym and a rendering for specified dates in dateList.
	addCells(node) This recursive method browse the HTML table object and add each cells to the cells collection.
	addListenerClear(link) Add listener on clear.
	addListenerClose(link) Add listener on close.
	addListenerGoOnToday(link) Add listener on "go on today".
	addListenerNextMonth(link) Add listener on next month.
	addListenerNextYear(link) Add listener on next year.
	addListenerPrevionsMonth(link) Add listener on previous month.
	addListenerPrevionsYear(link) Add listener on previous year.
	close() If the calendar is opened into a tooltip, close it.
	focus() Set focus on selected date or, if not, on today.
	getAcronymAndCss(Working) This method returns the acronym and the CSS class to apply for a specified date.
	getEnabled() Method used to know if a calendar is activated or not.
	getIndex() Get the cell's index for a date if it's found in calendar.
	handleEvent(evt) This is an overridden function from RiaComponent.
	onClose() Event to trigger on popup close.
	onContainerMove(dx, dy) Moving method.
	onCurrentMonth() Return true if date is the current's calendar month.
	openTooltip() Open the tooltip or set the focus on it if it's still opened.
	render() Override YAHOO.widget.Calendar_Core.render function in order to use generated html.
	renderBodyCellRestricted(workingDate, cell) Override YAHOO.widget.Calendar_Core.prototype.renderBodyCellRestricted.
	renderCellDefault(workingDate, cell) Override YAHOO.widget.Calendar_Core.prototype.render in order to add an acronym on some cells.
	setEnabled(enabled) Activate or de-activate the component calendar.

Class Detail

SweetDevRia.BaseCalendar(id, containerId, monthyear, selected)

Parameters:
{String} id: The id of the table element that will represent the calendar widget
{String} containerId: The id of the container element that will contain the calendar table
{String} monthyear: The month/year string used to set the current calendar page
{String} selected: A string of date values formatted using the date parser. The built-in default date format is MM/DD/YYYY. Ranges are defined using MM/DD/YYYY-MM/DD/YYYY. Month/day combinations are defined using MM/DD. Any combination of these can be combined by delimiting the string with commas. Example: "12/24/2005,12/25,1/18/2006-1/21/2006"

Field Detail

{Array} acronymCounter

Acronym counter used to optimize loop.

{Array} acronymCss

CSS class used for acronyms rendering.

{Array} acronymDates

Date list used for acronyms rendering.

{Array} acronymList

Acronyms list used for acronyms rendering.

enabled

Enabled property. If false, inputs are disabled and onclik desactivated

mustBeRendered

If calendar is hidden, we don't need to render it but we must know that it must be rendered when it will be displayed.

{ClickToOpen object} tooltip

Click to open tooltip JavaScript object.

Method Detail

<private> _unload(e, cal)

Parameters:
e
cal

addAcronymRender(Date, List, CSS)

Add a acronym and a rendering for specified dates in dateList.

Parameters:
{String} Date: List, separated by comma.
{String[]} List: of acronyms in same order than date list.
{String[]} CSS: Style class.

addCells(node)

This recursive method browse the HTML table object and add each cells to the cells collection.

Parameters:
{HTMLElement} node: a HTML table child node.

addListenerClear(link)

Add listener on clear.

Parameters:
{HTMLLink} link: in wich add clear action.

addListenerClose(link)

Add listener on close.

Parameters:
{HTMLLink} link: in wich add close action.

addListenerGoOnToday(link)

Add listener on "go on today".

Parameters:
{HTMLLink} link: in wich add "go on today" action.

addListenerNextMonth(link)

Add listener on next month.

Parameters:
{HTMLLink} link: in wich add next month action.

addListenerNextYear(link)

Add listener on next year.

Parameters:
{HTMLLink} link: in wich add next year action.

addListenerPrevionsMonth(link)

Add listener on previous month.

Parameters:
{HTMLLink} link: in wich add previous month action.

addListenerPrevionsYear(link)

Add listener on previous year.

Parameters:
{HTMLLink} link: in wich add previous year action.

close()

If the calendar is opened into a tooltip, close it.

focus()

Set focus on selected date or, if not, on today.

{Array} getAcronymAndCss(Working)

This method returns the acronym and the CSS class to apply for a specified date.

Parameters:
{Date} Working: date.

Returns:: If found, returns an array composed of acronym at index 0 and the CSS style class to apply on index 1.

getEnabled()

Method used to know if a calendar is activated or not.

Returns:: The enabled variable.

getIndex()

Get the cell's index for a date if it's found in calendar. Returns -1 if not found.

Parameters:
{Date} Date.

Returns:: cell index.

handleEvent(evt)

This is an overridden function from RiaComponent. It's called to catch event.

Parameters:
{RiaEvent} evt: RiaEvent object

onClose()

Event to trigger on popup close. Do nothing by default. To be overridden

onContainerMove(dx, dy)

Moving method.

Parameters:
{int} dx: delta X to move the component to
{int} dy: delta Y to move the component to

onCurrentMonth()

Return true if date is the current's calendar month.

Parameters:
{Date} Date.

Returns:: True or false

openTooltip()

Open the tooltip or set the focus on it if it's still opened.

Parameters:
{Date} Date.

Returns:: False

render()

Override YAHOO.widget.Calendar_Core.render function in order to use generated html.

{String} renderBodyCellRestricted(workingDate, cell)

Override YAHOO.widget.Calendar_Core.prototype.renderBodyCellRestricted. Renders the current calendar cell as a non-selectable "black-out" date using the default restricted style.

Parameters:
{Date} workingDate: The current working Date object being used to generate the calendar
{HTMLTableCellElement} cell: The current working cell in the calendar

Returns:: YAHOO.widget.Calendar_Core.STOP_RENDER if rendering should stop with this style, null or nothing if rendering should not be terminated

{String} renderCellDefault(workingDate, cell)

Override YAHOO.widget.Calendar_Core.prototype.render in order to add an acronym on some cells.

Parameters:
{Date} workingDate: The current working Date object being used to generate the calendar
{HTMLTableCellElement} cell: The current working cell in the calendar

Returns:: YAHOO.widget.Calendar_Core.STOP_RENDER if rendering should stop with this style, null or nothing if rendering should not be terminated

setEnabled(enabled)

Activate or de-activate the component calendar.

Parameters:
{boolean} enabled: Choose the method action (activate or de-activate).

Classes

Class SweetDevRia.BaseCalendar