Class Alfresco.dashlet.MiniCalendar

Mini Calendar component.

Fields borrowed from class Alfresco.component.Base:: modules, options, services, widgets

Method Summary
Method Attributes	Method Name and Description
	cloneDate(date) Clone provided date objet
	getAllEvents(eventList)
	getLastEventDay(ev, currentDate, endDate) Return last day between currentDate and endDate when event may occur.
	getNextEventStartDates(event, currentDate) Return next occurrence of provided event after currentDate.
	onFailure(e) Event handler that gets fired when the calendar data for the current
	onReady() Fired by YUI when parent element is available for scripting.
	onSuccess(o) Event handler that gets fired when the calendar data for the current
	renderDay(date, eventData) Render an event
	resolveStartDaily(ev, eventParam, currentDate, endDate) Return all days between currentDate and endDate when daily event
	resolveStartDateWeekly(ev, eventParam, currentDate, endDate) Return all days between currentDate and endDate when weekly event
	resolveStartMonthly(ev, eventParam, currentDate, endDate) Return all days between currentDate and endDate when monthly event
	setMessages(obj) Set messages for this component

Methods borrowed from class Alfresco.component.Base:: attachLinkClickListeners, bind, createYUIButtons, destroy, fire, invokeAction, msg, onComponentLoaded, onComponentsLoaded, onReadyWrapper, refresh, setOptions

Method Detail

cloneDate(date)

Clone provided date objet

Parameters:
date

getAllEvents(eventList)

Parameters:
eventList

{Date} getLastEventDay(ev, currentDate, endDate)

Return last day between currentDate and endDate when event may occur.

Parameters:
{Object} ev: object that represent monthly event
{Date} currentDate: first day when event may occur.
{Date} endDate: last day when event may occur.

Returns:: {Date} last day in current month when event may occur.

getNextEventStartDates(event, currentDate)

Return next occurrence of provided event after currentDate.

Parameters:
event
currentDate

onFailure(e)

Event handler that gets fired when the calendar data for the current
site. fails to load. Displays an alert informing the user that the
data didn't load.

Parameters:
{object} e: DomEvent

onReady()

Fired by YUI when parent element is available for scripting.
Initialises components, including YUI widgets.

onSuccess(o)

Event handler that gets fired when the calendar data for the current
site. is loaded successfully.

Parameters:
{object} o: Result of AJAX call

renderDay(date, eventData)

Render an event

Parameters:
{String} date: ISO8601 Date to render
{object} eventData: Event data

{Array} resolveStartDaily(ev, eventParam, currentDate, endDate)

Return all days between currentDate and endDate when daily event
occurs.

Parameters:
{Object} ev: object that represent daily event
{Object} eventParam: Map of event parameters taken from RRULE
{Date} currentDate: first day when event may occur.
{Date} endDate: last day when event may occur.

Returns:: {Array} Array that contains days between currentDate and endDate on which daily event occurs

{Array} resolveStartDateWeekly(ev, eventParam, currentDate, endDate)

Return all days between currentDate and endDate when weekly event
occurs.

Parameters:
{Object} ev: object that represent weekly event
{Object} eventParam: Map of event parameters taken from RRULE
{Date} currentDate: first day that event may occur.
{Date} endDate: last day that event may occur.

Returns:: {Array} Array that contains days between currentDate and endDate on which weekly event occurs

{Array} resolveStartMonthly(ev, eventParam, currentDate, endDate)

Return all days between currentDate and endDate when monthly event
occurs.

Parameters:
{Object} ev: object that represent monthly event
{Object} eventParam: Map of event parameters taken from RRULE
{Date} currentDate: first day when event may occur
{Date} endDate: last day when event may occur

Returns:: {Array} Array that contains days between currentDate and endDate on which daily event occurs

setMessages(obj)

Set messages for this component

Parameters:
{object} obj: Object literal specifying a set of messages

Classes

Class Alfresco.dashlet.MiniCalendar